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
use crate::{
allocator::{
returning_reference::{ReturnTarget, ReturningRef},
MetricsAllocator, MetricsRef,
},
metrics::MetricsBehavior,
pipeline::Sink,
types::Name,
};
pub struct MetricsFactory<TMetricsAllocator, TSink> {
allocator: TMetricsAllocator,
default_metrics_behavior: u32,
sink: TSink,
}
pub trait RecordingScope<'a, TMetricsRef: 'a>: ReturnTarget<'a, TMetricsRef>
where
Self: Sized,
{
fn record_scope(&'a self, scope_name: impl Into<Name>) -> ReturningRef<'a, TMetricsRef, Self>;
fn record_scope_with_behavior(
&'a self,
scope_name: impl Into<Name>,
behavior: MetricsBehavior,
) -> ReturningRef<'a, TMetricsRef, Self>;
fn emit(&self, metrics: TMetricsRef);
unsafe fn create_new_raw_metrics(&'a self, metrics_name: impl Into<Name>) -> TMetricsRef;
}
impl<'a, TMetricsRef, TMetricsAllocator, TSink> ReturnTarget<'a, TMetricsRef>
for MetricsFactory<TMetricsAllocator, TSink>
where
TMetricsRef: MetricsRef + 'a,
TMetricsAllocator: MetricsAllocator<'a, TMetricsRef> + Default,
TSink: Sink<TMetricsRef>,
{
fn return_referent(&self, to_return: TMetricsRef) {
self.emit(to_return);
}
}
impl<'a, TMetricsRef, TMetricsAllocator, TSink> RecordingScope<'a, TMetricsRef>
for MetricsFactory<TMetricsAllocator, TSink>
where
TMetricsRef: MetricsRef + 'a,
TSink: Sink<TMetricsRef>,
TMetricsAllocator: MetricsAllocator<'a, TMetricsRef> + Default,
{
#[inline]
fn record_scope(&'a self, scope_name: impl Into<Name>) -> ReturningRef<'a, TMetricsRef, Self> {
ReturningRef::new(self, unsafe { self.create_new_raw_metrics(scope_name) })
}
#[inline]
fn record_scope_with_behavior(
&'a self,
scope_name: impl Into<Name>,
behavior: MetricsBehavior,
) -> ReturningRef<'a, TMetricsRef, Self> {
ReturningRef::new(self, unsafe {
let mut m = self.create_new_raw_metrics(scope_name);
m.add_behavior(behavior);
m
})
}
#[inline]
fn emit(&self, metrics: TMetricsRef) {
if metrics.has_behavior(MetricsBehavior::Suppress) {
return;
}
if !metrics.has_behavior(MetricsBehavior::SuppressTotalTime) {
let elapsed = metrics.start_time.elapsed();
metrics.distribution("totaltime", elapsed);
}
self.sink.accept(metrics)
}
#[inline]
unsafe fn create_new_raw_metrics(&'a self, metrics_name: impl Into<Name>) -> TMetricsRef {
let mut m = self.allocator.new_metrics(metrics_name);
m.set_raw_behavior(self.default_metrics_behavior);
m
}
}
impl<TMetricsAllocator, TSink> MetricsFactory<TMetricsAllocator, TSink>
where
TMetricsAllocator: Default,
{
pub fn new(sink: TSink) -> Self {
MetricsFactory::new_with_behaviors(sink, &[MetricsBehavior::Default])
}
pub fn new_with_behaviors(sink: TSink, behaviors: &[MetricsBehavior]) -> Self {
MetricsFactory::new_with_allocator(sink, behaviors, Default::default())
}
pub fn new_with_allocator(
sink: TSink,
behaviors: &[MetricsBehavior],
allocator: TMetricsAllocator,
) -> Self {
MetricsFactory {
allocator,
default_metrics_behavior: behaviors
.iter()
.fold(0, |i, behavior| (i | (*behavior as u32))),
sink,
}
}
}
impl<TMetricsAllocator, TSink> Default for MetricsFactory<TMetricsAllocator, TSink>
where
TSink: Default,
TMetricsAllocator: Default,
{
fn default() -> Self {
Self::new(Default::default())
}
}
#[cfg(test)]
mod test {
use std::rc::Rc;
use crate::{
allocator::always_new_metrics_allocator::AlwaysNewMetricsAllocator,
metrics::MetricsBehavior,
metrics_factory::RecordingScope,
pipeline::{
aggregating_sink::AggregatingSink, logging_sink::LoggingSink,
serializing_sink::SerializingSink,
},
};
use super::MetricsFactory;
#[test_log::test]
fn logging_metrics_factory() {
let metrics_factory: MetricsFactory<AlwaysNewMetricsAllocator, LoggingSink> =
MetricsFactory::new(LoggingSink::default());
let metrics = metrics_factory.record_scope("test");
metrics.dimension("some dimension", "a dim");
metrics.measurement("measure", 13);
metrics.distribution("distribution of", 61);
metrics.distribution("high frequency", vec![13, 13, 14, 10, 13, 11, 13]);
}
#[test_log::test]
fn serializing_metrics_factory() {
let metrics_factory: MetricsFactory<
AlwaysNewMetricsAllocator,
SerializingSink<LoggingSink>,
> = MetricsFactory::new_with_allocator(
SerializingSink::new(LoggingSink::default()),
&[MetricsBehavior::Default],
AlwaysNewMetricsAllocator::default(),
);
let metrics = metrics_factory.record_scope("test");
metrics.dimension("some dimension", "a dim");
}
#[test_log::test]
fn aggregating_metrics_factory() {
let metrics_factory: MetricsFactory<AlwaysNewMetricsAllocator, Rc<AggregatingSink>> =
MetricsFactory::new_with_allocator(
Rc::new(AggregatingSink::new()),
&[MetricsBehavior::Default],
AlwaysNewMetricsAllocator::default(),
);
{
let metrics = metrics_factory.record_scope("test");
metrics.dimension("some dimension", "a dim");
}
}
}