Package io.micrometer.datadog

Class DatadogNamingConvention

java.lang.Object
io.micrometer.datadog.DatadogNamingConvention
All Implemented Interfaces:
io.micrometer.core.instrument.config.NamingConvention
public class DatadogNamingConvention extends Object implements io.micrometer.core.instrument.config.NamingConvention
NamingConvention for Datadog.

  • Field Summary

    Fields inherited from interface io.micrometer.core.instrument.config.NamingConvention

    camelCase, dot, identity, slashes, snakeCase, upperCamelCase

  • Constructor Summary

    Constructors
    Constructor
    Description
    DatadogNamingConvention()
     
    DatadogNamingConvention(io.micrometer.core.instrument.config.NamingConvention delegate)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    name(String name, io.micrometer.core.instrument.Meter.Type type, String baseUnit)
    See: https://help.datadoghq.com/hc/en-us/articles/203764705-What-are-valid-metric-names-
    String
    tagKey(String key)
    Some set of non-alphanumeric characters will be replaced with '_', but not all (e.g.
    String
    tagValue(String value)
    Some set of non-alphanumeric characters will be replaced by Datadog automatically with '_', but not all (e.g.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface io.micrometer.core.instrument.config.NamingConvention

    name

  • Constructor Details

    • DatadogNamingConvention

      public DatadogNamingConvention()

    • DatadogNamingConvention

      public DatadogNamingConvention(io.micrometer.core.instrument.config.NamingConvention delegate)

  • Method Details

    • name

      public String name(String name, io.micrometer.core.instrument.Meter.Type type, @Nullable String baseUnit)
      See: https://help.datadoghq.com/hc/en-us/articles/203764705-What-are-valid-metric-names-

      Datadog's publish API will automatically strip Unicode without replacement. It will also replace all non-alphanumeric characters with '_'.

      Specified by:
      name in interface io.micrometer.core.instrument.config.NamingConvention

    • tagKey

      public String tagKey(String key)
      Some set of non-alphanumeric characters will be replaced with '_', but not all (e.g. '/' is OK, but '{' is replaced). Tag keys that begin with a number show up as an empty string, so we prepend them with 'm.'.
      Specified by:
      tagKey in interface io.micrometer.core.instrument.config.NamingConvention

    • tagValue

      public String tagValue(String value)
      Some set of non-alphanumeric characters will be replaced by Datadog automatically with '_', but not all (e.g. '/' is OK, but '{' is replaced). It is permissible for a tag value to begin with a digit.
      Specified by:
      tagValue in interface io.micrometer.core.instrument.config.NamingConvention