risingwave_common_metrics/
gauge_ext.rs

1// Copyright 2025 RisingWave Labs
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use prometheus::IntGauge;
16use prometheus::core::{AtomicU64, GenericGauge};
17
18/// The integer version of [`prometheus::Gauge`]. Provides better performance if metric values are
19/// all unsigned integers.
20pub type UintGauge = GenericGauge<AtomicU64>;
21
22#[easy_ext::ext(IntGaugeExt)]
23impl IntGauge {
24    /// Increment the gauge, and return a guard that will decrement the gauge when dropped.
25    pub fn inc_guard(&self) -> impl Drop + '_ {
26        struct Guard<'a> {
27            gauge: &'a IntGauge,
28        }
29
30        impl<'a> Guard<'a> {
31            fn create(gauge: &'a IntGauge) -> Self {
32                gauge.inc();
33                Self { gauge }
34            }
35        }
36
37        impl Drop for Guard<'_> {
38            fn drop(&mut self) {
39                self.gauge.dec();
40            }
41        }
42
43        Guard::create(self)
44    }
45}
46
47#[easy_ext::ext(UintGaugeExt)]
48impl UintGauge {
49    /// Increment the gauge, and return a guard that will decrement the gauge when dropped.
50    pub fn inc_guard(&self) -> impl Drop + '_ {
51        struct Guard<'a> {
52            gauge: &'a UintGauge,
53        }
54
55        impl<'a> Guard<'a> {
56            fn create(gauge: &'a UintGauge) -> Self {
57                gauge.inc();
58                Self { gauge }
59            }
60        }
61
62        impl Drop for Guard<'_> {
63            fn drop(&mut self) {
64                self.gauge.dec();
65            }
66        }
67
68        Guard::create(self)
69    }
70}
risingwave_common_metrics/gauge_ext.rs

risingwave_common_metrics/
gauge_ext.rs
