Package io.micrometer.tracing.handler

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

  • 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