Class PropagatingReceiverTracingObservationHandler<T extends io.micrometer.observation.transport.ReceiverContext>

java.lang.Object

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

All Implemented Interfaces:

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

public class PropagatingReceiverTracingObservationHandler<T extends io.micrometer.observation.transport.ReceiverContext>
extends Object
implements TracingObservationHandler<T>

A TracingObservationHandler called when receiving 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 TracingObservationHandler

TracingObservationHandler.TracingContext

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Span.Builder	customizeExtractedSpan(T context, Span.Builder builder)	Customizes the extracted span (e.g.
void	customizeReceiverSpan(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 Object

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

Methods inherited from interface TracingObservationHandler

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

Constructor Details

PropagatingReceiverTracingObservationHandler

public PropagatingReceiverTracingObservationHandler(Tracer tracer,
 Propagator propagator)

Creates a new instance of PropagatingReceiverTracingObservationHandler.

Parameters:

tracer - the tracer to use to record events

propagator - the mechanism to propagate tracing information from 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.ReceiverContext>

customizeExtractedSpan

public Span.Builder customizeExtractedSpan(T context,
 Span.Builder builder)

Customizes the extracted span (e.g. you can set the Span.Kind via Span.Builder.kind(Span.Kind)).

Parameters:

context - context

builder - span builder

Returns:

span builder

onError

public void onError(T context)

Specified by:

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

Specified by:

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

onStop

public void onStop(T context)

Specified by:

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

customizeReceiverSpan

public void customizeReceiverSpan(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.ReceiverContext>

Specified by:

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

getTracer

public Tracer getTracer()

Description copied from interface: TracingObservationHandler

Returns the Tracer.

Specified by:

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

Returns:

tracer