Module lettuce.core

Package io.lettuce.core.tracing

Class Tracer.Span

java.lang.Object

io.lettuce.core.tracing.Tracer.Span

Enclosing class:

Tracer

public abstract static class Tracer.Span
extends Object

Used to model the latency of an operation along with tags such as name or the Tracing.Endpoint.

Constructor Summary

Constructors

Constructor	Description
Span()

Method Summary

Modifier and Type	Method	Description
abstract Tracer.Span	annotate(String value)	Associates an event that explains latency with the current system time.
abstract Tracer.Span	error(Throwable throwable)	Associate an error with this Tracer.Span.
abstract void	finish()	Reports the span complete.
abstract Tracer.Span	name(String name)	Sets the name for this Tracer.Span.
abstract Tracer.Span	remoteEndpoint(Tracing.Endpoint endpoint)	Associates an Tracing.Endpoint with this Tracer.Span.
abstract Tracer.Span	start(RedisCommand<?,?,?> command)	Starts the span with.
abstract Tracer.Span	tag(String key, String value)	Associates a tag with this Tracer.Span.

Methods inherited from class java.lang.Object

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

Constructor Details

Span

public Span()

Method Details

start

public abstract Tracer.Span start(RedisCommand<?,?,?> command)

Starts the span with.

Parameters:

command - the underlying command.

Returns:

this Tracer.Span.

name

public abstract Tracer.Span name(String name)

Sets the name for this Tracer.Span.

Parameters:

name - must not be null.

Returns:

this Tracer.Span.

annotate

public abstract Tracer.Span annotate(String value)

Associates an event that explains latency with the current system time.

Parameters:

value - A short tag indicating the event, like "finagle.retry"

tag

public abstract Tracer.Span tag(String key,
String value)

Associates a tag with this Tracer.Span.

Parameters:

key - must not be null.

value - must not be null.

Returns:

this Tracer.Span.

error

public abstract Tracer.Span error(Throwable throwable)

Associate an error with this Tracer.Span.

Parameters:

throwable - must not be null.

Returns:

this Tracer.Span.

remoteEndpoint

public abstract Tracer.Span remoteEndpoint(Tracing.Endpoint endpoint)

Associates an Tracing.Endpoint with this Tracer.Span.

Parameters:

endpoint - must not be null.

Returns:

this Tracer.Span.

finish

public abstract void finish()

Reports the span complete.