Package io.micrometer.tracing.handler
Interface TracingObservationHandler<T extends io.micrometer.observation.Observation.Context>
- Type Parameters:
T
- type of handler context
- All Superinterfaces:
io.micrometer.observation.ObservationHandler<T>
- All Known Implementing Classes:
DefaultTracingObservationHandler
,PropagatingReceiverTracingObservationHandler
,PropagatingSenderTracingObservationHandler
public interface TracingObservationHandler<T extends io.micrometer.observation.Observation.Context>
extends io.micrometer.observation.ObservationHandler<T>
Marker interface for tracing handlers.
- Since:
- 1.0.0
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic class
Basic tracing context.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
-
Method Summary
Modifier and TypeMethodDescriptiondefault Span
getParentSpan
(io.micrometer.observation.Observation.ContextView context) Get the current span from parent if applicable.default Span
getRequiredSpan
(T context) Returns the span from the context or throws an exception if it's not there.default String
getSpanName
(T context) Get the span name.Returns theTracer
.getTracingContext
(T context) Get the current tracing context and updates the context if it's missing.default void
default void
default void
onScopeClosed
(T context) Cleans the scope present in the context.default void
onScopeOpened
(T context) Puts the span in scope.default void
onScopeReset
(T context) default boolean
supportsContext
(io.micrometer.observation.Observation.Context context) default void
Tags the span.Methods inherited from interface io.micrometer.observation.ObservationHandler
onStart, onStop
-
Method Details
-
tagSpan
Tags the span.- Parameters:
context
- handler contextspan
- span to tag
-
getSpanName
Get the span name.- Parameters:
context
- handler context- Returns:
- name for the span
-
onScopeOpened
Puts the span in scope.- Specified by:
onScopeOpened
in interfaceio.micrometer.observation.ObservationHandler<T extends io.micrometer.observation.Observation.Context>
- Parameters:
context
- recording with context containing scope
-
onScopeReset
- Specified by:
onScopeReset
in interfaceio.micrometer.observation.ObservationHandler<T extends io.micrometer.observation.Observation.Context>
-
onEvent
- Specified by:
onEvent
in interfaceio.micrometer.observation.ObservationHandler<T extends io.micrometer.observation.Observation.Context>
-
onError
- Specified by:
onError
in interfaceio.micrometer.observation.ObservationHandler<T extends io.micrometer.observation.Observation.Context>
-
onScopeClosed
Cleans the scope present in the context.- Specified by:
onScopeClosed
in interfaceio.micrometer.observation.ObservationHandler<T extends io.micrometer.observation.Observation.Context>
- Parameters:
context
- recording with context containing scope
-
getParentSpan
Get the current span from parent if applicable.- Parameters:
context
- aObservation.ContextView
- Returns:
- parent span or
null
when there's none
-
getTracingContext
Get the current tracing context and updates the context if it's missing.- Parameters:
context
- aObservation.Context
- Returns:
- tracing context
-
supportsContext
default boolean supportsContext(io.micrometer.observation.Observation.Context context) - Specified by:
supportsContext
in interfaceio.micrometer.observation.ObservationHandler<T extends io.micrometer.observation.Observation.Context>
-
getRequiredSpan
Returns the span from the context or throws an exception if it's not there.- Parameters:
context
- context- Returns:
- span or exception
-
getTracer
Tracer getTracer()Returns theTracer
.- Returns:
- tracer
-