Package io.micrometer.observation

Class ObservationRegistry.ObservationConfig

java.lang.Object

io.micrometer.observation.ObservationRegistry.ObservationConfig

Enclosing interface:

ObservationRegistry

public static class ObservationRegistry.ObservationConfig
extends Object

Access to configuration options for this registry.

Constructor Summary

Constructors

Constructor	Description
ObservationConfig()

Method Summary

Modifier and Type	Method	Description
ObservationRegistry.ObservationConfig	observationConvention(GlobalObservationConvention<?> observationConvention)	Register an ObservationConvention.
ObservationRegistry.ObservationConfig	observationFilter(ObservationFilter observationFilter)	Register an observation filter for the observations.
ObservationRegistry.ObservationConfig	observationHandler(ObservationHandler<?> handler)	Register a handler for the observations.
ObservationRegistry.ObservationConfig	observationPredicate(ObservationPredicate predicate)	Register a predicate to define whether observation should be created or a NoopObservation instead.

Methods inherited from class java.lang.Object

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

Constructor Details

ObservationConfig

public ObservationConfig()

Method Details

observationHandler

public ObservationRegistry.ObservationConfig observationHandler(ObservationHandler<?> handler)

Register a handler for the observations.

Parameters:

handler - handler to add to the current configuration

Returns:

This configuration instance

observationPredicate

public ObservationRegistry.ObservationConfig observationPredicate(ObservationPredicate predicate)

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

Parameters:

predicate - predicate

Returns:

This configuration instance

observationFilter

public ObservationRegistry.ObservationConfig observationFilter(ObservationFilter observationFilter)

Register an observation filter for the observations.

Parameters:

observationFilter - an observation filter to add to the current configuration

Returns:

This configuration instance

observationConvention

public ObservationRegistry.ObservationConfig observationConvention(GlobalObservationConvention<?> observationConvention)

Register an ObservationConvention.

Please check the javadoc of Observation.createNotStarted(ObservationConvention, ObservationConvention, Supplier, ObservationRegistry) method for the logic of choosing the convention.

Parameters:

observationConvention - observation convention

Returns:

This configuration instance