-
Notifications
You must be signed in to change notification settings - Fork 451
/
types_options.go
409 lines (333 loc) · 12.2 KB
/
types_options.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
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
// Copyright (c) 2017 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package aggregation
import (
"bytes"
"strconv"
"strings"
"github.com/m3db/m3/src/metrics/metric"
"github.com/m3db/m3/src/x/pool"
)
// QuantileTypeStringFn returns the type string for a quantile value.
type QuantileTypeStringFn func(quantile float64) []byte
// TypeStringTransformFn transforms the type string.
type TypeStringTransformFn func(typeString []byte) []byte
// TypesOptions provides a set of options for aggregation types.
type TypesOptions interface {
// Read-Write methods.
// SetDefaultCounterAggregationTypes sets the default aggregation types for counters.
SetDefaultCounterAggregationTypes(value Types) TypesOptions
// DefaultCounterAggregationTypes returns the default aggregation types for counters.
DefaultCounterAggregationTypes() Types
// SetDefaultTimerAggregationTypes sets the default aggregation types for timers.
SetDefaultTimerAggregationTypes(value Types) TypesOptions
// DefaultTimerAggregationTypes returns the default aggregation types for timers.
DefaultTimerAggregationTypes() Types
// SetDefaultGaugeAggregationTypes sets the default aggregation types for gauges.
SetDefaultGaugeAggregationTypes(value Types) TypesOptions
// DefaultGaugeAggregationTypes returns the default aggregation types for gauges.
DefaultGaugeAggregationTypes() Types
// SetQuantileTypeStringFn sets the quantile type string function for timers.
SetQuantileTypeStringFn(value QuantileTypeStringFn) TypesOptions
// QuantileTypeStringFn returns the quantile type string function for timers.
QuantileTypeStringFn() QuantileTypeStringFn
// SetCounterTypeStringTransformFn sets the transformation function for counter type strings.
SetCounterTypeStringTransformFn(value TypeStringTransformFn) TypesOptions
// CounterTypeStringTransformFn returns the transformation function for counter type strings.
CounterTypeStringTransformFn() TypeStringTransformFn
// SetTimerTypeStringTransformFn sets the transformation function for timer type strings.
SetTimerTypeStringTransformFn(value TypeStringTransformFn) TypesOptions
// TimerTypeStringTransformFn returns the transformation function for timer type strings.
TimerTypeStringTransformFn() TypeStringTransformFn
// SetGaugeTypeStringTransformFn sets the transformation function for gauge type strings.
SetGaugeTypeStringTransformFn(value TypeStringTransformFn) TypesOptions
// GaugeTypeStringTransformFn returns the transformation function for gauge type strings.
GaugeTypeStringTransformFn() TypeStringTransformFn
// SetTypesPool sets the aggregation types pool.
SetTypesPool(pool TypesPool) TypesOptions
// TypesPool returns the aggregation types pool.
TypesPool() TypesPool
// SetQuantilesPool sets the timer quantiles pool.
SetQuantilesPool(pool pool.FloatsPool) TypesOptions
// QuantilesPool returns the timer quantiles pool.
QuantilesPool() pool.FloatsPool
// Read only methods.
// TypeStringForCounter returns the type string for the aggregation type for counters.
TypeStringForCounter(value Type) []byte
// TypeStringForTimer returns the type string for the aggregation type for timers.
TypeStringForTimer(value Type) []byte
// TypeStringForGauge returns the type string for the aggregation type for gauges.
TypeStringForGauge(value Type) []byte
// TypeForCounter returns the aggregation type for given counter type string.
TypeForCounter(value []byte) Type
// TypeForTimer returns the aggregation type for given timer type string.
TypeForTimer(value []byte) Type
// TypeForGauge returns the aggregation type for given gauge type string.
TypeForGauge(value []byte) Type
// Quantiles returns the quantiles for timers.
Quantiles() []float64
// IsContainedInDefaultAggregationTypes checks if the given aggregation type is
// contained in the default aggregation types for the metric type.
IsContainedInDefaultAggregationTypes(at Type, mt metric.Type) bool
}
var (
defaultDefaultCounterAggregationTypes = Types{
Sum,
}
defaultDefaultTimerAggregationTypes = Types{
Sum,
SumSq,
Mean,
Min,
Max,
Count,
Stdev,
Median,
P50,
P95,
P99,
}
defaultDefaultGaugeAggregationTypes = Types{
Last,
}
defaultTypeStringsMap = map[Type][]byte{
Last: []byte("last"),
Sum: []byte("sum"),
SumSq: []byte("sum_sq"),
Mean: []byte("mean"),
Min: []byte("lower"),
Max: []byte("upper"),
Count: []byte("count"),
Stdev: []byte("stdev"),
Median: []byte("median"),
}
)
type options struct {
defaultCounterAggregationTypes Types
defaultTimerAggregationTypes Types
defaultGaugeAggregationTypes Types
quantileTypeStringFn QuantileTypeStringFn
counterTypeStringTransformFn TypeStringTransformFn
timerTypeStringTransformFn TypeStringTransformFn
gaugeTypeStringTransformFn TypeStringTransformFn
aggTypesPool TypesPool
quantilesPool pool.FloatsPool
counterTypeStrings [][]byte
timerTypeStrings [][]byte
gaugeTypeStrings [][]byte
quantiles []float64
}
// NewTypesOptions returns a default TypesOptions.
func NewTypesOptions() TypesOptions {
o := &options{
defaultCounterAggregationTypes: defaultDefaultCounterAggregationTypes,
defaultGaugeAggregationTypes: defaultDefaultGaugeAggregationTypes,
defaultTimerAggregationTypes: defaultDefaultTimerAggregationTypes,
quantileTypeStringFn: defaultQuantileTypeStringFn,
counterTypeStringTransformFn: NoOpTransform,
timerTypeStringTransformFn: NoOpTransform,
gaugeTypeStringTransformFn: NoOpTransform,
}
o.initPools()
o.computeAllDerived()
return o
}
func (o *options) initPools() {
o.aggTypesPool = NewTypesPool(nil)
o.aggTypesPool.Init(func() Types {
return make(Types, 0, len(ValidTypes))
})
o.quantilesPool = pool.NewFloatsPool(nil, nil)
o.quantilesPool.Init()
}
func (o *options) SetDefaultCounterAggregationTypes(aggTypes Types) TypesOptions {
opts := *o
opts.defaultCounterAggregationTypes = aggTypes
opts.computeAllDerived()
return &opts
}
func (o *options) DefaultCounterAggregationTypes() Types {
return o.defaultCounterAggregationTypes
}
func (o *options) SetDefaultTimerAggregationTypes(aggTypes Types) TypesOptions {
opts := *o
opts.defaultTimerAggregationTypes = aggTypes
opts.computeAllDerived()
return &opts
}
func (o *options) DefaultTimerAggregationTypes() Types {
return o.defaultTimerAggregationTypes
}
func (o *options) SetDefaultGaugeAggregationTypes(aggTypes Types) TypesOptions {
opts := *o
opts.defaultGaugeAggregationTypes = aggTypes
opts.computeAllDerived()
return &opts
}
func (o *options) DefaultGaugeAggregationTypes() Types {
return o.defaultGaugeAggregationTypes
}
func (o *options) SetQuantileTypeStringFn(value QuantileTypeStringFn) TypesOptions {
opts := *o
opts.quantileTypeStringFn = value
opts.computeAllDerived()
return &opts
}
func (o *options) QuantileTypeStringFn() QuantileTypeStringFn {
return o.quantileTypeStringFn
}
func (o *options) SetCounterTypeStringTransformFn(value TypeStringTransformFn) TypesOptions {
opts := *o
opts.counterTypeStringTransformFn = value
opts.computeAllDerived()
return &opts
}
func (o *options) CounterTypeStringTransformFn() TypeStringTransformFn {
return o.counterTypeStringTransformFn
}
func (o *options) SetTimerTypeStringTransformFn(value TypeStringTransformFn) TypesOptions {
opts := *o
opts.timerTypeStringTransformFn = value
opts.computeAllDerived()
return &opts
}
func (o *options) TimerTypeStringTransformFn() TypeStringTransformFn {
return o.timerTypeStringTransformFn
}
func (o *options) SetGaugeTypeStringTransformFn(value TypeStringTransformFn) TypesOptions {
opts := *o
opts.gaugeTypeStringTransformFn = value
opts.computeAllDerived()
return &opts
}
func (o *options) GaugeTypeStringTransformFn() TypeStringTransformFn {
return o.gaugeTypeStringTransformFn
}
func (o *options) SetTypesPool(pool TypesPool) TypesOptions {
opts := *o
opts.aggTypesPool = pool
return &opts
}
func (o *options) TypesPool() TypesPool {
return o.aggTypesPool
}
func (o *options) SetQuantilesPool(pool pool.FloatsPool) TypesOptions {
opts := *o
opts.quantilesPool = pool
return &opts
}
func (o *options) QuantilesPool() pool.FloatsPool {
return o.quantilesPool
}
func (o *options) TypeStringForCounter(aggType Type) []byte {
return o.counterTypeStrings[aggType.ID()]
}
func (o *options) TypeStringForTimer(aggType Type) []byte {
return o.timerTypeStrings[aggType.ID()]
}
func (o *options) TypeStringForGauge(aggType Type) []byte {
return o.gaugeTypeStrings[aggType.ID()]
}
func (o *options) TypeForCounter(value []byte) Type {
return typeFor(value, o.counterTypeStrings)
}
func (o *options) TypeForTimer(value []byte) Type {
return typeFor(value, o.timerTypeStrings)
}
func (o *options) TypeForGauge(value []byte) Type {
return typeFor(value, o.gaugeTypeStrings)
}
func (o *options) Quantiles() []float64 {
return o.quantiles
}
func (o *options) IsContainedInDefaultAggregationTypes(at Type, mt metric.Type) bool {
var aggTypes Types
switch mt {
case metric.CounterType:
aggTypes = o.DefaultCounterAggregationTypes()
case metric.GaugeType:
aggTypes = o.DefaultGaugeAggregationTypes()
case metric.TimerType:
aggTypes = o.DefaultTimerAggregationTypes()
}
return aggTypes.Contains(at)
}
func (o *options) computeAllDerived() {
o.computeQuantiles()
o.computeCounterTypeStrings()
o.computeTimerTypeStrings()
o.computeGaugeTypeStrings()
}
func (o *options) computeQuantiles() {
o.quantiles, _ = o.DefaultTimerAggregationTypes().PooledQuantiles(o.QuantilesPool())
}
func (o *options) computeCounterTypeStrings() {
o.counterTypeStrings = o.computeTypeStrings(o.counterTypeStringTransformFn)
}
func (o *options) computeTimerTypeStrings() {
o.timerTypeStrings = o.computeTypeStrings(o.timerTypeStringTransformFn)
}
func (o *options) computeGaugeTypeStrings() {
o.gaugeTypeStrings = o.computeTypeStrings(o.gaugeTypeStringTransformFn)
}
func (o *options) computeTypeStrings(transformFn TypeStringTransformFn) [][]byte {
res := make([][]byte, maxTypeID+1)
for aggType := range ValidTypes {
var typeString []byte
if typeStr, exist := defaultTypeStringsMap[aggType]; exist {
typeString = typeStr
} else {
q, ok := aggType.Quantile()
if ok {
typeString = o.quantileTypeStringFn(q)
}
}
transformed := transformFn(typeString)
res[aggType.ID()] = transformed
}
return res
}
func typeFor(value []byte, typeStrings [][]byte) Type {
for id, typeString := range typeStrings {
if !bytes.Equal(value, typeString) {
continue
}
if t := Type(id); t.IsValid() {
return t
}
}
return UnknownType
}
// By default we use e.g. "p50", "p95", "p99" for the 50th/95th/99th percentile.
func defaultQuantileTypeStringFn(quantile float64) []byte {
str := strconv.FormatFloat(quantile*100, 'f', -1, 64)
idx := strings.Index(str, ".")
if idx != -1 {
str = str[:idx] + str[idx+1:]
}
return []byte("p" + str)
}
// NoOpTransform returns the input byte slice as is.
func NoOpTransform(b []byte) []byte { return b }
// EmptyTransform transforms the input byte slice to an empty byte slice.
func EmptyTransform(b []byte) []byte { return nil }
// SuffixTransform transforms the input byte slice to a suffix by prepending
// a dot at the beginning.
func SuffixTransform(b []byte) []byte { return append([]byte("."), b...) }