Package io.micrometer.tracing.handler

Class PropagatingSenderTracingObservationHandler<T extends io.micrometer.observation.transport.SenderContext>

java.lang.Object

io.micrometer.tracing.handler.PropagatingSenderTracingObservationHandler<T>

All Implemented Interfaces:

io.micrometer.observation.ObservationHandler<T>, TracingObservationHandler<T>

public class PropagatingSenderTracingObservationHandler<T extends io.micrometer.observation.transport.SenderContext>
extends Object
implements TracingObservationHandler<T>

A TracingObservationHandler called when sending occurred - e.g. of messages or http requests.

Since:

1.0.0

Nested Class Summary

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

io.micrometer.observation.ObservationHandler.AllMatchingCompositeObservationHandler, io.micrometer.observation.ObservationHandler.CompositeObservationHandler, io.micrometer.observation.ObservationHandler.FirstMatchingCompositeObservationHandler

Nested classes/interfaces inherited from interface io.micrometer.tracing.handler.TracingObservationHandler

TracingObservationHandler.TracingContext

Constructor Summary

Constructors

Constructor	Description
PropagatingSenderTracingObservationHandler(Tracer tracer, Propagator propagator)	Creates a new instance of PropagatingSenderTracingObservationHandler.

Method Summary

Modifier and Type	Method	Description
Span	createSenderSpan(T context)	Method to be used to create a sender span.
void	customizeSenderSpan(T context, Span span)	Allows to customize the receiver span before reporting it.
Tracer	getTracer()	Returns the Tracer.
void	onError(T context)
void	onStart(T context)
void	onStop(T context)
boolean	supportsContext(io.micrometer.observation.Observation.Context context)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micrometer.tracing.handler.TracingObservationHandler

endSpan, getParentSpan, getRequiredSpan, getSpanName, getTracingContext, onEvent, onScopeClosed, onScopeOpened, onScopeReset, setMaybeScopeOnTracingContext, tagSpan

Constructor Details

PropagatingSenderTracingObservationHandler

public PropagatingSenderTracingObservationHandler(Tracer tracer,
 Propagator propagator)

Creates a new instance of PropagatingSenderTracingObservationHandler.

Parameters:

tracer - the tracer to use to record events

propagator - the mechanism to propagate tracing information into the carrier

Method Details

onStart

public void onStart(T context)

Specified by:

onStart in interface io.micrometer.observation.ObservationHandler<T extends io.micrometer.observation.transport.SenderContext>

createSenderSpan

public Span createSenderSpan(T context)

Method to be used to create a sender span.

Parameters:

context - context

Returns:

sender span

onError

public void onError(T context)

Specified by:

onError in interface io.micrometer.observation.ObservationHandler<T extends io.micrometer.observation.transport.SenderContext>

Specified by:

onError in interface TracingObservationHandler<T extends io.micrometer.observation.transport.SenderContext>

onStop

public void onStop(T context)

Specified by:

onStop in interface io.micrometer.observation.ObservationHandler<T extends io.micrometer.observation.transport.SenderContext>

customizeSenderSpan

public void customizeSenderSpan(T context,
 Span span)

Allows to customize the receiver span before reporting it.

Parameters:

context - context

span - span to customize

supportsContext

public boolean supportsContext(io.micrometer.observation.Observation.Context context)

Specified by:

supportsContext in interface io.micrometer.observation.ObservationHandler<T extends io.micrometer.observation.transport.SenderContext>

Specified by:

supportsContext in interface TracingObservationHandler<T extends io.micrometer.observation.transport.SenderContext>

getTracer

public Tracer getTracer()

Description copied from interface: TracingObservationHandler

Returns the Tracer.

Specified by:

getTracer in interface TracingObservationHandler<T extends io.micrometer.observation.transport.SenderContext>

Returns:

tracer