Modifier and Type	Class and Description
public static class	ObservationRegistry.ObservationConfig Access to configuration options for this registry.

Modifier and Type	Field and Description
public static final ObservationRegistry	NOOP No-op implementation of `ObservationRegistry`.

Method Summary

Modifier and Type	Method and Description
public static ObservationRegistry	Returns: `ObservationRegistry` instance create() Creates an instance of `ObservationRegistry`.
public Observation	Returns: current observation or `null` if it's not present getCurrentObservation() When previously set will allow to retrieve the `Observation` at any point in time.
public Observation.Scope	Returns: current observation scope or `null` if it's not present getCurrentObservationScope() When previously set will allow to retrieve the `Observation.`
public default boolean	Returns: `true` when this is a no-op observation registry isNoop() Checks whether this `ObservationRegistry` is no-op.
public ObservationRegistry.ObservationConfig	Returns: observation configuration observationConfig() Configuration options for this registry.
public void	setCurrentObservationScope(Observation.Scope observation scope current) Sets the observation scope as current.

Field Detail

NOOP	back to summary
public static final ObservationRegistry NOOP No-op implementation of `ObservationRegistry`.

Method Detail

create back to summary

create	back to summary
public static ObservationRegistry create() Creates an instance of `ObservationRegistry`. Returns:ObservationRegistry `ObservationRegistry` instance

public static ObservationRegistry create()

Creates an instance of ObservationRegistry.

Returns:ObservationRegistry: ObservationRegistry instance

getCurrentObservation back to summary

getCurrentObservation	back to summary
public Observation getCurrentObservation() When previously set will allow to retrieve the `Observation` at any point in time. Example: if an `Observation` was put in `Observation.Scope` then this method will return the current present `Observation` within the scope. Returns:Observation current observation or `null` if it's not present Annotations @Nullable

public Observation getCurrentObservation()

When previously set will allow to retrieve the Observation at any point in time. Example: if an Observation was put in Observation.Scope then this method will return the current present Observation within the scope.

Returns:Observation

current observation or null if it's not present

Annotations

@Nullable

getCurrentObservationScope back to summary

getCurrentObservationScope	back to summary
public Observation.Scope getCurrentObservationScope() When previously set will allow to retrieve the `Observation.Scope` at any point in time. Example: if an `Observation` was put in `Observation.Scope` then this method will return the current present `Observation.Scope`. Returns:Observation.Scope current observation scope or `null` if it's not present Annotations @Nullable

public Observation.Scope getCurrentObservationScope()

When previously set will allow to retrieve the Observation.Scope at any point in time. Example: if an Observation was put in Observation.Scope then this method will return the current present Observation.Scope.

Returns:Observation.Scope

current observation scope or null if it's not present

Annotations

@Nullable

isNoop back to summary

isNoop	back to summary
public default boolean isNoop() Checks whether this `ObservationRegistry` is no-op. Returns:boolean `true` when this is a no-op observation registry

public default boolean isNoop()

Checks whether this ObservationRegistry is no-op.

Returns:boolean: true when this is a no-op observation registry

observationConfig	back to summary
public ObservationRegistry.ObservationConfig observationConfig() Configuration options for this registry. Returns:ObservationRegistry.ObservationConfig observation configuration

observationConfig

back to summary

public ObservationRegistry.ObservationConfig observationConfig()

Configuration options for this registry.

Returns:ObservationRegistry.ObservationConfig: observation configuration

setCurrentObservationScope	back to summary
public void setCurrentObservationScope(Observation.Scope current) Sets the observation scope as current. Parameters current:Observation.Scope observation scope

setCurrentObservationScope

back to summary

public void setCurrentObservationScope(Observation.Scope current)

Sets the observation scope as current.

Parameters

current:Observation.Scope: observation scope

io.micrometer.observation back to summary

public Class ObservationRegistry.ObservationConfig

Class Inheritance

extends Object

java.lang.Object
io.micrometer.observation.ObservationRegistry.ObservationConfig

Known Direct Subclasses

io.micrometer.observation.NoopObservationConfig

Access to configuration options for this registry.

Field Summary

Modifier and Type	Field and Description
private final List<ObservationConvention<?>>	observationConventions
private final List<ObservationFilter>	observationFilters
private final List<ObservationHandler<?>>	observationHandlers
private final List<ObservationPredicate>	observationPredicates

Constructor Summary

Access	Constructor and Description
public	ObservationConfig()

Method Summary

Modifier and Type	Method and Description
pack-priv <T extends Observation.Context> ObservationConvention<T>	Returns: matching `ObservationConvention` or default when no matching found getObservationConvention(T context context, ObservationConvention<T> default convention if none found defaultConvention) Finds an `ObservationConvention` for the given `Observation.`
pack-priv Collection<ObservationConvention<?>>	getObservationConventions()
pack-priv Collection<ObservationFilter>	getObservationFilters()
pack-priv Collection<ObservationHandler<?>>	getObservationHandlers()
pack-priv boolean	Returns: `true` when observation is enabled isObservationEnabled(String observation technical name name, Observation.Context context context) Check to assert whether `Observation` should be created or `NoopObservation` instead.
public ObservationRegistry.ObservationConfig	Returns: This configuration instance observationConvention(GlobalObservationConvention<?> observation convention observationConvention) Register an `ObservationConvention`.
public ObservationRegistry.ObservationConfig	Returns: This configuration instance observationFilter(ObservationFilter an observation filter to add to the current configuration observationFilter) Register an observation filter for the `observations`.
public ObservationRegistry.ObservationConfig	Returns: This configuration instance observationHandler(ObservationHandler<?> handler to add to the current configuration handler) Register a handler for the `observations`.
public ObservationRegistry.ObservationConfig	Returns: This configuration instance observationPredicate(ObservationPredicate predicate predicate) Register a predicate to define whether `observation` should be created or a `NoopObservation` instead.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

observationConventions	back to summary
private final List<ObservationConvention<?>> observationConventions

observationFilters	back to summary
private final List<ObservationFilter> observationFilters

observationHandlers	back to summary
private final List<ObservationHandler<?>> observationHandlers

observationPredicates	back to summary
private final List<ObservationPredicate> observationPredicates

Constructor Detail

ObservationConfig	back to summary
public ObservationConfig()

Method Detail

getObservationConvention back to summary

getObservationConvention	back to summary
pack-priv <T extends Observation.Context> ObservationConvention<T> getObservationConvention(T context, ObservationConvention<T> defaultConvention) Finds an `ObservationConvention` for the given `Observation.Context`. Parameters context:T context defaultConvention:ObservationConvention<T> default convention if none found Returns:ObservationConvention<T> matching `ObservationConvention` or default when no matching found Annotations @SuppressWarnings:unchecked

pack-priv <T extends Observation.Context> ObservationConvention<T> getObservationConvention(T context, ObservationConvention<T> defaultConvention)

Finds an ObservationConvention for the given Observation.Context.

Parameters

context:T: context
defaultConvention:ObservationConvention<T>: default convention if none found

Returns:ObservationConvention<T>

matching ObservationConvention or default when no matching found

Annotations

@SuppressWarnings:unchecked

getObservationConventions	back to summary
pack-priv Collection<ObservationConvention<?>> getObservationConventions()

getObservationFilters	back to summary
pack-priv Collection<ObservationFilter> getObservationFilters()

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

isObservationEnabled back to summary

isObservationEnabled	back to summary
pack-priv boolean isObservationEnabled(String name, Observation.Context context) 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

pack-priv boolean isObservationEnabled(String name, Observation.Context context)

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

observationConvention back to summary

observationConvention	back to summary
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:GlobalObservationConvention<?> observation convention Returns:ObservationRegistry.ObservationConfig This configuration instance

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

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

Parameters

observationConvention:GlobalObservationConvention<?>: observation convention

Returns:ObservationRegistry.ObservationConfig

This configuration instance

observationFilter back to summary

observationFilter	back to summary
public ObservationRegistry.ObservationConfig observationFilter(ObservationFilter observationFilter) Register an observation filter for the `observations`. Parameters observationFilter:ObservationFilter an observation filter to add to the current configuration Returns:ObservationRegistry.ObservationConfig This configuration instance

public ObservationRegistry.ObservationConfig observationFilter(ObservationFilter observationFilter)

Parameters

observationFilter:ObservationFilter: an observation filter to add to the current configuration

Returns:ObservationRegistry.ObservationConfig

This configuration instance

observationHandler back to summary

observationHandler	back to summary
public ObservationRegistry.ObservationConfig observationHandler(ObservationHandler<?> handler) Register a handler for the `observations`. Parameters handler:ObservationHandler<?> handler to add to the current configuration Returns:ObservationRegistry.ObservationConfig This configuration instance

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

Parameters

handler:ObservationHandler<?>: handler to add to the current configuration

Returns:ObservationRegistry.ObservationConfig

This configuration instance

observationPredicate back to summary

observationPredicate	back to summary
public ObservationRegistry.ObservationConfig observationPredicate(ObservationPredicate predicate) Register a predicate to define whether `observation` should be created or a `NoopObservation` instead. Parameters predicate:ObservationPredicate predicate Returns:ObservationRegistry.ObservationConfig This configuration instance

public ObservationRegistry.ObservationConfig observationPredicate(ObservationPredicate predicate)

Parameters

predicate:ObservationPredicate: predicate

Returns:ObservationRegistry.ObservationConfig

This configuration instance

public Interface ObservationRegistry

Nested and Inner Type Summary

Field Summary

Method Summary

Field Detail

Method Detail

public Class ObservationRegistry.ObservationConfig

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail