Enum MetricValue

#[non_exhaustive]
pub enum MetricValue {
    OperationBytes(u64),
    OperationBytesRate(f64),
    OperationEntries(u64),
    OperationEntriesRate(f64),
    OperationDurationSeconds(Duration),
    OperationErrorsTotal,
    OperationExecuting(isize),
    OperationTtfbSeconds(Duration),
    HttpExecuting(isize),
    HttpRequestBytes(u64),
    HttpRequestBytesRate(f64),
    HttpRequestDurationSeconds(Duration),
    HttpResponseBytes(u64),
    HttpResponseBytesRate(f64),
    HttpResponseDurationSeconds(Duration),
    HttpConnectionErrorsTotal,
    HttpStatusErrorsTotal,
}

MetricValue is the value the opendal sends to the metrics impls.

Metrics impls can be prometheus_client, metrics etc.

Every metrics impls SHOULD implement observe over the MetricValue to make sure they provide the consistent metrics for users.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

OperationBytes(u64)

Record the size of data processed in bytes. Metrics impl: Update a Histogram with the given byte count.

OperationBytesRate(f64)

Record the rate of data processing in bytes/second. Metrics impl: Update a Histogram with the calculated rate value.

OperationEntries(u64)

Record the number of entries (files, objects, keys) processed. Metrics impl: Update a Histogram with the entry count.

OperationEntriesRate(f64)

Record the rate of entries processing in entries/second. Metrics impl: Update a Histogram with the calculated rate value.

OperationDurationSeconds(Duration)

Record the total duration of an operation. Metrics impl: Update a Histogram with the duration converted to seconds (as f64).

OperationErrorsTotal

Increment the counter for operation errors. Metrics impl: Increment a Counter by 1.

OperationExecuting(isize)

Update the current number of executing operations. Metrics impl: Add the value (positive or negative) to a Gauge.

OperationTtfbSeconds(Duration)

Record the time to first byte duration. Metrics impl: Update a Histogram with the duration converted to seconds (as f64).

HttpExecuting(isize)

Update the current number of executing HTTP requests. Metrics impl: Add the value (positive or negative) to a Gauge.

HttpRequestBytes(u64)

Record the size of HTTP request body in bytes. Metrics impl: Update a Histogram with the given byte count.

HttpRequestBytesRate(f64)

Record the rate of HTTP request data in bytes/second. Metrics impl: Update a Histogram with the calculated rate value.

HttpRequestDurationSeconds(Duration)

Record the duration of sending an HTTP request (until first byte received). Metrics impl: Update a Histogram with the duration converted to seconds (as f64).

HttpResponseBytes(u64)

Record the size of HTTP response body in bytes. Metrics impl: Update a Histogram with the given byte count.

HttpResponseBytesRate(f64)

Record the rate of HTTP response data in bytes/second. Metrics impl: Update a Histogram with the calculated rate value.

HttpResponseDurationSeconds(Duration)

Record the duration of receiving an HTTP response (from first byte to last). Metrics impl: Update a Histogram with the duration converted to seconds (as f64).

HttpConnectionErrorsTotal

Increment the counter for HTTP connection errors. Metrics impl: Increment a Counter by 1.

HttpStatusErrorsTotal

Increment the counter for HTTP status errors (non-2xx responses). Metrics impl: Increment a Counter by 1.

Implementations

impl MetricValue

pub fn name(&self) -> &'static str

Returns the full metric name for this metric value.

pub fn name_with_unit(&self) -> (&'static str, Option<&'static str>)

Returns the metric name along with unit for this metric value.

Notes

This API is designed for the metrics impls that unit aware. They will handle the names by themselves like append _total for counters.

pub fn help(&self) -> &'static str

Returns the help text for this metric value.

Trait Implementations

impl Clone for MetricValue

fn clone(&self) -> MetricValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetricValue

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

Formats the value using the given formatter.

impl Copy for MetricValue