io.micronaut.tracing.instrument.util

Class TracingPublisher<T>

java.lang.Object

io.micronaut.tracing.instrument.util.TracingPublisher<T>

Type Parameters:

T - the type of element signaled

All Implemented Interfaces:

io.micronaut.core.async.publisher.Publishers.MicronautPublisher<T>, org.reactivestreams.Publisher<T>

Direct Known Subclasses:

TracingCorePublisher

public class TracingPublisher<T>
extends java.lang.Object
implements io.micronaut.core.async.publisher.Publishers.MicronautPublisher<T>

A reactive streams publisher that traces.

Since:

1.0

Author:

graemerocher

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TracingPublisher.TracingSubscriber The tracing subscriber.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.reactivestreams.Publisher<T>	publisher

Constructor Summary

Constructors

Constructor and Description
TracingPublisher(org.reactivestreams.Publisher<T> publisher, io.opentracing.Tracer tracer) Creates a new tracing publisher for the given arguments.
TracingPublisher(org.reactivestreams.Publisher<T> publisher, io.opentracing.Tracer tracer, java.lang.String operationName) Creates a new tracing publisher for the given arguments.
TracingPublisher(org.reactivestreams.Publisher<T> publisher, io.opentracing.Tracer tracer, java.lang.String operationName, TracingObserver tracingObserver) Creates a new tracing publisher for the given arguments.
TracingPublisher(org.reactivestreams.Publisher<T> publisher, io.opentracing.Tracer tracer, io.opentracing.Tracer.SpanBuilder spanBuilder) Creates a new tracing publisher for the given arguments.
TracingPublisher(org.reactivestreams.Publisher<T> publisher, io.opentracing.Tracer tracer, io.opentracing.Tracer.SpanBuilder spanBuilder, boolean isSingle) Creates a new tracing publisher for the given arguments.
TracingPublisher(org.reactivestreams.Publisher<T> publisher, io.opentracing.Tracer tracer, io.opentracing.Tracer.SpanBuilder spanBuilder, boolean isSingle, TracingObserver tracingObserver) Creates a new tracing publisher for the given arguments.
TracingPublisher(org.reactivestreams.Publisher<T> publisher, io.opentracing.Tracer tracer, io.opentracing.Tracer.SpanBuilder spanBuilder, TracingObserver tracingObserver) Creates a new tracing publisher for the given arguments.
TracingPublisher(org.reactivestreams.Publisher<T> publisher, io.opentracing.Tracer tracer, TracingObserver tracingObserver) Creates a new tracing publisher for the given arguments.

Method Summary

Modifier and Type	Method and Description
protected void	doOnError(java.lang.Throwable throwable, io.opentracing.Span span) Designed for subclasses to override and implement custom on error behaviour.
protected void	doOnFinish(io.opentracing.Span span) Designed for subclasses to override and implement custom on finish behaviour.
protected void	doOnNext(T object, io.opentracing.Span span) Designed for subclasses to override and implement custom behaviour when an item is emitted.
protected void	doOnSubscribe(io.opentracing.Span span) Designed for subclasses to override and implement custom on subscribe behaviour.
protected void	doSubscribe(org.reactivestreams.Subscriber<? super T> actual, io.opentracing.ScopeManager scopeManager, io.opentracing.Span span, boolean finishOnClose) Do subscribe to the publisher.
protected boolean	isContinued() Designed for subclasses to override if the current active span is to be continued by this publisher.
protected boolean	isFinishOnError() Designed for subclasses to override if the span needs to be finished upon error.
void	subscribe(org.reactivestreams.Subscriber<? super T> actual)

Methods inherited from class java.lang.Object

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

Field Detail

publisher

protected final org.reactivestreams.Publisher<T> publisher

Constructor Detail

TracingPublisher

public TracingPublisher(org.reactivestreams.Publisher<T> publisher,
                        io.opentracing.Tracer tracer,
                        java.lang.String operationName)

Creates a new tracing publisher for the given arguments.

Parameters:

publisher - the target publisher

tracer - the tracer

operationName - the operation name that should be started

TracingPublisher

public TracingPublisher(org.reactivestreams.Publisher<T> publisher,
                        io.opentracing.Tracer tracer,
                        java.lang.String operationName,
                        @NonNull
                        TracingObserver tracingObserver)

Creates a new tracing publisher for the given arguments.

Parameters:

publisher - the target publisher

tracer - the tracer

operationName - the operation name that should be started

tracingObserver - the tracing observer

TracingPublisher

public TracingPublisher(org.reactivestreams.Publisher<T> publisher,
                        io.opentracing.Tracer tracer)

Creates a new tracing publisher for the given arguments. This constructor will just add tracing of the existing span if it is present.

Parameters:

publisher - the target publisher

tracer - the tracer

TracingPublisher

public TracingPublisher(org.reactivestreams.Publisher<T> publisher,
                        io.opentracing.Tracer tracer,
                        @NonNull
                        TracingObserver tracingObserver)

Creates a new tracing publisher for the given arguments. This constructor will just add tracing of the existing span if it is present.

Parameters:

publisher - the target publisher

tracer - the tracer

tracingObserver - the tracing observer

TracingPublisher

public TracingPublisher(org.reactivestreams.Publisher<T> publisher,
                        io.opentracing.Tracer tracer,
                        io.opentracing.Tracer.SpanBuilder spanBuilder)

Creates a new tracing publisher for the given arguments.

Parameters:

publisher - the target publisher

tracer - the tracer

spanBuilder - the span builder that represents the span that will be

TracingPublisher

public TracingPublisher(org.reactivestreams.Publisher<T> publisher,
                        io.opentracing.Tracer tracer,
                        io.opentracing.Tracer.SpanBuilder spanBuilder,
                        @NonNull
                        TracingObserver tracingObserver)

Creates a new tracing publisher for the given arguments.

Parameters:

publisher - the target publisher

tracer - the tracer

spanBuilder - the span builder that represents the span that will be

tracingObserver - the tracing observer

TracingPublisher

public TracingPublisher(org.reactivestreams.Publisher<T> publisher,
                        io.opentracing.Tracer tracer,
                        io.opentracing.Tracer.SpanBuilder spanBuilder,
                        boolean isSingle)

Creates a new tracing publisher for the given arguments.

Parameters:

publisher - the target publisher

tracer - the tracer

spanBuilder - the span builder that represents the span that will be created when the publisher is subscribed to

isSingle - true if the publisher emits a single item

TracingPublisher

public TracingPublisher(org.reactivestreams.Publisher<T> publisher,
                        io.opentracing.Tracer tracer,
                        io.opentracing.Tracer.SpanBuilder spanBuilder,
                        boolean isSingle,
                        @NonNull
                        TracingObserver tracingObserver)

Creates a new tracing publisher for the given arguments.

Parameters:

publisher - the target publisher

tracer - the tracer

spanBuilder - the span builder that represents the span that will be created when the publisher is subscribed to

isSingle - true if the publisher emits a single item

tracingObserver - the tracing observer

Method Detail

subscribe

public void subscribe(org.reactivestreams.Subscriber<? super T> actual)

Specified by:

subscribe in interface org.reactivestreams.Publisher<T>

doSubscribe

@Internal
protected void doSubscribe(org.reactivestreams.Subscriber<? super T> actual,
                                     io.opentracing.ScopeManager scopeManager,
                                     io.opentracing.Span span,
                                     boolean finishOnClose)

Do subscribe to the publisher.

Parameters:

actual - The actual subscriber

scopeManager - The scope manager

span - The span

finishOnClose - Should finish on close?

isContinued

protected 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:

2.0.3

isFinishOnError

protected 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:

2.0.3

doOnNext

protected 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

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

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

Parameters:

span - The span

doOnFinish

protected 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

protected 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