Struct dipstick::Statsd

pub struct Statsd { /* private fields */ }

Statsd Input holds a datagram (UDP) socket to a statsd server. The socket is shared between scopes opened from the Input.

Implementations

impl Statsd

pub fn send_to<ADDR: ToSocketAddrs>(address: ADDR) -> Result<Statsd>

Send metrics to a statsd server at the address and port provided.

Examples found in repository

examples/statsd_sampling.rs (line 7)

fn main() {
    let metrics = Statsd::send_to("localhost:8125")
        .expect("Connected")
        .sampled(Sampling::Random(0.2))
        .named("my_app")
        .metrics();

    let counter = metrics.counter("counter_a");

    loop {
        for i in 1..11 {
            counter.count(i);
        }
        std::thread::sleep(Duration::from_millis(3000));
    }
}

examples/statsd_nosampling.rs (line 7)

fn main() {
    let metrics = Statsd::send_to("localhost:8125")
        .expect("Connected")
        //            .with_sampling(Sampling::Random(0.2))
        .named("my_app")
        .metrics();

    let counter = metrics.counter("counter_a");

    loop {
        for i in 1..11 as usize {
            counter.count(i);
        }
        std::thread::sleep(Duration::from_millis(3000));
    }
}

examples/per_metric_sampling.rs (line 7)

fn main() {
    let statsd = Statsd::send_to("localhost:8125")
        .expect("Connected")
        .named("my_app");
    // Sampling::Full is the default
    // .sampled(Sampling::Full);

    let unsampled_marker = statsd.metrics().marker("marker_a");

    let low_freq_marker = statsd
        .sampled(Sampling::Random(0.1))
        .metrics()
        .marker("low_freq_marker");

    let hi_freq_marker = statsd
        .sampled(Sampling::Random(0.001))
        .metrics()
        .marker("hi_freq_marker");

    loop {
        unsampled_marker.mark();

        for _i in 0..10 {
            low_freq_marker.mark();
        }
        for _i in 0..1000 {
            hi_freq_marker.mark();
        }
        std::thread::sleep(Duration::from_millis(3000));
    }
}

Trait Implementations

impl Buffered for Statsd

fn buffered(&self, buffering: Buffering) -> Self

Return a clone with the specified buffering set.

fn get_buffering(&self) -> Buffering

Return the current buffering strategy.

fn is_buffered(&self) -> bool

Returns false if the current buffering strategy is Buffering::Unbuffered. Returns true otherwise.

impl CachedInput for Statsd

fn cached(self, max_size: usize) -> InputCache

Wrap an input with a metric definition cache. This can provide performance benefits for metrics that are dynamically defined at runtime on each access. Caching is useless if all metrics are statically declared or instantiated programmatically in advance and referenced by a long living variable.

impl Clone for Statsd

fn clone(&self) -> Statsd

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Statsd

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

Formats the value using the given formatter.

impl Input for Statsd

type SCOPE = StatsdScope

The type of Scope returned byt this input.

fn metrics(&self) -> Self::SCOPE

Open a new scope from this input.

fn input(&self) -> Self::SCOPE

👎Deprecated since 0.7.2: Use metrics()

Open a new scope from this input.

fn new_scope(&self) -> Self::SCOPE

👎Deprecated since 0.8.0: Use metrics()

Open a new scope from this input.

impl QueuedInput for Statsd

fn queued(self, max_size: usize) -> InputQueue

Wrap this output with an asynchronous dispatch queue of specified length.

impl Sampled for Statsd

fn sampled(&self, sampling: Sampling) -> Self

Perform random sampling of values according to the specified rate.

fn get_sampling(&self) -> Sampling

Get the sampling strategy for this component, if any.

impl WithAttributes for Statsd

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.