1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
# Rust Statsd
[](http://travis-ci.org/markstory/rust-statsd)
A StatsD client implementation of statsd in rust.
## Using the client library
Add the `statsd` package as a dependency in your `Cargo.toml` file:
```toml
[dependencies]
statsd = "^0.16"
```
You need rustc >= 1.31.0 for statsd to work.
You can then get a client instance and start tracking metrics:
```rust
// Load the crate
extern crate statsd;
// Import the client object.
use 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").unwrap();
```
## Tracking Metrics
Once you've created a client, you can track timers and metrics:
```rust
// Increment a counter by 1
client.incr("some.counter");
// Decrement a counter by 1
client.decr("some.counter");
// Update a gauge
client.gauge("some.value", 12.0);
// Modify a counter by an arbitrary float.
client.count("some.counter", 511.0);
// Send a histogram value as a float.
client.histogram("some.histogram", 511.0);
// Send a key/value.
client.kv("some.data", 15.26);
```
### Tracking Timers
Timers can be updated using `timer()` and `time()`:
```rust
// Update a timer based on a calculation you've done.
client.timer("operation.duration", 13.4);
// Time a closure
client.time("operation.duration", || {
// Do something expensive.
});
```
### Pipeline
Multiple metrics can be sent to StatsD once using pipeline:
```rust
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);
// Send a key/value.
pipe.kv("some.data", 15.26);
// 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](LICENSE.txt).
|
