Top Description Fields Constructors Methods
io.micrometer.observation

pack-priv final Class NoopObservationConfig

extends ObservationConfig
Class Inheritance
Imports
java.util.Collection, .Collections
No-op implementation of ObservationRegistry.ObservationConfig 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 NoopObservationConfig
INSTANCE

Instance of NoopObservationConfig.

Constructor Summary

AccessConstructor and Description
private
NoopObservationConfig()

Method Summary

Modifier and TypeMethod and Description
pack-priv Collection<ObservationHandler<?>>
getObservationHandlers()

Overrides io.micrometer.observation.ObservationRegistry.ObservationConfig.getObservationHandlers.

public boolean
isObservationEnabled(String
observation technical name
name, Observation.Context
context
context)

Overrides io.micrometer.observation.ObservationRegistry.ObservationConfig.isObservationEnabled.

Check to assert whether Observation should be created or NoopObservation instead.
public ObservationRegistry.ObservationConfig
observationHandler(ObservationHandler<?>
handler to add to the current configuration
handler)

Overrides io.micrometer.observation.ObservationRegistry.ObservationConfig.observationHandler.

Register a handler for the observations.
public ObservationRegistry.ObservationConfig
observationPredicate(ObservationPredicate
predicate
predicate)

Overrides io.micrometer.observation.ObservationRegistry.ObservationConfig.observationPredicate.

Register a predicate to define whether observation should be created or a NoopObservation instead.
Inherited from io.micrometer.observation.ObservationRegistry.ObservationConfig:
getObservationConventiongetObservationConventionsgetObservationFiltersobservationConventionobservationFilter

Field Detail

INSTANCEback to summary
pack-priv static final NoopObservationConfig INSTANCE

Instance of NoopObservationConfig.

Constructor Detail

NoopObservationConfigback to summary
private NoopObservationConfig()

Method Detail

getObservationHandlersback to summary
pack-priv Collection<ObservationHandler<?>> getObservationHandlers()

Overrides io.micrometer.observation.ObservationRegistry.ObservationConfig.getObservationHandlers.

Annotations
@Override
isObservationEnabledback to summary
public boolean isObservationEnabled(String name, Observation.Context context)

Overrides io.micrometer.observation.ObservationRegistry.ObservationConfig.isObservationEnabled.

Doc from io.micrometer.observation.ObservationRegistry.ObservationConfig.isObservationEnabled.

Check to assert whether Observation should be created or NoopObservation instead.

Parameters
name:String

observation technical name

context:Observation.Context

context

Returns:boolean

true when observation is enabled

Annotations
@Override
observationHandlerback to summary
public ObservationRegistry.ObservationConfig observationHandler(ObservationHandler<?> handler)

Overrides io.micrometer.observation.ObservationRegistry.ObservationConfig.observationHandler.

Doc from io.micrometer.observation.ObservationRegistry.ObservationConfig.observationHandler.

Register a handler for the observations.

Parameters
handler:ObservationHandler<?>

handler to add to the current configuration

Returns:ObservationRegistry.ObservationConfig

This configuration instance

Annotations
@Override
observationPredicateback to summary
public ObservationRegistry.ObservationConfig observationPredicate(ObservationPredicate predicate)

Overrides io.micrometer.observation.ObservationRegistry.ObservationConfig.observationPredicate.

Doc from io.micrometer.observation.ObservationRegistry.ObservationConfig.observationPredicate.

Register a predicate to define whether observation should be created or a NoopObservation instead.

Parameters
predicate:ObservationPredicate

predicate

Returns:ObservationRegistry.ObservationConfig

This configuration instance

Annotations
@Override