Module brave

Package brave

Enum NoopSpanCustomizer

java.lang.Object

java.lang.Enum<NoopSpanCustomizer>

brave.NoopSpanCustomizer

All Implemented Interfaces:

SpanCustomizer, java.io.Serializable, java.lang.Comparable<NoopSpanCustomizer>

public enum NoopSpanCustomizer
extends java.lang.Enum<NoopSpanCustomizer>
implements SpanCustomizer

Performs no operations as the span represented by this is not sampled to report to the tracing system.

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE

Method Summary

Modifier and Type	Method	Description
SpanCustomizer	annotate(java.lang.String value)	Associates an event that explains latency with the current system time.
SpanCustomizer	name(java.lang.String name)	Sets the string name for the logical operation this span represents.
SpanCustomizer	tag(java.lang.String key, java.lang.String value)	Tags give your span context for search, viewing and analysis.
static NoopSpanCustomizer	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static NoopSpanCustomizer[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final NoopSpanCustomizer INSTANCE

Method Detail

values

public static NoopSpanCustomizer[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NoopSpanCustomizer c : NoopSpanCustomizer.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NoopSpanCustomizer valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

name

public SpanCustomizer name(java.lang.String name)

Description copied from interface: SpanCustomizer

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

Specified by:

name in interface SpanCustomizer

tag

public SpanCustomizer tag(java.lang.String key,
                          java.lang.String value)

Description copied from interface: SpanCustomizer

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 "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".

value - String value, cannot be null.

annotate

public SpanCustomizer annotate(java.lang.String value)

Description copied from interface: SpanCustomizer

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"