Package com.couchbase.client.core.cnc.tracing

Class NoopRequestTracer

java.lang.Object

com.couchbase.client.core.cnc.tracing.NoopRequestTracer

All Implemented Interfaces:

RequestTracer

public class NoopRequestTracer
extends Object
implements RequestTracer

A simple NOOP implementation of the tracer, useful if tracing needs to be disabled completely.

Field Summary

Fields inherited from interface com.couchbase.client.core.cnc.RequestTracer

DISPATCH_SPAN_NAME, PAYLOAD_ENCODING_SPAN_NAME, SERVICE_IDENTIFIER_ANALYTICS, SERVICE_IDENTIFIER_KV, SERVICE_IDENTIFIER_QUERY, SERVICE_IDENTIFIER_SEARCH, SERVICE_IDENTIFIER_VIEW

Constructor Summary

Constructors

Constructor	Description
NoopRequestTracer()

Method Summary

Modifier and Type	Method	Description
InternalSpan	internalSpan(String operationName, RequestSpan parent)	Creates a new span that represents a full request/response lifecycle in the SDK.
RequestSpan	requestSpan(String operationName, RequestSpan parent)	Creates a new span that is created from the underlying tracer.
Mono<Void>	start()	Starts the tracer if it hasn't been started, might be a noop depending on the implementation.
Mono<Void>	stop(Duration timeout)	Stops the tracer if it has been started previously, might be a noop depending on the implementation.

Methods inherited from class java.lang.Object

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

Constructor Detail

NoopRequestTracer

public NoopRequestTracer()

Method Detail

internalSpan

public InternalSpan internalSpan(String operationName,
                                 RequestSpan parent)

Description copied from interface: RequestTracer

Creates a new span that represents a full request/response lifecycle in the SDK.

Specified by:

internalSpan in interface RequestTracer

Parameters:

operationName - the name of the toplevel operation (i.e. "get")

parent - the parent, can be null.

Returns:

an internal span representing the toplevel request.

start

public Mono<Void> start()

Description copied from interface: RequestTracer

Starts the tracer if it hasn't been started, might be a noop depending on the implementation.

Specified by:

start in interface RequestTracer

stop

public Mono<Void> stop(Duration timeout)

Description copied from interface: RequestTracer

Stops the tracer if it has been started previously, might be a noop depending on the implementation.

Specified by:

stop in interface RequestTracer

requestSpan

public RequestSpan requestSpan(String operationName,
                               RequestSpan parent)

Description copied from interface: RequestTracer

Creates a new span that is created from the underlying tracer.

Specified by:

requestSpan in interface RequestTracer

Parameters:

operationName - the name of the toplevel operation (i.e. "get")

parent - a possible parent.

Returns:

a request span that wraps the actual tracer implementation span.