Package io.micrometer.observation

Class ObservationHandler.FirstMatchingCompositeObservationHandler

java.lang.Object

io.micrometer.observation.ObservationHandler.FirstMatchingCompositeObservationHandler

All Implemented Interfaces:

ObservationHandler<Observation.Context>, ObservationHandler.CompositeObservationHandler

Enclosing interface:

ObservationHandler<T extends Observation.Context>

public static class ObservationHandler.FirstMatchingCompositeObservationHandler
extends Object
implements ObservationHandler.CompositeObservationHandler

Handler picking the first matching handler from the list.

Nested Class Summary

Nested classes/interfaces inherited from interface io.micrometer.observation.ObservationHandler

ObservationHandler.AllMatchingCompositeObservationHandler, ObservationHandler.CompositeObservationHandler, ObservationHandler.FirstMatchingCompositeObservationHandler

Constructor Summary

Constructors

Constructor	Description
FirstMatchingCompositeObservationHandler(ObservationHandler<? extends Observation.Context>... handlers)	Creates a new instance of FirstMatchingCompositeObservationHandler.
FirstMatchingCompositeObservationHandler(List<? extends ObservationHandler<? extends Observation.Context>> handlers)	Creates a new instance of FirstMatchingCompositeObservationHandler.

Method Summary

Modifier and Type	Method	Description
List<ObservationHandler<Observation.Context>>	getHandlers()	Returns the registered handlers.
void	onError(Observation.Context context)	Reacts to an error during an Observation.
void	onEvent(Observation.Event event, Observation.Context context)	Reacts to arbitrary Observation.Event.
void	onScopeClosed(Observation.Context context)	Reacts to closing of an Observation.Scope.
void	onScopeOpened(Observation.Context context)	Reacts to opening of an Observation.Scope.
void	onScopeReset(Observation.Context context)	Reacts to resetting of scopes.
void	onStart(Observation.Context context)	Reacts to starting of an Observation.
void	onStop(Observation.Context 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.

Methods inherited from class java.lang.Object

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

Constructor Details

FirstMatchingCompositeObservationHandler

@SafeVarargs
public FirstMatchingCompositeObservationHandler(ObservationHandler<? extends Observation.Context>... handlers)

Creates a new instance of FirstMatchingCompositeObservationHandler.

Parameters:

handlers - the handlers that are registered under the composite

FirstMatchingCompositeObservationHandler

public FirstMatchingCompositeObservationHandler(List<? extends ObservationHandler<? extends Observation.Context>> handlers)

Creates a new instance of FirstMatchingCompositeObservationHandler.

Parameters:

handlers - the handlers that are registered under the composite

Method Details

getHandlers

public List<ObservationHandler<Observation.Context>> getHandlers()

Description copied from interface: ObservationHandler.CompositeObservationHandler

Returns the registered handlers.

Specified by:

getHandlers in interface ObservationHandler.CompositeObservationHandler

Returns:

registered handlers

onStart

public void onStart(Observation.Context context)

Description copied from interface: ObservationHandler

Reacts to starting of an Observation.

Specified by:

onStart in interface ObservationHandler<Observation.Context>

Parameters:

context - an Observation.Context

onError

public void onError(Observation.Context context)

Description copied from interface: ObservationHandler

Reacts to an error during an Observation.

Specified by:

onError in interface ObservationHandler<Observation.Context>

Parameters:

context - an Observation.Context

onEvent

public void onEvent(Observation.Event event,
 Observation.Context context)

Description copied from interface: ObservationHandler

Reacts to arbitrary Observation.Event.

Specified by:

onEvent in interface ObservationHandler<Observation.Context>

Parameters:

event - the Observation.Event that was signaled

context - an Observation.Context

onScopeOpened

public void onScopeOpened(Observation.Context context)

Description copied from interface: ObservationHandler

Reacts to opening of an Observation.Scope.

Specified by:

onScopeOpened in interface ObservationHandler<Observation.Context>

Parameters:

context - an Observation.Context

onScopeClosed

public void onScopeClosed(Observation.Context context)

Description copied from interface: ObservationHandler

Reacts to closing of an Observation.Scope.

Specified by:

onScopeClosed in interface ObservationHandler<Observation.Context>

Parameters:

context - an Observation.Context

onScopeReset

public void onScopeReset(Observation.Context context)

Description copied from interface: ObservationHandler

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

Specified by:

onScopeReset in interface ObservationHandler<Observation.Context>

Parameters:

context - an Observation.Context

onStop

public void onStop(Observation.Context context)

Description copied from interface: ObservationHandler

Reacts to stopping of an Observation.

Specified by:

onStop in interface ObservationHandler<Observation.Context>

Parameters:

context - an Observation.Context

supportsContext

public boolean supportsContext(Observation.Context context)

Description copied from interface: ObservationHandler

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

Specified by:

supportsContext in interface ObservationHandler<Observation.Context>

Parameters:

context - an Observation.Context

Returns:

true when this handler should be used