Top Description Fields Constructors Methods
io.micrometer.tracing.handler

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

extends Object
implements TracingObservationHandler<T extends ReceiverContext<C>>
Class Inheritance
All Implemented Interfaces
io.micrometer.tracing.handler.TracingObservationHandler, io.micrometer.observation.ObservationHandler
Annotations
@SuppressWarnings:rawtypes, unchecked
Imports
io.micrometer.common.util.internal.logging.InternalLogger, .InternalLoggerFactory, io.micrometer.observation.Observation, io.micrometer.observation.transport.ReceiverContext, io.micrometer.tracing.Span, .Tracer, io.micrometer.tracing.propagation.Propagator, java.net.URI
A TracingObservationHandler called when receiving occurred - e.g. of messages or http requests.
Author
Marcin Grzejszczak
Since
1.0.0

Field Summary

Modifier and TypeField and Description
private static final InternalLogger
log

private final Propagator
propagator

private final Tracer
tracer

Constructor Summary

AccessConstructor and Description
public
PropagatingReceiverTracingObservationHandler(Tracer
the tracer to use to record events
tracer, Propagator
the mechanism to propagate tracing information from the carrier
propagator)

Creates a new instance of PropagatingReceiverTracingObservationHandler.

Method Summary

Modifier and TypeMethod and Description
public Span.Builder

Returns:

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

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

public void
customizeReceiverSpan(T
context
context, Span
span to customize
span)

Allows to customize the receiver span before reporting it.

public Tracer
getTracer()

Implements io.micrometer.tracing.handler.TracingObservationHandler.getTracer.

Returns the Tracer.
public void
onError(T
an Observation.Context
context)

Overrides default io.micrometer.tracing.handler.TracingObservationHandler.onError.

Reacts to an error during an Observation.
public void
onStart(T
an Observation.Context
context)

Overrides default io.micrometer.observation.ObservationHandler.onStart.

Reacts to starting of an Observation.
public void
onStop(T
an Observation.Context
context)

Overrides default io.micrometer.observation.ObservationHandler.onStop.

Reacts to stopping of an Observation.
public boolean
supportsContext(Observation.Context
an Observation.Context
context)

Overrides default io.micrometer.tracing.handler.TracingObservationHandler.supportsContext.

Tells the registry whether this handler should be applied for a given Observation.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

logback to summary
private static final InternalLogger log
propagatorback to summary
private final Propagator propagator
tracerback to summary
private final Tracer tracer

Constructor Detail

PropagatingReceiverTracingObservationHandlerback to summary
public PropagatingReceiverTracingObservationHandler(Tracer tracer, Propagator propagator)

Creates a new instance of PropagatingReceiverTracingObservationHandler.

Parameters
tracer:Tracer

the tracer to use to record events

propagator:Propagator

the mechanism to propagate tracing information from the carrier

Method Detail

customizeExtractedSpanback to summary
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:T

context

builder:Span.Builder

span builder

Returns:Span.Builder

span builder

customizeReceiverSpanback to summary
public void customizeReceiverSpan(T context, Span span)

Allows to customize the receiver span before reporting it.

Parameters
context:T

context

span:Span

span to customize

getTracerback to summary
public Tracer getTracer()

Implements io.micrometer.tracing.handler.TracingObservationHandler.getTracer.

Doc from io.micrometer.tracing.handler.TracingObservationHandler.getTracer.

Returns the Tracer.

Returns:Tracer

tracer

Annotations
@Override
onErrorback to summary
public void onError(T context)

Overrides default io.micrometer.tracing.handler.TracingObservationHandler.onError.

Doc from io.micrometer.observation.ObservationHandler.onError.

Reacts to an error during an Observation.

Parameters
context:T

an Observation.Context

Annotations
@Override
onStartback to summary
public void onStart(T context)

Overrides default io.micrometer.observation.ObservationHandler.onStart.

Doc from io.micrometer.observation.ObservationHandler.onStart.

Reacts to starting of an Observation.

Parameters
context:T

an Observation.Context

Annotations
@Override
onStopback to summary
public void onStop(T context)

Overrides default io.micrometer.observation.ObservationHandler.onStop.

Doc from io.micrometer.observation.ObservationHandler.onStop.

Reacts to stopping of an Observation.

Parameters
context:T

an Observation.Context

Annotations
@Override
supportsContextback to summary
public boolean supportsContext(Observation.Context context)

Overrides default io.micrometer.tracing.handler.TracingObservationHandler.supportsContext.

Doc from io.micrometer.observation.ObservationHandler.supportsContext.

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

Parameters
context:Observation.Context

an Observation.Context

Returns:boolean

true when this handler should be used

Annotations
@Override