Skip to navigation
ReferenceAPIsRust Library Referencenemo-relayscope

Struct Emit Metric Event Params

View as Markdown

Generated from cargo doc --no-deps -p nemo-relay-builtins -p nemo-relay-diagnostics -p nemo-relay-logging -p nemo-relay-plugin-host -p nemo-relay-codecs -p nemo-relay -p nemo-relay-runtime -p nemo-relay-model-pricing -p nemo-relay-resource-metrics -p nemo-relay-observability -p nemo-relay-adaptive -p nemo-relay-pii-redaction -p nemo-relay-ffi -p nemo-relay-types -p nemo-relay-plugin -p nemo-relay-worker-proto -p nemo-relay-worker.

pub struct EmitMetricEventParams<'a> {
    pub name: &'a str,
    pub measurements: Vec<MetricMeasurement>,
    pub parent: Option<&'a ScopeHandle>,
    pub metadata: Option<Value>,
    pub timestamp: Option<DateTime<Utc>>,
}

Builder parameters for metric.

Fields

name: &'a str

Mark name to emit for the metric recording operations.

measurements: Vec<MetricMeasurement>

Metric measurements recorded atomically by downstream metric exporters.

parent: Option<&'a ScopeHandle>

Optional explicit parent scope.

metadata: Option<Value>

Optional JSON metadata recorded on the emitted event.

timestamp: Option<DateTime<Utc>>

Optional timestamp recorded on the emitted metric mark.

Implementations

impl<'a> EmitMetricEventParams<'a>

impl<'a> EmitMetricEventParams<'a>

builder

pub fn builder() -> EmitMetricEventParamsBuilder<'a>

Create a builder for building EmitMetricEventParams. On the builder, call .name(...), .measurements(...), .parent(...)(optional), .metadata(...)(optional), .timestamp(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of EmitMetricEventParams.