Skip to main content

CounterSetBuffer

Struct CounterSetBuffer 

Source
pub struct CounterSetBuffer<'a> { /* private fields */ }
Expand description

A local write buffer for a CounterSet.

Use one buffer per worker/thread when a hot path records several related counters per logical operation. The buffer accumulates deltas locally and flushes them to the backing CounterSet every flush_every completed operations, reducing shared atomic writes on very hot paths.

Individual updates are supported with CounterSetBuffer::inc and CounterSetBuffer::add. Call CounterSetBuffer::finish_op once after recording all updates for a logical operation. Full-group updates such as CounterSetBuffer::inc_all and CounterSetBuffer::add_values already finish the operation.

The buffer also flushes on drop, but long-lived services should still flush at request or task boundaries when they need prompt visibility to exporters.

use fast_telemetry::{CounterSet, CounterSetBuffer};

const REQUESTS: usize = 0;
const BYTES: usize = 1;
const ERRORS: usize = 2;

let counters = CounterSet::new(4, 3);
let mut buffer = CounterSetBuffer::new(&counters, 64);

buffer.inc(REQUESTS);
buffer.add(BYTES, 4096);
buffer.finish_op();

buffer.inc(REQUESTS);
buffer.inc(ERRORS);
buffer.finish_op();

buffer.flush();

assert_eq!(counters.sum(REQUESTS), 2);
assert_eq!(counters.sum(BYTES), 4096);
assert_eq!(counters.sum(ERRORS), 1);

Implementations§

Source§

impl<'a> CounterSetBuffer<'a>

Source

pub fn new(counters: &'a CounterSet, flush_every: usize) -> Self

Creates a local buffer for a grouped counter set.

Source

pub fn inc(&mut self, counter_idx: usize)

Increments one buffered counter.

Source

pub fn add(&mut self, counter_idx: usize, value: isize)

Adds a value to one buffered counter.

Source

pub fn inc_all(&mut self)

Increments every buffered counter and marks one logical operation complete.

Source

pub fn add_all(&mut self, value: isize)

Adds the same value to every buffered counter and marks one logical operation complete.

Source

pub fn add_values(&mut self, values: &[isize])

Adds one value per buffered counter and marks one logical operation complete.

Source

pub fn finish_op(&mut self)

Marks the current logical operation complete.

Source

pub fn flush(&mut self)

Flushes buffered deltas to the backing grouped counter set.

Trait Implementations§

Source§

impl Drop for CounterSetBuffer<'_>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for CounterSetBuffer<'a>

§

impl<'a> RefUnwindSafe for CounterSetBuffer<'a>

§

impl<'a> Send for CounterSetBuffer<'a>

§

impl<'a> Sync for CounterSetBuffer<'a>

§

impl<'a> Unpin for CounterSetBuffer<'a>

§

impl<'a> UnsafeUnpin for CounterSetBuffer<'a>

§

impl<'a> UnwindSafe for CounterSetBuffer<'a>

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