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
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
// Copyright Materialize, Inc. and contributors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License in the LICENSE file at the
// root of this repository, or online at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Support for metrics that get removed from their corresponding metrics vector when dropped.
//!
//! # Ownership & life times
//!
//! This kind of data type is realized by a struct that retains ownership of the _labels_ used to
//! create the spin-off metric. The created metric follows these rules:
//! * When passing references, the metric must not outlive the references to the labels used to create
//!   it: A `'static` slice of static strings means the metric is allowed to live for the `'static`
//!   lifetime as well.
//! * Metrics created from references to dynamically constructed labels can only live as long as those
//!   labels do.
//! * When using owned data (an extension over what Prometheus allows, which only lets you use
//!   references to refer to labels), the created metric is also allowed to live for `'static`.

use std::borrow::Borrow;
use std::collections::BTreeMap;
use std::marker::PhantomData;
use std::ops::Deref;

use prometheus::core::{
    Atomic, GenericCounter, GenericCounterVec, GenericGauge, GenericGaugeVec, MetricVec,
    MetricVecBuilder,
};
use prometheus::{Histogram, HistogramVec};

/// An extension trait for types that are valid (or convertible into) prometheus labels:
/// slices/vectors of strings, and [`BTreeMap`]s.
pub trait PromLabelsExt<'a> {
    /// Returns or creates a metric with the given metric label values.
    /// Panics if retrieving the metric returns an error.
    fn get_from_metric_vec<P: MetricVecBuilder>(
        &self,
        vec: &MetricVec<P>,
    ) -> <P as MetricVecBuilder>::M;

    /// Removes a metric with these labels from a metrics vector.
    fn remove_from_metric_vec<P: MetricVecBuilder>(
        &self,
        vec: &MetricVec<P>,
    ) -> Result<(), prometheus::Error>;
}

impl<'a> PromLabelsExt<'a> for &'a [&'a str] {
    fn get_from_metric_vec<P: MetricVecBuilder>(
        &self,
        vec: &MetricVec<P>,
    ) -> <P as MetricVecBuilder>::M {
        vec.get_metric_with_label_values(self)
            .expect("retrieving a metric by label values")
    }

    fn remove_from_metric_vec<P: MetricVecBuilder>(
        &self,
        vec: &MetricVec<P>,
    ) -> Result<(), prometheus::Error> {
        vec.remove_label_values(self)
    }
}

impl PromLabelsExt<'static> for Vec<String> {
    fn get_from_metric_vec<P: MetricVecBuilder>(
        &self,
        vec: &MetricVec<P>,
    ) -> <P as MetricVecBuilder>::M {
        let labels: Vec<&str> = self.iter().map(String::as_str).collect();
        vec.get_metric_with_label_values(labels.as_slice())
            .expect("retrieving a metric by label values")
    }

    fn remove_from_metric_vec<P: MetricVecBuilder>(
        &self,
        vec: &MetricVec<P>,
    ) -> Result<(), prometheus::Error> {
        let labels: Vec<&str> = self.iter().map(String::as_str).collect();
        vec.remove_label_values(labels.as_slice())
    }
}

impl<'a> PromLabelsExt<'a> for Vec<&'a str> {
    fn get_from_metric_vec<P: MetricVecBuilder>(
        &self,
        vec: &MetricVec<P>,
    ) -> <P as MetricVecBuilder>::M {
        vec.get_metric_with_label_values(self.as_slice())
            .expect("retrieving a metric by label values")
    }

    fn remove_from_metric_vec<P: MetricVecBuilder>(
        &self,
        vec: &MetricVec<P>,
    ) -> Result<(), prometheus::Error> {
        vec.remove_label_values(self.as_slice())
    }
}

impl PromLabelsExt<'static> for BTreeMap<String, String> {
    fn get_from_metric_vec<P: MetricVecBuilder>(
        &self,
        vec: &MetricVec<P>,
    ) -> <P as MetricVecBuilder>::M {
        let labels = self.iter().map(|(k, v)| (k.as_str(), v.as_str())).collect();
        vec.get_metric_with(&labels)
            .expect("retrieving a metric by label values")
    }

    fn remove_from_metric_vec<P: MetricVecBuilder>(
        &self,
        vec: &MetricVec<P>,
    ) -> Result<(), prometheus::Error> {
        let labels = self.iter().map(|(k, v)| (k.as_str(), v.as_str())).collect();
        vec.remove(&labels)
    }
}

impl<'a> PromLabelsExt<'a> for BTreeMap<&'a str, &'a str> {
    fn get_from_metric_vec<P: MetricVecBuilder>(
        &self,
        vec: &MetricVec<P>,
    ) -> <P as MetricVecBuilder>::M {
        let labels = self.iter().map(|(k, v)| (*k, *v)).collect();
        vec.get_metric_with(&labels)
            .expect("retrieving a metric by label values")
    }

    fn remove_from_metric_vec<P: MetricVecBuilder>(
        &self,
        vec: &MetricVec<P>,
    ) -> Result<(), prometheus::Error> {
        let labels = self.iter().map(|(k, v)| (*k, *v)).collect();
        vec.remove(&labels)
    }
}

/// A [`GenericCounter`] wrapper that deletes its labels from the vec when it is dropped
///
/// It adds a method to create a concrete metric from the vector that gets removed from the vector
/// when the concrete metric is dropped.
///
/// NOTE: This type implements [`Borrow`], which imposes some constraints on implementers. To
/// ensure these constraints, do *not* implement any of the `Eq`, `Ord`, or `Hash` traits on this.
/// type.
#[derive(Debug)]
pub struct DeleteOnDropHistogram<'a, L>
where
    L: PromLabelsExt<'a>,
{
    inner: Histogram,
    labels: L,
    vec: HistogramVec,
    _phantom: &'a PhantomData<()>,
}

impl<'a, L> DeleteOnDropHistogram<'a, L>
where
    L: PromLabelsExt<'a>,
{
    fn from_metric_vector(vec: HistogramVec, labels: L) -> Self {
        let inner = labels.get_from_metric_vec(&vec);
        Self {
            inner,
            labels,
            vec,
            _phantom: &PhantomData,
        }
    }
}

impl<'a, L> Deref for DeleteOnDropHistogram<'a, L>
where
    L: PromLabelsExt<'a>,
{
    type Target = Histogram;
    fn deref(&self) -> &Self::Target {
        &self.inner
    }
}

impl<'a, L> Borrow<Histogram> for DeleteOnDropHistogram<'a, L>
where
    L: PromLabelsExt<'a>,
{
    fn borrow(&self) -> &Histogram {
        &self.inner
    }
}

impl<'a, L> Drop for DeleteOnDropHistogram<'a, L>
where
    L: PromLabelsExt<'a>,
{
    fn drop(&mut self) {
        if self.labels.remove_from_metric_vec(&self.vec).is_err() {
            // ignore.
        }
    }
}

/// A [`GenericCounter`] wrapper that deletes its labels from the vec when it is dropped
///
/// It adds a method to create a concrete metric from the vector that gets removed from the vector
/// when the concrete metric is dropped.
///
/// NOTE: This type implements [`Borrow`], which imposes some constraints on implementers. To
/// ensure these constraints, do *not* implement any of the `Eq`, `Ord`, or `Hash` traits on this.
/// type.
#[derive(Debug)]
pub struct DeleteOnDropCounter<'a, P, L>
where
    P: Atomic,
    L: PromLabelsExt<'a>,
{
    inner: GenericCounter<P>,
    labels: L,
    vec: GenericCounterVec<P>,
    _phantom: &'a PhantomData<()>,
}

impl<'a, P, L> DeleteOnDropCounter<'a, P, L>
where
    P: Atomic,
    L: PromLabelsExt<'a>,
{
    fn from_metric_vector(vec: GenericCounterVec<P>, labels: L) -> Self {
        let inner = labels.get_from_metric_vec(&vec);
        Self {
            inner,
            labels,
            vec,
            _phantom: &PhantomData,
        }
    }
}

impl<'a, P, L> Deref for DeleteOnDropCounter<'a, P, L>
where
    P: Atomic,
    L: PromLabelsExt<'a>,
{
    type Target = GenericCounter<P>;
    fn deref(&self) -> &GenericCounter<P> {
        &self.inner
    }
}

impl<'a, P, L> Borrow<GenericCounter<P>> for DeleteOnDropCounter<'a, P, L>
where
    P: Atomic,
    L: PromLabelsExt<'a>,
{
    fn borrow(&self) -> &GenericCounter<P> {
        &self.inner
    }
}

impl<'a, P, L> Drop for DeleteOnDropCounter<'a, P, L>
where
    P: Atomic,
    L: PromLabelsExt<'a>,
{
    fn drop(&mut self) {
        if self.labels.remove_from_metric_vec(&self.vec).is_err() {
            // ignore.
        }
    }
}

/// Extension trait for all gauge metrics vectors.
///
/// It adds a method to create a concrete metric from the vector that gets removed from the vector
/// when the concrete metric is dropped.
pub trait CounterVecExt {
    /// The type of value that the counter should count.
    type CounterType: Atomic;

    /// Returns a counter that deletes its labels from this metrics vector when dropped.
    /// See [`DeleteOnDropCounter`] for a detailed description.
    fn get_delete_on_drop_counter<'a, L: PromLabelsExt<'a>>(
        &self,
        labels: L,
    ) -> DeleteOnDropCounter<'a, Self::CounterType, L>;
}

impl<P: Atomic> CounterVecExt for GenericCounterVec<P> {
    type CounterType = P;

    fn get_delete_on_drop_counter<'a, L: PromLabelsExt<'a>>(
        &self,
        labels: L,
    ) -> DeleteOnDropCounter<'a, Self::CounterType, L> {
        DeleteOnDropCounter::from_metric_vector(self.clone(), labels)
    }
}

/// Extension trait for all gauge metrics vectors.
///
/// It adds a method to create a concrete metric from the vector that gets removed from the vector
/// when the concrete metric is dropped.
pub trait HistogramVecExt {
    /// Returns a counter that deletes its labels from this metrics vector when dropped.
    /// See [`DeleteOnDropCounter`] for a detailed description.
    fn get_delete_on_drop_histogram<'a, L: PromLabelsExt<'a>>(
        &self,
        labels: L,
    ) -> DeleteOnDropHistogram<'a, L>;
}

impl HistogramVecExt for HistogramVec {
    fn get_delete_on_drop_histogram<'a, L: PromLabelsExt<'a>>(
        &self,
        labels: L,
    ) -> DeleteOnDropHistogram<'a, L> {
        DeleteOnDropHistogram::from_metric_vector(self.clone(), labels)
    }
}

/// A [`GenericGauge`] wrapper that deletes its labels from the vec when it is dropped
///
/// NOTE: This type implements [`Borrow`], which imposes some constraints on implementers. To
/// ensure these constraints, do *not* implement any of the `Eq`, `Ord`, or `Hash` traits on this.
/// type.
#[derive(Debug)]
pub struct DeleteOnDropGauge<'a, P, L>
where
    P: Atomic,
    L: PromLabelsExt<'a>,
{
    inner: GenericGauge<P>,
    labels: L,
    vec: GenericGaugeVec<P>,
    _phantom: &'a PhantomData<()>,
}

impl<'a, P, L> DeleteOnDropGauge<'a, P, L>
where
    P: Atomic,
    L: PromLabelsExt<'a>,
{
    fn from_metric_vector(vec: GenericGaugeVec<P>, labels: L) -> Self {
        let inner = labels.get_from_metric_vec(&vec);
        Self {
            inner,
            labels,
            vec,
            _phantom: &PhantomData,
        }
    }
}

impl<'a, P, L> Deref for DeleteOnDropGauge<'a, P, L>
where
    P: Atomic,
    L: PromLabelsExt<'a>,
{
    type Target = GenericGauge<P>;
    fn deref(&self) -> &GenericGauge<P> {
        &self.inner
    }
}

impl<'a, P, L> Borrow<GenericGauge<P>> for DeleteOnDropGauge<'a, P, L>
where
    P: Atomic,
    L: PromLabelsExt<'a>,
{
    fn borrow(&self) -> &GenericGauge<P> {
        &self.inner
    }
}

impl<'a, P, L> Drop for DeleteOnDropGauge<'a, P, L>
where
    P: Atomic,
    L: PromLabelsExt<'a>,
{
    fn drop(&mut self) {
        if self.labels.remove_from_metric_vec(&self.vec).is_err() {
            // ignore.
        }
    }
}

/// Extension trait for all metrics vectors.
pub trait GaugeVecExt {
    /// The type of value that the gauge should count.
    type GaugeType: Atomic;

    /// Returns a gauge that deletes its labels from this metrics vector when dropped.
    /// See [`DeleteOnDropGauge`] for a detailed description.
    fn get_delete_on_drop_gauge<'a, L: PromLabelsExt<'a>>(
        &self,
        labels: L,
    ) -> DeleteOnDropGauge<'a, Self::GaugeType, L>;
}

impl<P: Atomic> GaugeVecExt for GenericGaugeVec<P> {
    type GaugeType = P;

    fn get_delete_on_drop_gauge<'a, L: PromLabelsExt<'a>>(
        &self,
        labels: L,
    ) -> DeleteOnDropGauge<'a, Self::GaugeType, L> {
        DeleteOnDropGauge::from_metric_vector(self.clone(), labels)
    }
}

#[cfg(test)]
mod test {
    use prometheus::core::{AtomicI64, AtomicU64};
    use prometheus::IntGaugeVec;

    use crate::metric;
    use crate::metrics::{IntCounterVec, MetricsRegistry};

    use super::*;

    #[crate::test]
    fn dropping_counters() {
        let reg = MetricsRegistry::new();
        let vec: IntCounterVec = reg.register(metric!(
            name: "test_metric",
            help: "a test metric",
            var_labels: ["dimension"]));

        let dims: &[&str] = &["one"];
        let metric_1 = vec.get_delete_on_drop_counter(dims);
        metric_1.inc();

        let metrics = reg.gather();
        assert_eq!(metrics.len(), 1);
        let reported_vec = &metrics[0];
        assert_eq!(reported_vec.get_name(), "test_metric");
        let dims = reported_vec.get_metric();
        assert_eq!(dims.len(), 1);
        assert_eq!(dims[0].get_label()[0].get_value(), "one");

        drop(metric_1);
        let metrics = reg.gather();
        assert_eq!(metrics.len(), 0);

        let string_labels: Vec<String> = ["owned"].iter().map(ToString::to_string).collect();
        struct Ownership {
            counter: DeleteOnDropCounter<'static, AtomicU64, Vec<String>>,
        }
        let metric_owned = Ownership {
            counter: vec.get_delete_on_drop_counter(string_labels),
        };
        metric_owned.counter.inc();

        let metrics = reg.gather();
        assert_eq!(metrics.len(), 1);
        let reported_vec = &metrics[0];
        assert_eq!(reported_vec.get_name(), "test_metric");
        let dims = reported_vec.get_metric();
        assert_eq!(dims.len(), 1);
        assert_eq!(dims[0].get_label()[0].get_value(), "owned");

        drop(metric_owned);
        let metrics = reg.gather();
        assert_eq!(metrics.len(), 0);
    }

    #[crate::test]
    fn dropping_gauges() {
        let reg = MetricsRegistry::new();
        let vec: IntGaugeVec = reg.register(metric!(
            name: "test_metric",
            help: "a test metric",
            var_labels: ["dimension"]));

        let dims: &[&str] = &["one"];
        let metric_1 = vec.get_delete_on_drop_gauge(dims);
        metric_1.set(666);

        let metrics = reg.gather();
        assert_eq!(metrics.len(), 1);
        let reported_vec = &metrics[0];
        assert_eq!(reported_vec.get_name(), "test_metric");
        let dims = reported_vec.get_metric();
        assert_eq!(dims.len(), 1);
        assert_eq!(dims[0].get_label()[0].get_value(), "one");

        drop(metric_1);
        let metrics = reg.gather();
        assert_eq!(metrics.len(), 0);

        let string_labels: Vec<String> = ["owned"].iter().map(ToString::to_string).collect();
        struct Ownership {
            gauge: DeleteOnDropGauge<'static, AtomicI64, Vec<String>>,
        }
        let metric_owned = Ownership {
            gauge: vec.get_delete_on_drop_gauge(string_labels),
        };
        metric_owned.gauge.set(666);

        let metrics = reg.gather();
        assert_eq!(metrics.len(), 1);
        let reported_vec = &metrics[0];
        assert_eq!(reported_vec.get_name(), "test_metric");
        let dims = reported_vec.get_metric();
        assert_eq!(dims.len(), 1);
        assert_eq!(dims[0].get_label()[0].get_value(), "owned");

        drop(metric_owned);
        let metrics = reg.gather();
        assert_eq!(metrics.len(), 0);
    }
}