Skip to main content

DynamicGaugeI64

Struct DynamicGaugeI64 

Source
pub struct DynamicGaugeI64 { /* private fields */ }
Expand description

Signed integer gauge keyed by runtime label sets.

Unlike DynamicCounter, this exports as a gauge (absolute value) rather than a counter (delta). Use for metrics like “active connections” that go up and down.

Uses sharded atomics internally for fast concurrent updates.

Implementations§

Source§

impl DynamicGaugeI64

Source

pub fn new(shard_count: usize) -> Self

Creates a new runtime-labeled i64 gauge.

Source

pub fn with_max_series(shard_count: usize, max_series: usize) -> Self

Creates a new runtime-labeled i64 gauge with a series cardinality cap.

When the number of unique label sets approximately reaches max_series, new label sets are redirected into a single overflow series (__ft_overflow=true). The cap is checked via a lock-free atomic counter, so concurrent inserts may briefly overshoot by the number of in-flight writers before the overflow kicks in.

Source

pub fn series(&self, labels: &[(&str, &str)]) -> DynamicGaugeI64Series

Resolve a reusable series handle for labels.

Source

pub fn inc(&self, labels: &[(&str, &str)])

Increments the gauge identified by labels by 1.

Source

pub fn dec(&self, labels: &[(&str, &str)])

Decrements the gauge identified by labels by 1.

Source

pub fn add(&self, labels: &[(&str, &str)], value: i64)

Adds value to the gauge identified by labels (can be negative).

Source

pub fn set(&self, labels: &[(&str, &str)], value: i64)

Sets the gauge identified by labels to an absolute value.

Source

pub fn get(&self, labels: &[(&str, &str)]) -> i64

Gets the current value for the gauge identified by labels.

Source

pub fn sum_all(&self) -> i64

Sums all series.

Source

pub fn snapshot(&self) -> Vec<(DynamicLabelSet, i64)>

Returns a snapshot of all label-set/value pairs.

Source

pub fn cardinality(&self) -> usize

Returns the current number of distinct label sets.

Source

pub fn overflow_count(&self) -> u64

Returns the number of records routed to the overflow bucket.

A non-zero value indicates the cardinality cap was hit and label fidelity is being lost. Use this to alert on cardinality pressure.

Source

pub fn evict_stale(&self, max_staleness: u32) -> usize

Evict series that haven’t been accessed for max_staleness cycles.

Call this after advance_cycle() in your exporter task. Series are marked as evicted (so cached handles see the tombstone), then removed from the index.

Protected series (Arc::strong_count > 1) are never evicted - someone holds a DynamicGaugeI64Series handle to them.

Returns the number of series evicted.

Trait Implementations§

Source§

impl ClickHouseExport for DynamicGaugeI64

Source§

fn export_clickhouse( &self, batch: &mut ClickHouseMetricBatch, name: &str, description: &str, time_unix_nano: u64, )

Source§

impl DogStatsDExport for DynamicGaugeI64

Source§

fn export_dogstatsd( &self, output: &mut String, name: &str, tags: &[(&str, &str)], )

Export this metric to the output string in DogStatsD format. Read more
Source§

impl OtlpExport for DynamicGaugeI64

Source§

fn export_otlp( &self, metrics: &mut Vec<Metric>, name: &str, description: &str, time_unix_nano: u64, )

Source§

impl PrometheusExport for DynamicGaugeI64

Source§

fn export_prometheus(&self, output: &mut String, name: &str, help: &str)

Export this metric to the output string. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more