2 releases

Uses old Rust 2015

0.1.1 Apr 3, 2021
0.1.0 Apr 1, 2021

#158 in Profiling

Download history 628/week @ 2023-10-28 640/week @ 2023-11-04 445/week @ 2023-11-11 288/week @ 2023-11-18 679/week @ 2023-11-25 630/week @ 2023-12-02 525/week @ 2023-12-09 337/week @ 2023-12-16 210/week @ 2023-12-23 462/week @ 2023-12-30 617/week @ 2024-01-06 478/week @ 2024-01-13 453/week @ 2024-01-20 217/week @ 2024-01-27 382/week @ 2024-02-03 448/week @ 2024-02-10

1,580 downloads per month

MIT license

29KB
508 lines

Rust DogStatsd

Build Status

A DogStatsD client implementation of statsd in rust.

Using the client library

Add the datadog-statsd package as a dependency in your Cargo.toml file:

[dependencies]
datadog-statsd = "^0.1.0"

You need rustc >= 1.8.0 for statsd to work.

You can then get a client instance and start tracking metrics:

// Load the crate
extern crate datadog_statsd;

// Import the client object.
use datadog_statsd::Client;

// Get a client with the prefix of `myapp`. The host should be the
// IP:port of your statsd daemon.
let client = Client::new("127.0.0.1:8125", "myapp", Some(vec!["common1", "common2:test"]),).unwrap();

Tracking Metrics

Once you've created a client, you can track timers and metrics:

let tags = &Some(vec!["tag1", "tag2:test"]);

// Increment a counter by 1
client.incr("some.counter", tags);

// Decrement a counter by 1
client.decr("some.counter", tags);

// Update a gauge
client.gauge("some.value", 12.0, tags);

// Modify a counter by an arbitrary float.
client.count("some.counter", 511.0, tags);

// Send a histogram value as a float.
client.histogram("some.histogram", 511.0, tags);

Tracking Timers

Timers can be updated using timer() and time():

// Update a timer based on a calculation you've done.
client.timer("operation.duration", 13.4, tags);

// Time a closure
client.time("operation.duration", tags, || {
	// Do something expensive.
});

Events & ServiceChecks

// Send a datadog event.
client.event("event title", "event text", AlertType::Warning, tags);

// Send a datadog service check.
client.service_check(
    "myapp.service.check.name",
    ServiceCheckStatus::Critical,
    tags,
);

Pipeline

Multiple metrics can be sent to StatsD once using pipeline:

let mut pipe = client.pipeline():

// Increment a counter by 1
pipe.incr("some.counter");

// Decrement a counter by 1
pipe.decr("some.counter");

// Update a gauge
pipe.gauge("some.value", 12.0);

// Modify a counter by an arbitrary float.
pipe.count("some.counter", 511.0);

// Send a histogram value as a float.
pipe.histogram("some.histogram", 511.0);

// Set max UDP packet size if you wish, default is 512
pipe.set_max_udp_size(128);

// Send to StatsD
pipe.send(&client);

Pipelines are also helpful to make functions simpler to test, as you can pass a pipeline and be confident that no UDP packets will be sent.

License

Licenesed under the MIT License.

Dependencies

~320–550KB