Struct InputQueueScope

pub struct InputQueueScope { /* private fields */ }

A metric scope wrapper that sends writes & flushes over a Rust sync channel. Commands are executed by a background thread.

Implementations

impl InputQueueScope

pub fn wrap<SC: InputScope + Send + Sync + 'static>( target_scope: SC, queue_length: usize, ) -> Self

Wrap new scopes with an asynchronous metric write & flush dispatcher.

Examples found in repository

examples/bench_queue.rs (line 13)

fn main() {
    let bucket = AtomicBucket::new();
    // NOTE: Wrapping an AtomicBucket with a Queue probably useless, as it is very fast and performs no I/O.
    let queue = InputQueueScope::wrap(bucket.clone(), 10000);
    let event = queue.marker("a");
    let args = &mut args();
    args.next();
    let tc: u8 = u8::from_str(&args.next().unwrap()).unwrap();
    for _ in 0..tc {
        let event = event.clone();
        thread::spawn(move || {
            loop {
                // report some metric values from our "application" loop
                event.mark();
            }
        });
    }
    sleep(Duration::from_secs(5));
    bucket
        .flush_to(&Stream::write_to_stdout().metrics())
        .unwrap();
}

Trait Implementations

impl Clone for InputQueueScope

fn clone(&self) -> InputQueueScope

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Flush for InputQueueScope

fn flush(&self) -> Result<()>

Flush does nothing by default.

impl InputScope for InputQueueScope

fn new_metric(&self, name: MetricName, kind: InputKind) -> InputMetric

Define a generic metric of the specified type. It is preferable to use counter() / marker() / timer() / gauge() methods.

fn counter(&self, name: &str) -> Counter

Define a Counter.

fn marker(&self, name: &str) -> Marker

Define a Marker.

fn timer(&self, name: &str) -> Timer

Define a Timer.

fn gauge(&self, name: &str) -> Gauge

Define a Gauge.

fn level(&self, name: &str) -> Level

Define a Level.

impl WithAttributes for InputQueueScope

fn get_attributes(&self) -> &Attributes

Return attributes of component.

fn mut_attributes(&mut self) -> &mut Attributes

Return attributes of component for mutation.

fn with_attributes<F: Fn(&mut Attributes)>(&self, edit: F) -> Self

Clone the component and mutate its attributes at once.