A DogStatsD client implementation of statsd in rust.
- Forked from https://github.com/markstory/rust-statsd
- Support Datadog Statsd extensions
- Events
- Service Checks
- Constant Tagging
- Tagging for a Specific Metric
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:
// 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();
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);
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.
});
// 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,
);
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.
Licenesed under the MIT License.