Struct Client

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

Client socket for statsd servers.

After creating a metric you can use Client to send metrics to the configured statsd server

§Example

Creating a client and sending metrics can be done with:

use statsd::client::Client;

let client = Client::new("127.0.0.1:8125", "myapp");
client.incr("some.metric.completed");

Implementations§

Source§

impl Client

Source

pub fn new<T: ToSocketAddrs>( host: T, prefix: &str, ) -> Result<Client, StatsdError>

Construct a new statsd client given an host/port & prefix

Source

pub fn incr(&self, metric: &str)

Increment a metric by 1

client.incr("metric.completed");

This modifies a counter with an effective sampling rate of 1.0.

Source

pub fn decr(&self, metric: &str)

Decrement a metric by -1

client.decr("metric.completed");

This modifies a counter with an effective sampling rate of 1.0.

Source

pub fn count(&self, metric: &str, value: f64)

Modify a counter by value.

Will increment or decrement a counter by value with a sampling rate of 1.0.

// Increment by 12
client.count("metric.completed", 12.0);
Source

pub fn sampled_count(&self, metric: &str, value: f64, rate: f64)

Modify a counter by value only x% of the time.

Will increment or decrement a counter by value with a custom sampling rate.

// Increment by 4 50% of the time.
client.sampled_count("metric.completed", 4, 0.5);
Source

pub fn gauge(&self, metric: &str, value: f64)

Set a gauge value.

// set a gauge to 9001
client.gauge("power_level.observed", 9001.0);
Source

pub fn timer(&self, metric: &str, value: f64)

Send a timer value.

The value is expected to be in ms.

// pass a duration value
client.timer("response.duration", 10.123);
Source

pub fn time<F, R>(&self, metric: &str, callable: F) -> R
where F: FnOnce() -> R,

Time a block of code.

The passed closure will be timed and executed. The block’s duration will be sent as a metric.

// pass a duration value
client.time("response.duration", || {
  // Your code here.
});
Source

pub fn pipeline(&self) -> Pipeline

Get a pipeline struct that allows optimizes the number of UDP packets used to send multiple metrics

let mut pipeline = client.pipeline();
pipeline.incr("some.metric", 1);
pipeline.incr("other.metric", 1);
pipeline.send(&mut client);
Source

pub fn histogram(&self, metric: &str, value: f64)

Send a histogram value.

// pass response size value
client.histogram("response.size", 128.0);
Source

pub fn kv(&self, metric: &str, value: f64)

Send a key/value

client.kv("key", 1.);

Auto Trait Implementations§

§

impl Freeze for Client

§

impl RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl UnwindSafe for Client

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, 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, 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