Package io.micrometer.observation

Interface ObservationRegistry

public interface ObservationRegistry

Implementations of this interface are responsible for managing state of an Observation.

Since:

1.10.0

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static ObservationRegistry	create()	Creates an instance of ObservationRegistry.
@Nullable Observation	getCurrentObservation()	When previously set will allow to retrieve the Observation at any point in time.
@Nullable Observation.Scope	getCurrentObservationScope()	When previously set will allow to retrieve the Observation.Scope at any point in time.
default boolean	isNoop()	Checks whether this ObservationRegistry is no-op.
ObservationRegistry.ObservationConfig	observationConfig()	Configuration options for this registry.
void	setCurrentObservationScope(@Nullable Observation.Scope current)	Sets the observation scope as current.

Field Details

NOOP

static final ObservationRegistry NOOP

No-op implementation of ObservationRegistry.

Method Details

create

static ObservationRegistry create()

Creates an instance of ObservationRegistry.

Returns:

ObservationRegistry instance

getCurrentObservation

@Nullable 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:

current observation or null if it's not present

getCurrentObservationScope

@Nullable 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:

current observation scope or null if it's not present

setCurrentObservationScope

void setCurrentObservationScope(@Nullable Observation.Scope current)

Sets the observation scope as current.

Parameters:

current - observation scope

observationConfig

ObservationRegistry.ObservationConfig observationConfig()

Configuration options for this registry.

Returns:

observation configuration

isNoop

default boolean isNoop()

Checks whether this ObservationRegistry is no-op.

Returns:

true when this is a no-op observation registry