Module lettuce.core

Package io.lettuce.core.tracing

Interface Tracing

All Known Implementing Classes:

BraveTracing

public interface Tracing

Interface declaring methods to trace Redis commands. This interface contains declarations of basic required interfaces and value objects to represent traces, spans and metadata in an dependency-agnostic manner.

Since:

5.1

Author:

Mark Paluch, Daniel Albuquerque

See Also:

TracerProvider, TraceContextProvider

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Tracing.Endpoint	Value object interface to represent an endpoint.

Method Summary

Modifier and Type	Method	Description
static Function<Context,Context>	clearContext()	Clears the Mono<TracerProvider> from Reactor Context.
Tracing.Endpoint	createEndpoint(SocketAddress socketAddress)	Create an Tracing.Endpoint given SocketAddress.
static Tracing	disabled()	Returns a TracerProvider that is disabled.
static Mono<TraceContextProvider>	getContext()	Gets the TraceContextProvider from Reactor Context.
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.
static Context	withTraceContextProvider(TraceContextProvider supplier)	Creates a Reactor Context that contains the Mono<TraceContextProvider>.

Method Details

getTracerProvider

TracerProvider getTracerProvider()

Returns:

the TracerProvider.

initialTraceContextProvider

TraceContextProvider initialTraceContextProvider()

Returns:

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

isEnabled

boolean isEnabled()

Returns true if tracing is enabled.

Returns:

true if tracing is enabled.

includeCommandArgsInSpanTags

boolean includeCommandArgsInSpanTags()

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

Returns:

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

Since:

5.2

createEndpoint

Tracing.Endpoint createEndpoint(SocketAddress socketAddress)

Create an Tracing.Endpoint given SocketAddress.

Parameters:

socketAddress - the remote address.

Returns:

the Tracing.Endpoint for SocketAddress.

disabled

static Tracing disabled()

Returns a TracerProvider that is disabled.

Returns:

a disabled TracerProvider.

getContext

static Mono<TraceContextProvider> getContext()

Gets the TraceContextProvider from Reactor Context.

Returns:

the TraceContextProvider.

clearContext

static Function<Context,Context> clearContext()

Clears the Mono<TracerProvider> from Reactor Context.

Returns:

Return a Function that clears the TraceContextProvider context.

withTraceContextProvider

static Context withTraceContextProvider(TraceContextProvider supplier)

Creates a Reactor Context that contains the Mono<TraceContextProvider>. that can be merged into another Context.

Parameters:

supplier - the TraceContextProvider to set in the returned Reactor Context.

Returns:

a Reactor Context that contains the Mono<TraceContextProvider>.