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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
use crate::parse::{AutometricsArgs, Item};
use percent_encoding::{utf8_percent_encode, NON_ALPHANUMERIC};
use proc_macro2::TokenStream;
use quote::quote;
use std::env;
use syn::{parse_macro_input, ImplItem, ItemFn, ItemImpl, Result};
mod parse;
const COUNTER_NAME_PROMETHEUS: &str = "function_calls_count";
const HISTOGRAM_BUCKET_NAME_PROMETHEUS: &str = "function_calls_duration_bucket";
const GAUGE_NAME_PROMETHEUS: &str = "function_calls_concurrent";
const DEFAULT_PROMETHEUS_URL: &str = "http://localhost:9090";
#[proc_macro_attribute]
pub fn autometrics(
args: proc_macro::TokenStream,
item: proc_macro::TokenStream,
) -> proc_macro::TokenStream {
let args = parse_macro_input!(args as parse::AutometricsArgs);
let item = parse_macro_input!(item as Item);
let result = match item {
Item::Function(item) => instrument_function(&args, item),
Item::Impl(item) => instrument_impl_block(&args, item),
};
let output = match result {
Ok(output) => output,
Err(err) => err.into_compile_error(),
};
output.into()
}
fn instrument_function(args: &AutometricsArgs, item: ItemFn) -> Result<TokenStream> {
let sig = item.sig;
let block = item.block;
let vis = item.vis;
let attrs = item.attrs;
let function_name = sig.ident.to_string();
let prometheus_url =
env::var("PROMETHEUS_URL").unwrap_or_else(|_| DEFAULT_PROMETHEUS_URL.to_string());
let metrics_docs = create_metrics_docs(&prometheus_url, &function_name, args.track_concurrency);
let call_function = if sig.asyncness.is_some() {
quote! {
autometrics::__private::CALLER.scope(#function_name, async move {
#block
}).await
}
} else {
quote! {
autometrics::__private::CALLER.sync_scope(#function_name, move || {
#block
})
}
};
let objective = if let Some(objective) = &args.objective {
quote! { Some(#objective) }
} else {
quote! { None }
};
let counter_labels = if args.ok_if.is_some() || args.error_if.is_some() {
let result_label = if let Some(ok_if) = &args.ok_if {
quote! { if #ok_if (&result) { "ok" } else { "error" } }
} else if let Some(error_if) = &args.error_if {
quote! { if #error_if (&result) { "error" } else { "ok" } }
} else {
unreachable!()
};
quote! {
{
use autometrics::__private::{CALLER, CounterLabels, GetStaticStrFromIntoStaticStr, GetStaticStr};
let result_label = #result_label;
let value_type = (&result).__autometrics_static_str();
CounterLabels::new(
#function_name,
module_path!(),
CALLER.get(),
Some((result_label, value_type)),
#objective,
)
}
}
} else {
quote! {
{
use autometrics::__private::{CALLER, CounterLabels, GetLabels, GetLabelsFromResult};
let result_labels = (&result).__autometrics_get_labels();
CounterLabels::new(
#function_name,
module_path!(),
CALLER.get(),
result_labels,
#objective,
)
}
}
};
let gauge_labels = if args.track_concurrency {
quote! { Some(&autometrics::__private::GaugeLabels { function: #function_name, module: module_path!() }) }
} else {
quote! { None }
};
Ok(quote! {
#(#attrs)*
#[doc=#metrics_docs]
#vis #sig {
let __autometrics_tracker = {
use autometrics::__private::{AutometricsTracker, TrackMetrics};
AutometricsTracker::start(#gauge_labels)
};
let result = #call_function;
{
use autometrics::__private::{HistogramLabels, TrackMetrics};
let counter_labels = #counter_labels;
let histogram_labels = HistogramLabels::new(
#function_name,
module_path!(),
#objective,
);
__autometrics_tracker.finish(&counter_labels, &histogram_labels);
}
result
}
})
}
fn instrument_impl_block(args: &AutometricsArgs, mut item: ItemImpl) -> Result<TokenStream> {
item.items = item
.items
.into_iter()
.map(|item| match item {
ImplItem::Method(mut method) => {
if method
.attrs
.iter()
.any(|attr| attr.path.is_ident("skip_autometrics"))
{
method
.attrs
.retain(|attr| !attr.path.is_ident("skip_autometrics"));
return ImplItem::Method(method);
}
let item_fn = ItemFn {
attrs: method.attrs,
vis: method.vis,
sig: method.sig,
block: Box::new(method.block),
};
let tokens = match instrument_function(args, item_fn) {
Ok(tokens) => tokens,
Err(err) => err.to_compile_error(),
};
ImplItem::Verbatim(tokens)
}
_ => item,
})
.collect();
Ok(quote! { #item })
}
fn create_metrics_docs(prometheus_url: &str, function: &str, track_concurrency: bool) -> String {
let request_rate = request_rate_query(&COUNTER_NAME_PROMETHEUS, "function", &function);
let request_rate_url = make_prometheus_url(
&prometheus_url,
&request_rate,
&format!(
"Rate of calls to the `{function}` function per second, averaged over 5 minute windows"
),
);
let callee_request_rate = request_rate_query(&COUNTER_NAME_PROMETHEUS, "caller", &function);
let callee_request_rate_url = make_prometheus_url(&prometheus_url, &callee_request_rate, &format!("Rate of calls to functions called by `{function}` per second, averaged over 5 minute windows"));
let error_ratio = &error_ratio_query(&COUNTER_NAME_PROMETHEUS, "function", &function);
let error_ratio_url = make_prometheus_url(&prometheus_url, &error_ratio, &format!("Percentage of calls to the `{function}` function that return errors, averaged over 5 minute windows"));
let callee_error_ratio = &error_ratio_query(&COUNTER_NAME_PROMETHEUS, "caller", &function);
let callee_error_ratio_url = make_prometheus_url(&prometheus_url, &callee_error_ratio, &format!("Percentage of calls to functions called by `{function}` that return errors, averaged over 5 minute windows"));
let latency = latency_query(&HISTOGRAM_BUCKET_NAME_PROMETHEUS, "function", &function);
let latency_url = make_prometheus_url(
&prometheus_url,
&latency,
&format!("95th and 99th percentile latencies (in seconds) for the `{function}` function"),
);
let concurrent_calls_doc = if track_concurrency {
let concurrent_calls =
concurrent_calls_query(&GAUGE_NAME_PROMETHEUS, "function", &function);
let concurrent_calls_url = make_prometheus_url(
&prometheus_url,
&concurrent_calls,
&format!("Concurrent calls to the `{function}` function"),
);
format!("\n- [Concurrent Calls]({concurrent_calls_url}")
} else {
String::new()
};
format!(
"\n\n---
## Autometrics
View the live metrics for the `{function}` function:
- [Request Rate]({request_rate_url})
- [Error Ratio]({error_ratio_url})
- [Latency (95th and 99th percentiles)]({latency_url}){concurrent_calls_doc}
Or, dig into the metrics of *functions called by* `{function}`:
- [Request Rate]({callee_request_rate_url})
- [Error Ratio]({callee_error_ratio_url})
"
)
}
fn make_prometheus_url(url: &str, query: &str, comment: &str) -> String {
let mut url = url.to_string();
let comment_and_query = format!("# {comment}\n\n{query}");
let query = utf8_percent_encode(&comment_and_query, NON_ALPHANUMERIC).to_string();
if !url.ends_with('/') {
url.push('/');
}
url.push_str("graph?g0.expr=");
url.push_str(&query);
url.push_str("&g0.tab=0");
url
}
fn request_rate_query(counter_name: &str, label_key: &str, label_value: &str) -> String {
format!("sum by (function, module) (rate({counter_name}{{{label_key}=\"{label_value}\"}}[5m]))")
}
fn error_ratio_query(counter_name: &str, label_key: &str, label_value: &str) -> String {
let request_rate = request_rate_query(counter_name, label_key, label_value);
format!("sum by (function, module) (rate({counter_name}{{{label_key}=\"{label_value}\",result=\"error\"}}[5m])) /
{request_rate}", )
}
fn latency_query(bucket_name: &str, label_key: &str, label_value: &str) -> String {
let latency = format!(
"sum by (le, function, module) (rate({bucket_name}{{{label_key}=\"{label_value}\"}}[5m]))"
);
format!(
"histogram_quantile(0.99, {latency}) or
histogram_quantile(0.95, {latency})"
)
}
fn concurrent_calls_query(gauge_name: &str, label_key: &str, label_value: &str) -> String {
format!("sum by (function, module) {gauge_name}{{{label_key}=\"{label_value}\"}}")
}