Top Description Fields Constructors Methods
io.micrometer.observation

pack-priv final Class NoopObservationConvention

extends Object
implements ObservationConvention<Observation.Context>
Class Inheritance
All Implemented Interfaces
io.micrometer.observation.ObservationConvention, io.micrometer.observation.KeyValuesConvention
Imports
io.micrometer.common.KeyValues
No-op implementation of ObservationConvention so that we can disable the instrumentation logic.
Authors
Jonatan Ivanov, Tommy Ludwig, Marcin Grzejszczak
Since
1.10.0

Field Summary

Modifier and TypeField and Description
pack-priv static final NoopObservationConvention
INSTANCE

Instance of NoopObservationConvention.

Constructor Summary

AccessConstructor and Description
private
NoopObservationConvention()

Method Summary

Modifier and TypeMethod and Description
public String
getContextualName(Observation.Context
context
context)

Overrides default io.micrometer.observation.ObservationConvention.getContextualName.

Allows to override the contextual name for an Observation.
public KeyValues
getHighCardinalityKeyValues(Observation.Context context)

Overrides default io.micrometer.observation.ObservationConvention.getHighCardinalityKeyValues.

High cardinality key values.
public KeyValues
getLowCardinalityKeyValues(Observation.Context context)

Overrides default io.micrometer.observation.ObservationConvention.getLowCardinalityKeyValues.

Low cardinality key values.
public String
getName()

Overrides default io.micrometer.observation.ObservationConvention.getName.

Allows to override the name for an observation.
public boolean
supportsContext(Observation.Context
an Observation.Context
context)

Implements io.micrometer.observation.ObservationConvention.supportsContext.

Tells whether this observation convention should be applied for a given Observation.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

INSTANCEback to summary
pack-priv static final NoopObservationConvention INSTANCE

Instance of NoopObservationConvention.

Constructor Detail

NoopObservationConventionback to summary
private NoopObservationConvention()

Method Detail

getContextualNameback to summary
public String getContextualName(Observation.Context context)

Overrides default io.micrometer.observation.ObservationConvention.getContextualName.

Doc from io.micrometer.observation.ObservationConvention.getContextualName.

Allows to override the contextual name for an Observation. The Observation will be renamed only when an explicit context was passed - if an implicit context is used this method won't be called.

Parameters
context:Observation.Context

context

Returns:String

the new, contextual name for the observation

Annotations
@Override
getHighCardinalityKeyValuesback to summary
public KeyValues getHighCardinalityKeyValues(Observation.Context context)

Overrides default io.micrometer.observation.ObservationConvention.getHighCardinalityKeyValues.

Doc from io.micrometer.observation.ObservationConvention.getHighCardinalityKeyValues.

High cardinality key values.

Returns:KeyValues

key values

Annotations
@Override
getLowCardinalityKeyValuesback to summary
public KeyValues getLowCardinalityKeyValues(Observation.Context context)

Overrides default io.micrometer.observation.ObservationConvention.getLowCardinalityKeyValues.

Doc from io.micrometer.observation.ObservationConvention.getLowCardinalityKeyValues.

Low cardinality key values.

Returns:KeyValues

key values

Annotations
@Override
getNameback to summary
public String getName()

Overrides default io.micrometer.observation.ObservationConvention.getName.

Doc from io.micrometer.observation.ObservationConvention.getName.

Allows to override the name for an observation.

Returns:String

the new name for the observation

Annotations
@Override
supportsContextback to summary
public boolean supportsContext(Observation.Context context)

Implements io.micrometer.observation.ObservationConvention.supportsContext.

Doc from io.micrometer.observation.ObservationConvention.supportsContext.

Tells whether this observation convention should be applied for a given Observation.Context.

Parameters
context:Observation.Context

an Observation.Context

Returns:boolean

true when this observation convention should be used

Annotations
@Override