Package io.micrometer.observation

Class ObservationTextPublisher

java.lang.Object

io.micrometer.observation.ObservationTextPublisher

All Implemented Interfaces:

ObservationHandler<Observation.Context>

public class ObservationTextPublisher
extends Object
implements ObservationHandler<Observation.Context>

An ObservationHandler that converts the context to text and publishes it to the Consumer of your choice.

Since:

1.10.0

Nested Class Summary

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

ObservationHandler.AllMatchingCompositeObservationHandler, ObservationHandler.CompositeObservationHandler, ObservationHandler.FirstMatchingCompositeObservationHandler

Constructor Summary

Constructors

Constructor	Description
ObservationTextPublisher()	Creates a publisher that sends the context as text to the given Consumer.
ObservationTextPublisher(Consumer<String> consumer)	Creates a publisher that sends the context as text to the given Consumer.
ObservationTextPublisher(Consumer<String> consumer, Predicate<Observation.Context> supportsContextPredicate)	Creates a publisher that sends the context as text to the given Consumer if the Predicate returns true.
ObservationTextPublisher(Consumer<String> consumer, Predicate<Observation.Context> supportsContextPredicate, Function<Observation.Context,String> converter)	Creates a publisher that sends the context as text to the given Consumer if the Predicate returns true.

Method Summary

Modifier and Type	Method	Description
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	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

ObservationTextPublisher

public ObservationTextPublisher()

Creates a publisher that sends the context as text to the given Consumer.

ObservationTextPublisher

public ObservationTextPublisher(Consumer<String> consumer)

Creates a publisher that sends the context as text to the given Consumer.

Parameters:

consumer - Where to publish the context as text

ObservationTextPublisher

public ObservationTextPublisher(Consumer<String> consumer,
 Predicate<Observation.Context> supportsContextPredicate)

Creates a publisher that sends the context as text to the given Consumer if the Predicate returns true.

Parameters:

consumer - Where to publish the context as text

supportsContextPredicate - Whether the publisher should support the given context

ObservationTextPublisher

public ObservationTextPublisher(Consumer<String> consumer,
 Predicate<Observation.Context> supportsContextPredicate,
 Function<Observation.Context,String> converter)

Creates a publisher that sends the context as text to the given Consumer if the Predicate returns true.

Parameters:

consumer - Where to publish the context as text

supportsContextPredicate - Whether the publisher should support the given context

converter - Converts the Observation.Context to a String

Method Details

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

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