-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
counters.go
381 lines (329 loc) · 9.71 KB
/
counters.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
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
/*
Copyright 2019 The Vitess Authors.
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 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.
*/
package stats
import (
"bytes"
"fmt"
"strings"
"sync"
)
// counters is similar to expvar.Map, except that it doesn't allow floats.
// It is used to build CountersWithSingleLabel and GaugesWithSingleLabel.
type counters struct {
mu sync.Mutex
counts map[string]int64
help string
}
func (c *counters) String() string {
c.mu.Lock()
defer c.mu.Unlock()
b := &strings.Builder{}
fmt.Fprintf(b, "{")
prefix := ""
for k, v := range c.counts {
fmt.Fprintf(b, "%s%q: %v", prefix, k, v)
prefix = ", "
}
fmt.Fprintf(b, "}")
return b.String()
}
func (c *counters) add(name string, value int64) {
c.mu.Lock()
defer c.mu.Unlock()
c.counts[name] = c.counts[name] + value
}
func (c *counters) set(name string, value int64) {
c.mu.Lock()
defer c.mu.Unlock()
c.counts[name] = value
}
func (c *counters) reset() {
c.mu.Lock()
defer c.mu.Unlock()
c.counts = make(map[string]int64)
}
// ZeroAll zeroes out all values
func (c *counters) ZeroAll() {
c.mu.Lock()
defer c.mu.Unlock()
for k := range c.counts {
c.counts[k] = 0
}
}
// Counts returns a copy of the Counters' map.
func (c *counters) Counts() map[string]int64 {
c.mu.Lock()
defer c.mu.Unlock()
counts := make(map[string]int64, len(c.counts))
for k, v := range c.counts {
counts[k] = v
}
return counts
}
// Help returns the help string.
func (c *counters) Help() string {
return c.help
}
// CountersWithSingleLabel tracks multiple counter values for a single
// dimension ("label").
// It provides a Counts method which can be used for tracking rates.
type CountersWithSingleLabel struct {
counters
label string
labelCombined bool
}
// NewCountersWithSingleLabel create a new Counters instance.
// If name is set, the variable gets published.
// The function also accepts an optional list of tags that pre-creates them
// initialized to 0.
// label is a category name used to organize the tags. It is currently only
// used by Prometheus, but not by the expvar package.
func NewCountersWithSingleLabel(name, help, label string, tags ...string) *CountersWithSingleLabel {
c := &CountersWithSingleLabel{
counters: counters{
counts: make(map[string]int64),
help: help,
},
label: label,
labelCombined: IsDimensionCombined(label),
}
if c.labelCombined {
c.counts[StatsAllStr] = 0
} else {
for _, tag := range tags {
c.counts[tag] = 0
}
}
if name != "" {
publish(name, c)
}
return c
}
// Label returns the label name.
func (c *CountersWithSingleLabel) Label() string {
return c.label
}
// Add adds a value to a named counter.
func (c *CountersWithSingleLabel) Add(name string, value int64) {
if c.labelCombined {
name = StatsAllStr
}
c.counters.add(name, value)
}
// Reset resets the value for the name.
func (c *CountersWithSingleLabel) Reset(name string) {
if c.labelCombined {
name = StatsAllStr
}
c.counters.set(name, 0)
}
// ResetAll clears the counters
func (c *CountersWithSingleLabel) ResetAll() {
c.counters.reset()
}
// CountersWithMultiLabels is a multidimensional counters implementation.
// Internally, each tuple of dimensions ("labels") is stored as a single
// label value where all label values are joined with ".".
type CountersWithMultiLabels struct {
counters
labels []string
combinedLabels []bool
}
// NewCountersWithMultiLabels creates a new CountersWithMultiLabels
// instance, and publishes it if name is set.
func NewCountersWithMultiLabels(name, help string, labels []string) *CountersWithMultiLabels {
t := &CountersWithMultiLabels{
counters: counters{
counts: make(map[string]int64),
help: help},
labels: labels,
combinedLabels: make([]bool, len(labels)),
}
for i, label := range labels {
t.combinedLabels[i] = IsDimensionCombined(label)
}
if name != "" {
publish(name, t)
}
return t
}
// Labels returns the list of labels.
func (mc *CountersWithMultiLabels) Labels() []string {
return mc.labels
}
// Add adds a value to a named counter.
// len(names) must be equal to len(Labels)
func (mc *CountersWithMultiLabels) Add(names []string, value int64) {
if len(names) != len(mc.labels) {
panic("CountersWithMultiLabels: wrong number of values in Add")
}
mc.counters.add(safeJoinLabels(names, mc.combinedLabels), value)
}
// Reset resets the value of a named counter back to 0.
// len(names) must be equal to len(Labels).
func (mc *CountersWithMultiLabels) Reset(names []string) {
if len(names) != len(mc.labels) {
panic("CountersWithMultiLabels: wrong number of values in Reset")
}
mc.counters.set(safeJoinLabels(names, mc.combinedLabels), 0)
}
// ResetAll clears the counters
func (mc *CountersWithMultiLabels) ResetAll() {
mc.counters.reset()
}
// Counts returns a copy of the Counters' map.
// The key is a single string where all labels are joined by a "." e.g.
// "label1.label2".
func (mc *CountersWithMultiLabels) Counts() map[string]int64 {
return mc.counters.Counts()
}
// CountersFuncWithMultiLabels is a multidimensional counters implementation
// where names of categories are compound names made with joining
// multiple strings with '.'. Since the map is returned by the
// function, we assume it's in the right format (meaning each key is
// of the form 'aaa.bbb.ccc' with as many elements as there are in
// Labels).
//
// Note that there is no CountersFuncWithSingleLabel object. That this
// because such an object would be identical to this one because these
// function-based counters have no Add() or Set() method which are different
// for the single vs. multiple labels cases.
// If you have only a single label, pass an array with a single element.
type CountersFuncWithMultiLabels struct {
f func() map[string]int64
help string
labels []string
}
// Labels returns the list of labels.
func (c CountersFuncWithMultiLabels) Labels() []string {
return c.labels
}
// Help returns the help string.
func (c CountersFuncWithMultiLabels) Help() string {
return c.help
}
// NewCountersFuncWithMultiLabels creates a new CountersFuncWithMultiLabels
// mapping to the provided function.
func NewCountersFuncWithMultiLabels(name, help string, labels []string, f func() map[string]int64) *CountersFuncWithMultiLabels {
t := &CountersFuncWithMultiLabels{
f: f,
help: help,
labels: labels,
}
if name != "" {
publish(name, t)
}
return t
}
// Counts returns a copy of the counters' map.
func (c CountersFuncWithMultiLabels) Counts() map[string]int64 {
return c.f()
}
// String implements the expvar.Var interface.
func (c CountersFuncWithMultiLabels) String() string {
m := c.f()
if m == nil {
return "{}"
}
b := bytes.NewBuffer(make([]byte, 0, 4096))
fmt.Fprintf(b, "{")
firstValue := true
for k, v := range m {
if firstValue {
firstValue = false
} else {
fmt.Fprintf(b, ", ")
}
fmt.Fprintf(b, "%q: %v", k, v)
}
fmt.Fprintf(b, "}")
return b.String()
}
// GaugesWithSingleLabel is similar to CountersWithSingleLabel, except its
// meant to track the current value and not a cumulative count.
type GaugesWithSingleLabel struct {
CountersWithSingleLabel
}
// NewGaugesWithSingleLabel creates a new GaugesWithSingleLabel and
// publishes it if the name is set.
func NewGaugesWithSingleLabel(name, help, label string, tags ...string) *GaugesWithSingleLabel {
g := &GaugesWithSingleLabel{
CountersWithSingleLabel: CountersWithSingleLabel{
counters: counters{
counts: make(map[string]int64),
help: help,
},
label: label,
},
}
for _, tag := range tags {
g.counts[tag] = 0
}
if name != "" {
publish(name, g)
}
return g
}
// Set sets the value of a named gauge.
func (g *GaugesWithSingleLabel) Set(name string, value int64) {
g.counters.set(name, value)
}
// GaugesWithMultiLabels is a CountersWithMultiLabels implementation where
// the values can go up and down.
type GaugesWithMultiLabels struct {
CountersWithMultiLabels
}
// NewGaugesWithMultiLabels creates a new GaugesWithMultiLabels instance,
// and publishes it if name is set.
func NewGaugesWithMultiLabels(name, help string, labels []string) *GaugesWithMultiLabels {
t := &GaugesWithMultiLabels{
CountersWithMultiLabels: CountersWithMultiLabels{
counters: counters{
counts: make(map[string]int64),
help: help,
},
labels: labels,
}}
if name != "" {
publish(name, t)
}
return t
}
// Set sets the value of a named counter.
// len(names) must be equal to len(Labels).
func (mg *GaugesWithMultiLabels) Set(names []string, value int64) {
if len(names) != len(mg.CountersWithMultiLabels.labels) {
panic("GaugesWithMultiLabels: wrong number of values in Set")
}
mg.counters.set(safeJoinLabels(names, nil), value)
}
// GaugesFuncWithMultiLabels is a wrapper around CountersFuncWithMultiLabels
// for values that go up/down for implementations (like Prometheus) that
// need to differ between Counters and Gauges.
type GaugesFuncWithMultiLabels struct {
CountersFuncWithMultiLabels
}
// NewGaugesFuncWithMultiLabels creates a new GaugesFuncWithMultiLabels
// mapping to the provided function.
func NewGaugesFuncWithMultiLabels(name, help string, labels []string, f func() map[string]int64) *GaugesFuncWithMultiLabels {
t := &GaugesFuncWithMultiLabels{
CountersFuncWithMultiLabels: CountersFuncWithMultiLabels{
f: f,
help: help,
labels: labels,
}}
if name != "" {
publish(name, t)
}
return t
}