Package io.opentelemetry.api.trace

Enum SpanKind

java.lang.Object

java.lang.Enum<SpanKind>

io.opentelemetry.api.trace.SpanKind

All Implemented Interfaces:

Serializable, Comparable<SpanKind>, java.lang.constant.Constable

public enum SpanKind
extends Enum<SpanKind>

Type of Span. Can be used to specify additional relationships between spans in addition to a parent/child relationship.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLIENT	Indicates that the span covers the client-side wrapper around an RPC or other remote request.
CONSUMER	Indicates that the span describes consumer receiving a message from a broker.
INTERNAL	Default value.
PRODUCER	Indicates that the span describes producer sending a message to a broker.
SERVER	Indicates that the span covers server-side handling of an RPC or other remote request.

Method Summary

Modifier and Type	Method	Description
static SpanKind	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SpanKind[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INTERNAL

public static final SpanKind INTERNAL

Default value. Indicates that the span is used internally.

SERVER

public static final SpanKind SERVER

Indicates that the span covers server-side handling of an RPC or other remote request.

CLIENT

public static final SpanKind CLIENT

Indicates that the span covers the client-side wrapper around an RPC or other remote request.

PRODUCER

public static final SpanKind PRODUCER

Indicates that the span describes producer sending a message to a broker. Unlike client and server, there is no direct critical path latency relationship between producer and consumer spans.

CONSUMER

public static final SpanKind CONSUMER

Indicates that the span describes consumer receiving a message from a broker. Unlike client and server, there is no direct critical path latency relationship between producer and consumer spans.

Method Details

values

public static SpanKind[] values()

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

Returns:

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

valueOf

public static SpanKind valueOf(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:

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

NullPointerException - if the argument is null