opentelemetry.trace.status

class opentelemetry.trace.status.StatusCode[source]

Bases: enum.Enum

Represents the canonical set of status codes of a finished Span.

OK = 0

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

UNSET = 1

The default status.

ERROR = 2

The operation contains an error.

class opentelemetry.trace.status.Status(status_code=<StatusCode.UNSET: 1>, description=None)[source]

Bases: object

Represents the status of a finished Span.

Parameters

  • status_code (StatusCode) – The canonical status code that describes the result status of the operation.

  • description (Optional[str]) – An optional description of the status.

property status_code

Represents the canonical status code of a finished Span.

Return type

StatusCode

property description

Status description

Return type

Optional[str]

property is_ok

Returns false if this represents an error, true otherwise.

Return type

bool

property is_unset

Returns true if unset, false otherwise.

Return type

bool