io.lettuce.core.tracing

Class BraveTracing

java.lang.Object

io.lettuce.core.tracing.BraveTracing

All Implemented Interfaces:

Tracing

public class BraveTracing
extends Object
implements Tracing

Tracing integration with OpenZipkin's Brave Tracer. This implementation creates Brave Spans that are optionally associated with a TraceContext.

TraceContext Propagation

Redis commands can use a parent trace context to create a Tracer.Span to trace the actual command. A parent Span is picked up for imperative (synchronous/asynchronous) API usage from Tracing.currentTracer(). The context is not propagated across asynchronous call chains resulting from CompletionStage chaining.

Reactive API usage leverages Reactor's Context so that subscribers can register one of the following objects (using their Class as context key):

1. A TraceContextProvider
2. A Brave Span: Commands extract the TraceContext
3. A Brave TraceContext

If one of the context objects above is found, it's used to determine the parent context for the command Span.

Since:

5.1

Author:

Mark Paluch, Daniel Albuquerque

See Also:

Tracer, Tracing.currentTracer(), BraveTraceContextProvider, builder()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BraveTracing.BraveEndpoint Endpoint implementation for Zipkin's Endpoint.
static class	BraveTracing.BraveTraceContext TraceContext implementation for Brave's TraceContext.
static class	BraveTracing.Builder Builder for BraveTracing.

Nested classes/interfaces inherited from interface io.lettuce.core.tracing.Tracing

Tracing.Endpoint

Method Summary

Modifier and Type	Method and Description
static BraveTracing.Builder	builder() Create a new BraveTracing.Builder to build BraveTracing.
static BraveTracing	create(brave.Tracing tracing) Create a new BraveTracing instance.
Tracing.Endpoint	createEndpoint(SocketAddress socketAddress) Create an Tracing.Endpoint given SocketAddress.
TracerProvider	getTracerProvider()
boolean	includeCommandArgsInSpanTags() Returns true if tags for Tracer.Spans should include the command arguments.
TraceContextProvider	initialTraceContextProvider()
boolean	isEnabled() Returns true if tracing is enabled.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.lettuce.core.tracing.Tracing

clearContext, disabled, getContext, withTraceContextProvider

Method Detail

create

public static BraveTracing create(brave.Tracing tracing)

Create a new BraveTracing instance.

Parameters:

tracing - must not be null.

Returns:

the BraveTracing.

builder

public static BraveTracing.Builder builder()

Create a new BraveTracing.Builder to build BraveTracing.

Returns:

a new instance of BraveTracing.Builder.

Since:

5.2

isEnabled

public boolean isEnabled()

Description copied from interface: Tracing

Returns true if tracing is enabled.

Specified by:

isEnabled in interface Tracing

Returns:

true if tracing is enabled.

includeCommandArgsInSpanTags

public boolean includeCommandArgsInSpanTags()

Description copied from interface: Tracing

Returns true if tags for Tracer.Spans should include the command arguments.

Specified by:

includeCommandArgsInSpanTags in interface Tracing

Returns:

true if tags for Tracer.Spans should include the command arguments.

getTracerProvider

public TracerProvider getTracerProvider()

Specified by:

getTracerProvider in interface Tracing

Returns:

the TracerProvider.

initialTraceContextProvider

public TraceContextProvider initialTraceContextProvider()

Specified by:

initialTraceContextProvider in interface Tracing

Returns:

the TraceContextProvider supplying the initial TraceContext (i.e. if there is no active span).

createEndpoint

public Tracing.Endpoint createEndpoint(SocketAddress socketAddress)

Description copied from interface: Tracing

Create an Tracing.Endpoint given SocketAddress.

Specified by:

createEndpoint in interface Tracing

Parameters:

socketAddress - the remote address.

Returns:

the Tracing.Endpoint for SocketAddress.