Enum opentelemetry_api::trace::Status

pub enum Status {
    Unset,
    Error {
        description: Cow<'static, str>,
    },
    Ok,
}

The status of a Span.

These values form a total order: Ok > Error > Unset. This means that setting Status::Ok will override any prior or future attempts to set a status with Status::Error or Status::Unset.

The status should remain unset, except for the following circumstances:

Generally, instrumentation libraries should not set the code to Status::Ok, unless explicitly configured to do so. Instrumentation libraries should leave the status code as unset unless there is an error.

Application developers and operators may set the status code to Status::Ok.

When span status is set to Status::Ok it should be considered final and any further attempts to change it should be ignored.

Analysis tools should respond to a Status::Ok status by suppressing any errors they would otherwise generate. For example, to suppress noisy errors such as 404s.

Only the value of the last call will be recorded, and implementations are free to ignore previous calls.

Variants

Unset

The default status.

Error

Fields

description: Cow<'static, str>

The description of the error

The operation contains an error.

Ok

The operation has been validated by an application developer or operator to have completed successfully.

Implementations

impl Status

pub fn error(description: impl Into<Cow<'static, str>>) -> Self

Create a new error status with a given description.

Examples

use opentelemetry_api::trace::Status;

// record error with `str` description
let error_status = Status::error("something went wrong");

// or with `String` description
let error_status = Status::error(format!("too many foos: {}", 42));

Trait Implementations

impl Clone for Status

fn clone(&self) -> Status

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Status

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Status

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Status

fn eq(&self, other: &Status) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Status

fn partial_cmp(&self, other: &Status) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Status

impl StructuralEq for Status

impl StructuralPartialEq for Status