Module brave

Package brave

Enum Span.Kind

java.lang.Object

java.lang.Enum<Span.Kind>

brave.Span.Kind

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Span.Kind>

Enclosing class:

Span

public static enum Span.Kind
extends java.lang.Enum<Span.Kind>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLIENT
CONSUMER	When present, Span.start() is the moment a consumer received a message from an origin.
PRODUCER	When present, Span.start() is the moment a producer sent a message to a destination.
SERVER

Method Summary

Modifier and Type	Method	Description
static Span.Kind	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static Span.Kind[]	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

CLIENT

public static final Span.Kind CLIENT

SERVER

public static final Span.Kind SERVER

PRODUCER

public static final Span.Kind PRODUCER

When present, Span.start() is the moment a producer sent a message to a destination. A duration between Span.start() and Span.finish() may imply batching delay. Span.remoteEndpoint(Endpoint) indicates the destination, such as a broker.

Unlike CLIENT, messaging spans never share a span ID. For example, the CONSUMER of the same message has TraceContext.parentId() set to this span's TraceContext.spanId().

CONSUMER

public static final Span.Kind CONSUMER

When present, Span.start() is the moment a consumer received a message from an origin. A duration between Span.start() and Span.finish() may imply a processing backlog. while Span.remoteEndpoint(Endpoint) indicates the origin, such as a broker.

Unlike SERVER, messaging spans never share a span ID. For example, the PRODUCER of this message is the TraceContext.parentId() of this span.

Method Detail

values

public static Span.Kind[] 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 (Span.Kind c : Span.Kind.values())
    System.out.println(c);

Returns:

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

valueOf

public static Span.Kind 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