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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
/// Records a counter.
///
/// Functionally equivalent to calling [`Recorder::record_counter`].
///
/// ### Examples
///
/// ```rust
/// # #[macro_use]
/// # extern crate metrics;
/// fn do_thing() {
/// let count: u64 = 42;
/// counter!("do_thing", count);
/// }
/// # fn main() {}
/// ```
///
/// Labels can also be passed along:
///
/// ```rust
/// # #[macro_use]
/// # extern crate metrics;
/// fn do_thing() {
/// let count: u64 = 42;
/// let user: String = String::from("jane");
/// counter!("do_thing", count, "service" => "admin", "user" => user);
/// }
/// # fn main() {}
/// ```
/// Records a gauge.
///
/// Functionally equivalent to calling [`Recorder::record_gauge`].
///
/// ### Examples
///
/// ```rust
/// # #[macro_use]
/// # extern crate metrics;
/// fn update_current_value() {
/// let value: i64 = -131;
/// gauge!("current_value", value);
/// }
/// # fn main() {}
/// ```
///
/// Labels can also be passed along:
///
/// ```rust
/// # #[macro_use]
/// # extern crate metrics;
/// fn update_current_value() {
/// let value: i64 = -131;
/// let creator: String = String::from("jane");
/// gauge!("current_value", value, "creator" => creator);
/// }
/// # fn main() {}
/// ```
/// Records a timing.
///
/// Functionally equivalent to calling [`Recorder::record_histogram`].
///
/// ### Examples
///
/// ```rust
/// # #[macro_use]
/// # extern crate metrics;
/// # use std::time::Instant;
/// # fn process() {}
/// fn handle_request() {
/// let start = Instant::now();
/// process();
/// let end = Instant::now();
///
/// // We can pass instances of `Instant` directly:
/// timing!("perf.request_processed", start, end);
///
/// // Or we can pass just the delta:
/// let delta = end - start;
/// timing!("perf.request_processed", delta);
///
/// // And we can even pass unsigned values, both for the start/end notation:
/// let start: u64 = 100;
/// let end: u64 = 200;
/// timing!("perf.request_processed", start, end);
///
/// // And the delta notation:
/// let delta: u64 = end - start;
/// timing!("perf.request_processed", delta);
/// }
/// # fn main() {}
/// ```
///
/// Labels can also be passed along:
///
/// ```rust
/// # #[macro_use]
/// # extern crate metrics;
/// # use std::time::Instant;
/// # fn process() {}
/// fn handle_request() {
/// let start = Instant::now();
/// process();
/// let end = Instant::now();
///
/// // We can pass instances of `Instant` directly:
/// timing!("perf.request_processed", start, end, "service" => "http", "type" => "checkout");
///
/// // Or we can pass just the delta:
/// let delta = end - start;
/// timing!("perf.request_processed", delta, "service" => "http", "type" => "checkout");
///
/// // And we can even pass unsigned values, both for the start/end notation:
/// let start: u64 = 100;
/// let end: u64 = 200;
/// timing!("perf.request_processed", start, end, "service" => "http", "type" => "checkout");
///
/// // And the delta notation:
/// let delta: u64 = end - start;
/// timing!("perf.request_processed", delta, "service" => "http", "type" => "checkout");
/// }
/// # fn main() {}
/// ```
/// Records a value.
///
/// Functionally equivalent to calling [`Recorder::record_histogram`].
///
/// ### Examples
///
/// ```rust
/// # #[macro_use]
/// # extern crate metrics;
/// # use std::time::Instant;
/// # fn process() -> u64 { 42 }
/// fn handle_request() {
/// let rows_read = process();
/// value!("client.process_num_rows", rows_read);
/// }
/// # fn main() {}
/// ```
///
/// Labels can also be passed along:
///
/// ```rust
/// # #[macro_use]
/// # extern crate metrics;
/// # use std::time::Instant;
/// # fn process() -> u64 { 42 }
/// fn handle_request() {
/// let rows_read = process();
/// value!("client.process_num_rows", rows_read, "resource" => "shard1", "table" => "posts");
/// }
/// # fn main() {}
/// ```