io.opentelemetry.sdk.trace.data

Class ImmutableStatus

java.lang.Object

io.opentelemetry.sdk.trace.data.ImmutableStatus

All Implemented Interfaces:

SpanData.Status

@Immutable
public abstract class ImmutableStatus
extends Object
implements SpanData.Status

Defines the status of a Span by providing a standard StatusCanonicalCode in conjunction with an optional descriptive message. Instances of Status are created by starting with the template for the appropriate StatusCanonicalCode and supplementing it with additional information: Status.NOT_FOUND.withDescription("Could not find 'important_file.txt'");

Field Summary

Fields

Modifier and Type	Field and Description
static SpanData.Status	ERROR The operation contains an error.
static SpanData.Status	OK The operation has been validated by an Application developers or Operator to have completed successfully.
static SpanData.Status	UNSET The default status.

Constructor Summary

Constructors

Constructor and Description
ImmutableStatus()

Method Summary

Modifier and Type	Method and Description
static SpanData.Status	create(io.opentelemetry.trace.StatusCanonicalCode canonicalCode, String description) Creates a derived instance of Status with the given description.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.opentelemetry.sdk.trace.data.SpanData.Status

getCanonicalCode, getDescription, isOk, isUnset

Field Detail

OK

public static final SpanData.Status OK

The operation has been validated by an Application developers or Operator to have completed successfully.

UNSET

public static final SpanData.Status UNSET

The default status.

ERROR

public static final SpanData.Status ERROR

The operation contains an error.

Constructor Detail

ImmutableStatus

public ImmutableStatus()

Method Detail

create

public static SpanData.Status create(io.opentelemetry.trace.StatusCanonicalCode canonicalCode,
                                     @Nullable
                                     String description)

Creates a derived instance of Status with the given description.

Parameters:

description - the new description of the Status.

Returns:

The newly created Status with the given description.

Since:

0.1.0