Struct datadog_statsd::client::Pipeline

pub struct Pipeline { /* private fields */ }

Implementations

impl Pipeline

pub fn new() -> Pipeline

pub fn set_max_udp_size(&mut self, max_udp_size: usize)

Set max UDP packet size

use datadog_statsd::client::Pipeline;

let mut pipe = Pipeline::new();
pipe.set_max_udp_size(128);

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

Increment a metric by 1

use datadog_statsd::client::Pipeline;

let mut pipe = Pipeline::new();
// Increment a given metric by 1.
pipe.incr("metric.completed");

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

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

Decrement a metric by -1

use datadog_statsd::client::Pipeline;

let mut pipe = Pipeline::new();
// Decrement a given metric by 1
pipe.decr("metric.completed");

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

pub fn count(&mut 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.

use datadog_statsd::client::Pipeline;

let mut pipe = Pipeline::new();
// Increment by 12
pipe.count("metric.completed", 12.0);

pub fn sampled_count(&mut 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.

use datadog_statsd::client::Pipeline;

let mut pipe = Pipeline::new();
// Increment by 4 50% of the time.
pipe.sampled_count("metric.completed", 4.0, 0.5);

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

Set a gauge value.

use datadog_statsd::client::Pipeline;

let mut pipe = Pipeline::new();
// set a gauge to 9001
pipe.gauge("power_level.observed", 9001.0);

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

Send a timer value.

The value is expected to be in ms.

use datadog_statsd::client::Pipeline;

let mut pipe = Pipeline::new();
// pass a duration value
pipe.timer("response.duration", 10.123);

pub fn time<F>(&mut self, metric: &str, callable: F)

where F: FnOnce(),

Time a block of code.

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

use datadog_statsd::client::Pipeline;

let mut pipe = Pipeline::new();
// pass a duration value
pipe.time("response.duration", || {
  // Your code here.
});

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

Send a histogram value.

use datadog_statsd::client::Pipeline;

let mut pipe = Pipeline::new();
// pass response size value
pipe.histogram("response.size", 128.0);

pub fn send(&mut self, client: &Client)

Send data along the UDP socket.

Trait Implementations

impl Default for Pipeline

fn default() -> Self

Returns the “default value” for a type.