io.micronaut.tracing.instrument.util

Interface TracingObserver<T>

Type Parameters:

T - The publisher's type

public interface TracingObserver<T>

The tracing observer.

Author:

Denis Stepanov

Field Summary

Fields

Modifier and Type	Field and Description
static TracingObserver<?>	NO_OP No op observer.

Method Summary

Modifier and Type	Method and Description
default void	doOnError(java.lang.Throwable throwable, io.opentracing.Span span) Designed for subclasses to override and implement custom on error behaviour.
default void	doOnFinish(io.opentracing.Span span) Designed for subclasses to override and implement custom on finish behaviour.
default void	doOnNext(T object, io.opentracing.Span span) Designed for subclasses to override and implement custom behaviour when an item is emitted.
default void	doOnSubscribe(io.opentracing.Span span) Designed for subclasses to override and implement custom on subscribe behaviour.
default boolean	isContinued() Designed for subclasses to override if the current active span is to be continued by this publisher.
default boolean	isFinishOnError() Designed for subclasses to override if the span needs to be finished upon error.

Field Detail

NO_OP

static final TracingObserver<?> NO_OP

No op observer.

Method Detail

isContinued

default boolean isContinued()

Designed for subclasses to override if the current active span is to be continued by this publisher. False by default. This only has effects if no spanBuilder was defined.

Returns:

true, if the current span should be continued by this publisher

Since:

4.0.2

isFinishOnError

default boolean isFinishOnError()

Designed for subclasses to override if the span needs to be finished upon error. True by default.

Returns:

true, if the active span needs to be finished on error

Since:

4.0.2

doOnNext

default void doOnNext(@NonNull
                      T object,
                      @NonNull
                      io.opentracing.Span span)

Designed for subclasses to override and implement custom behaviour when an item is emitted.

Parameters:

object - The object

span - The span

doOnSubscribe

default void doOnSubscribe(@NonNull
                           io.opentracing.Span span)

Designed for subclasses to override and implement custom on subscribe behaviour.

Parameters:

span - The span

doOnFinish

default void doOnFinish(@NonNull
                        io.opentracing.Span span)

Designed for subclasses to override and implement custom on finish behaviour. Fired prior to calling Span.finish().

Parameters:

span - The span

doOnError

default void doOnError(@NonNull
                       java.lang.Throwable throwable,
                       @NonNull
                       io.opentracing.Span span)

Designed for subclasses to override and implement custom on error behaviour.

Parameters:

throwable - The error

span - The span