-
Notifications
You must be signed in to change notification settings - Fork 2.7k
/
gauge.go
267 lines (232 loc) · 5.55 KB
/
gauge.go
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
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Cilium
package metric
import (
"github.com/prometheus/client_golang/prometheus"
dto "github.com/prometheus/client_model/go"
)
func NewGauge(opts GaugeOpts) Gauge {
return &gauge{
Gauge: prometheus.NewGauge(opts.toPrometheus()),
metric: metric{
enabled: !opts.Disabled,
opts: Opts(opts),
},
}
}
type Gauge interface {
prometheus.Gauge
WithMetadata
Get() float64
}
type gauge struct {
prometheus.Gauge
metric
}
func (g *gauge) Collect(metricChan chan<- prometheus.Metric) {
if g.enabled {
g.Gauge.Collect(metricChan)
}
}
func (g *gauge) Get() float64 {
if !g.enabled {
return 0
}
var pm dto.Metric
err := g.Gauge.Write(&pm)
if err == nil {
return *pm.Gauge.Value
}
return 0
}
// Set sets the Gauge to an arbitrary value.
func (g *gauge) Set(val float64) {
if g.enabled {
g.Gauge.Set(val)
}
}
// Inc increments the Gauge by 1. Use Add to increment it by arbitrary
// values.
func (g *gauge) Inc() {
if g.enabled {
g.Gauge.Inc()
}
}
// Dec decrements the Gauge by 1. Use Sub to decrement it by arbitrary
// values.
func (g *gauge) Dec() {
if g.enabled {
g.Gauge.Dec()
}
}
// Add adds the given value to the Gauge. (The value can be negative,
// resulting in a decrease of the Gauge.)
func (g *gauge) Add(val float64) {
if g.enabled {
g.Gauge.Add(val)
}
}
// Sub subtracts the given value from the Gauge. (The value can be
// negative, resulting in an increase of the Gauge.)
func (g *gauge) Sub(i float64) {
if g.enabled {
g.Gauge.Sub(i)
}
}
// SetToCurrentTime sets the Gauge to the current Unix time in seconds.
func (g *gauge) SetToCurrentTime() {
if g.enabled {
g.Gauge.SetToCurrentTime()
}
}
// NewGaugeVec creates a new DeletableVec[Gauge] based on the provided GaugeOpts and
// partitioned by the given label names.
func NewGaugeVec(opts GaugeOpts, labelNames []string) *gaugeVec {
gv := &gaugeVec{
GaugeVec: prometheus.NewGaugeVec(opts.toPrometheus(), labelNames),
metric: metric{
enabled: !opts.Disabled,
opts: Opts(opts),
},
}
return gv
}
// NewGaugeVecWithLabels creates a new DeletableVec[Gauge] based on the provided CounterOpts and
// partitioned by the given labels.
// This will also initialize the labels with the provided values so that metrics with known label value
// ranges can be pre-initialized to zero upon init.
//
// This should only be used when all label values are known at init, otherwise use of the
// metric vector with uninitialized labels will result in warnings.
//
// Note: Disabled metrics will not have their label values initialized.
//
// For example:
//
// NewGaugeVecWithLabels(GaugeOpts{
// Namespace: "cilium",
// Subsystem: "subsystem",
// Name: "cilium_test",
// Disabled: false,
// }, Labels{
// {Name: "foo", Values: NewValues("0", "1")},
// {Name: "bar", Values: NewValues("a", "b")},
// })
//
// Will initialize the following metrics to:
//
// cilium_subsystem_cilium_test{foo="0", bar="a"} 0
// cilium_subsystem_cilium_test{foo="0", bar="b"} 0
// cilium_subsystem_cilium_test{foo="1", bar="a"} 0
// cilium_subsystem_cilium_test{foo="1", bar="b"} 0
func NewGaugeVecWithLabels(opts GaugeOpts, labels Labels) *gaugeVec {
gv := NewGaugeVec(opts, labels.labelNames())
initLabels[Gauge](&gv.metric, labels, gv, opts.Disabled)
return gv
}
type gaugeVec struct {
*prometheus.GaugeVec
metric
}
func (gv *gaugeVec) CurryWith(labels prometheus.Labels) (Vec[Gauge], error) {
gv.checkLabels(labels)
vec, err := gv.GaugeVec.CurryWith(labels)
if err == nil {
return &gaugeVec{GaugeVec: vec, metric: gv.metric}, nil
}
return nil, err
}
func (gv *gaugeVec) GetMetricWith(labels prometheus.Labels) (Gauge, error) {
if !gv.enabled {
return &gauge{
metric: metric{enabled: false},
}, nil
}
promGauge, err := gv.GaugeVec.GetMetricWith(labels)
if err == nil {
return &gauge{
Gauge: promGauge,
metric: gv.metric,
}, nil
}
return nil, err
}
func (gv *gaugeVec) GetMetricWithLabelValues(lvs ...string) (Gauge, error) {
if !gv.enabled {
return &gauge{
metric: metric{enabled: false},
}, nil
}
promGauge, err := gv.GaugeVec.GetMetricWithLabelValues(lvs...)
if err == nil {
return &gauge{
Gauge: promGauge,
metric: gv.metric,
}, nil
}
return nil, err
}
func (gv *gaugeVec) With(labels prometheus.Labels) Gauge {
if !gv.enabled {
return &gauge{
metric: metric{enabled: false},
}
}
gv.checkLabels(labels)
promGauge := gv.GaugeVec.With(labels)
return &gauge{
Gauge: promGauge,
metric: gv.metric,
}
}
func (gv *gaugeVec) WithLabelValues(lvs ...string) Gauge {
gv.checkLabelValues(lvs...)
if !gv.enabled {
return &gauge{
metric: metric{enabled: false},
}
}
promGauge := gv.GaugeVec.WithLabelValues(lvs...)
return &gauge{
Gauge: promGauge,
metric: gv.metric,
}
}
func (gv *gaugeVec) SetEnabled(e bool) {
if !e {
gv.Reset()
}
gv.metric.SetEnabled(e)
}
type GaugeFunc interface {
prometheus.GaugeFunc
WithMetadata
}
func NewGaugeFunc(opts GaugeOpts, function func() float64) GaugeFunc {
return &gaugeFunc{
GaugeFunc: prometheus.NewGaugeFunc(opts.toPrometheus(), function),
metric: metric{
enabled: !opts.Disabled,
opts: Opts(opts),
},
}
}
type gaugeFunc struct {
prometheus.GaugeFunc
metric
}
func (gf *gaugeFunc) Collect(metricChan chan<- prometheus.Metric) {
if gf.enabled {
gf.GaugeFunc.Collect(metricChan)
}
}
type GaugeOpts Opts
func (o GaugeOpts) toPrometheus() prometheus.GaugeOpts {
return prometheus.GaugeOpts{
Namespace: o.Namespace,
Subsystem: o.Subsystem,
Name: o.Name,
Help: o.Help,
ConstLabels: o.ConstLabels,
}
}