opentelemetry.trace.status

class opentelemetry.trace.status.StatusCode(value)[source]

Bases: Enum

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

UNSET = 0

The default status.

OK = 1

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

ERROR = 2

The operation contains an error.

class opentelemetry.trace.status.Status(status_code=StatusCode.UNSET, 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: StatusCode

Represents the canonical status code of a finished Span.

property description: str | None

Status description

property is_ok: bool

Returns false if this represents an error, true otherwise.

property is_unset: bool

Returns true if unset, false otherwise.