| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970 |
- # Copyright The OpenTelemetry Authors
- # SPDX-License-Identifier: Apache-2.0
- import enum
- import logging
- logger = logging.getLogger(__name__)
- class StatusCode(enum.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 Status:
- """Represents the status of a finished Span.
- Args:
- status_code: The canonical status code that describes the result
- status of the operation.
- description: An optional description of the status.
- """
- def __init__(
- self,
- status_code: StatusCode = StatusCode.UNSET,
- description: str | None = None,
- ):
- self._status_code = status_code
- self._description = None
- if description:
- if not isinstance(description, str):
- logger.warning("Invalid status description type, expected str")
- return
- if status_code is not StatusCode.ERROR:
- logger.warning(
- "description should only be set when status_code is set to StatusCode.ERROR"
- )
- return
- self._description = description
- @property
- def status_code(self) -> StatusCode:
- """Represents the canonical status code of a finished Span."""
- return self._status_code
- @property
- def description(self) -> str | None:
- """Status description"""
- return self._description
- @property
- def is_ok(self) -> bool:
- """Returns false if this represents an error, true otherwise."""
- return self.is_unset or self._status_code is StatusCode.OK
- @property
- def is_unset(self) -> bool:
- """Returns true if unset, false otherwise."""
- return self._status_code is StatusCode.UNSET
|
