Interface ObservationHandler<T extends Observation.Context>

Type Parameters:

T - type of context

All Known Subinterfaces:

ObservationHandler.CompositeObservationHandler

All Known Implementing Classes:

ObservationHandler.AllMatchingCompositeObservationHandler, ObservationHandler.FirstMatchingCompositeObservationHandler, ObservationTextPublisher

public interface ObservationHandler<T extends Observation.Context>

Handler for an Observation. Hooks in to the lifecycle of an observation. Example of handler implementations can create metrics, spans or logs.

Since:

1.10.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ObservationHandler.AllMatchingCompositeObservationHandler	Handler picking all matching handlers from the list.
static interface	ObservationHandler.CompositeObservationHandler	Handler wrapping other handlers.
static class	ObservationHandler.FirstMatchingCompositeObservationHandler	Handler picking the first matching handler from the list.

Method Summary

Modifier and Type	Method	Description
default void	onError(T context)	Reacts to an error during an Observation.
default void	onEvent(Observation.Event event, T context)	Reacts to arbitrary Observation.Event.
default void	onScopeClosed(T context)	Reacts to closing of an Observation.Scope.
default void	onScopeOpened(T context)	Reacts to opening of an Observation.Scope.
default void	onScopeReset(T context)	Deprecated. Only invoked when Observation.Scope.reset() or Observation.Scope.makeCurrent() is used; both are deprecated and no longer used by Micrometer code.
default void	onStart(T context)	Reacts to starting of an Observation.
default void	onStop(T context)	Reacts to stopping of an Observation.
boolean	supportsContext(Observation.Context context)	Tells the registry whether this handler should be applied for a given Observation.Context.

Method Details

onStart

default void onStart(T context)

Reacts to starting of an Observation.

Parameters:

context - an Observation.Context

onError

default void onError(T context)

Reacts to an error during an Observation.

Parameters:

context - an Observation.Context

onEvent

default void onEvent(Observation.Event event,
 T context)

Reacts to arbitrary Observation.Event.

Parameters:

event - the Observation.Event that was signaled

context - an Observation.Context

onScopeOpened

default void onScopeOpened(T context)

Reacts to opening of an Observation.Scope.

Parameters:

context - an Observation.Context

onScopeClosed

default void onScopeClosed(T context)

Reacts to closing of an Observation.Scope.

Parameters:

context - an Observation.Context

onScopeReset

@Deprecated
default void onScopeReset(T context)

Deprecated.

Only invoked when Observation.Scope.reset() or Observation.Scope.makeCurrent() is used; both are deprecated and no longer used by Micrometer code. Prefer onScopeClosed(T) for cleanup when a scope is closed. This method will be removed in a future release.

Reacts to resetting of scopes. If your handler uses a ThreadLocal value, this method should clear that ThreadLocal or any other scoped variable.

Parameters:

context - an Observation.Context

Since:

1.10.4

onStop

default void onStop(T context)

Reacts to stopping of an Observation.

Parameters:

context - an Observation.Context

supportsContext

boolean supportsContext(Observation.Context context)

Tells the registry whether this handler should be applied for a given Observation.Context.

Parameters:

context - an Observation.Context

Returns:

true when this handler should be used