Package 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 Description static interface
Tracing.Endpoint
Value object interface to represent an endpoint.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description static Function<Context,Context>
clearContext()
Clears theMono<TracerProvider>
from ReactorContext
.Tracing.Endpoint
createEndpoint(SocketAddress socketAddress)
Create anTracing.Endpoint
givenSocketAddress
.static Tracing
disabled()
Returns aTracerProvider
that is disabled.static Mono<TraceContextProvider>
getContext()
Gets theTraceContextProvider
from ReactorContext
.TracerProvider
getTracerProvider()
boolean
includeCommandArgsInSpanTags()
Returnstrue
if tags forTracer.Span
s should include the command arguments.TraceContextProvider
initialTraceContextProvider()
boolean
isEnabled()
Returnstrue
if tracing is enabled.static Context
withTraceContextProvider(TraceContextProvider supplier)
Creates a ReactorContext
that contains theMono<TraceContextProvider>
.
-
-
-
Method Detail
-
getTracerProvider
TracerProvider getTracerProvider()
- Returns:
- the
TracerProvider
.
-
initialTraceContextProvider
TraceContextProvider initialTraceContextProvider()
- Returns:
- the
TraceContextProvider
supplying the initialTraceContext
(i.e. if there is no active span).
-
isEnabled
boolean isEnabled()
Returnstrue
if tracing is enabled.- Returns:
true
if tracing is enabled.
-
includeCommandArgsInSpanTags
boolean includeCommandArgsInSpanTags()
Returnstrue
if tags forTracer.Span
s should include the command arguments.- Returns:
true
if tags forTracer.Span
s should include the command arguments.- Since:
- 5.2
-
createEndpoint
Tracing.Endpoint createEndpoint(SocketAddress socketAddress)
Create anTracing.Endpoint
givenSocketAddress
.- Parameters:
socketAddress
- the remote address.- Returns:
- the
Tracing.Endpoint
forSocketAddress
.
-
disabled
static Tracing disabled()
Returns aTracerProvider
that is disabled.- Returns:
- a disabled
TracerProvider
.
-
getContext
static Mono<TraceContextProvider> getContext()
Gets theTraceContextProvider
from ReactorContext
.- Returns:
- the
TraceContextProvider
.
-
clearContext
static Function<Context,Context> clearContext()
Clears theMono<TracerProvider>
from ReactorContext
.- Returns:
- Return a
Function
that clears theTraceContextProvider
context.
-
withTraceContextProvider
static Context withTraceContextProvider(TraceContextProvider supplier)
Creates a ReactorContext
that contains theMono<TraceContextProvider>
. that can be merged into anotherContext
.- Parameters:
supplier
- theTraceContextProvider
to set in the returned ReactorContext
.- Returns:
- a Reactor
Context
that contains theMono<TraceContextProvider>
.
-
-