Package brave

Class CurrentSpanCustomizer

java.lang.Object

brave.CurrentSpanCustomizer

All Implemented Interfaces:

SpanCustomizer

public final class CurrentSpanCustomizer
extends Object
implements SpanCustomizer

Provides a mechanism for end users to be able to customise the current span.

Handles the case of there being no current span in scope.

Method Summary

Modifier and Type	Method	Description
SpanCustomizer	annotate(long timestamp, String value)	Like SpanCustomizer.annotate(String), except with a given timestamp in microseconds.
SpanCustomizer	annotate(String value)	Associates an event that explains latency with the current system time.
static CurrentSpanCustomizer	create(Tracing tracing)	Creates a span customizer that will affect the current span in scope if present
SpanCustomizer	name(String name)	Sets the string name for the logical operation this span represents.
SpanCustomizer	tag(String key, String value)	Tags give your span context for search, viewing and analysis.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static CurrentSpanCustomizer create(Tracing tracing)

Creates a span customizer that will affect the current span in scope if present

name

public SpanCustomizer name(String name)

Sets the string name for the logical operation this span represents.

Specified by:

name in interface SpanCustomizer

tag

public SpanCustomizer tag(String key,
                          String value)

Tags give your span context for search, viewing and analysis. For example, a key "your_app.version" would let you lookup spans by version. A tag TraceKeys.SQL_QUERY isn't searchable, but it can help in debugging when viewing a trace.

Specified by:

tag in interface SpanCustomizer

Parameters:

key - Name used to lookup spans, such as "your_app.version". See TraceKeys for standard ones.

value - String value, cannot be null.

annotate

public SpanCustomizer annotate(String value)

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

Specified by:

annotate in interface SpanCustomizer

Parameters:

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

See Also:

Constants

annotate

public SpanCustomizer annotate(long timestamp,
                               String value)

Like SpanCustomizer.annotate(String), except with a given timestamp in microseconds.

Specified by:

annotate in interface SpanCustomizer