io.lettuce.core.tracing

Interface Tracing

All Known Implementing Classes:

BraveTracing, MicrometerTracing

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 and Description
static interface	Tracing.Endpoint Value object interface to represent an endpoint.

Method Summary

Modifier and Type	Method and Description
static Function<reactor.util.context.Context,reactor.util.context.Context>	clearContext() Deprecated. since 7.8, use AbstractRedisReactiveCommands.ReactorTraceContext.clearContext() instead; scheduled for removal in Lettuce 8.0.
Tracing.Endpoint	createEndpoint(SocketAddress socketAddress) Create an Tracing.Endpoint given SocketAddress.
static Tracing	disabled() Returns a TracerProvider that is disabled.
static reactor.core.publisher.Mono<TraceContextProvider>	getContext() Deprecated. since 7.8, use AbstractRedisReactiveCommands.ReactorTraceContext.getContext() instead; scheduled for removal in Lettuce 8.0.
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 reactor.util.context.Context	withTraceContextProvider(TraceContextProvider supplier) Deprecated. since 7.8, use AbstractRedisReactiveCommands.ReactorTraceContext.withTraceContextProvider(TraceContextProvider) instead; scheduled for removal in Lettuce 8.0.

Method Detail

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

@Deprecated
static reactor.core.publisher.Mono<TraceContextProvider> getContext()

Deprecated. since 7.8, use AbstractRedisReactiveCommands.ReactorTraceContext.getContext() instead; scheduled for removal in Lettuce 8.0.

Gets the TraceContextProvider from the Reactor Context.

Returns:

a Mono emitting the TraceContextProvider held in the subscriber Context, if any.

clearContext

@Deprecated
static Function<reactor.util.context.Context,reactor.util.context.Context> clearContext()

Deprecated. since 7.8, use AbstractRedisReactiveCommands.ReactorTraceContext.clearContext() instead; scheduled for removal in Lettuce 8.0.

Returns a Function that clears the TraceContextProvider from a Reactor Context.

Returns:

a Function that removes the TraceContextProvider from a Context.

withTraceContextProvider

@Deprecated
static reactor.util.context.Context withTraceContextProvider(TraceContextProvider supplier)

Deprecated. since 7.8, use AbstractRedisReactiveCommands.ReactorTraceContext.withTraceContextProvider(TraceContextProvider) instead; scheduled for removal in Lettuce 8.0.

Creates a Reactor Context holding the given TraceContextProvider that can be merged into another Context.

Parameters:

supplier - the TraceContextProvider to place into the returned Reactor Context.

Returns:

a Reactor Context containing the TraceContextProvider.