Package io.micrometer.core.instrument.config

Interface NamingConvention

public interface NamingConvention

Monitoring systems make different recommendations regarding naming convention.

Also, many systems have constraints on valid characters that may appear in a tag key/value or metric name. While it is recommended to choose tag keys/values that are absent special characters that are invalid on any common metrics backend, sometimes this is hard to avoid (as in the format of the URI template for parameterized URIs like /api/person/{id} emanating from Spring Web).

Field Summary

Fields

Modifier and Type	Field	Description
static NamingConvention	camelCase
static NamingConvention	dot	This maps to identity because we suggest using dot notation everywhere in Micrometer-instrumented code
static NamingConvention	identity
static NamingConvention	slashes
static NamingConvention	snakeCase
static NamingConvention	upperCamelCase

Method Summary

Modifier and Type	Method	Description
default java.lang.String	name(java.lang.String name, Meter.Type type)
java.lang.String	name(java.lang.String name, Meter.Type type, java.lang.String baseUnit)
default java.lang.String	tagKey(java.lang.String key)
default java.lang.String	tagValue(java.lang.String value)

Field Details

identity

static final NamingConvention identity

dot

static final NamingConvention dot

This maps to identity because we suggest using dot notation everywhere in Micrometer-instrumented code

snakeCase

static final NamingConvention snakeCase

camelCase

static final NamingConvention camelCase

upperCamelCase

static final NamingConvention upperCamelCase

slashes

static final NamingConvention slashes

Since:

1.1.0

Method Details

name

default java.lang.String name(java.lang.String name,
Meter.Type type)

name

java.lang.String name(java.lang.String name,
Meter.Type type,
@Nullable
java.lang.String baseUnit)

tagKey

default java.lang.String tagKey(java.lang.String key)

tagValue

default java.lang.String tagValue(java.lang.String value)