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
|
// Copyright (c) 2021 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 tally
import "time"
// BaseStatsReporter implements the shared reporter methods.
type BaseStatsReporter interface {
// Capabilities returns the capabilities description of the reporter.
Capabilities() Capabilities
// Flush asks the reporter to flush all reported values.
Flush()
}
// StatsReporter is a backend for Scopes to report metrics to.
type StatsReporter interface {
BaseStatsReporter
// ReportCounter reports a counter value
ReportCounter(
name string,
tags map[string]string,
value int64,
)
// ReportGauge reports a gauge value
ReportGauge(
name string,
tags map[string]string,
value float64,
)
// ReportTimer reports a timer value
ReportTimer(
name string,
tags map[string]string,
interval time.Duration,
)
// ReportHistogramValueSamples reports histogram samples for a bucket
ReportHistogramValueSamples(
name string,
tags map[string]string,
buckets Buckets,
bucketLowerBound,
bucketUpperBound float64,
samples int64,
)
// ReportHistogramDurationSamples reports histogram samples for a bucket
ReportHistogramDurationSamples(
name string,
tags map[string]string,
buckets Buckets,
bucketLowerBound,
bucketUpperBound time.Duration,
samples int64,
)
}
// CachedStatsReporter is a backend for Scopes that pre allocates all
// counter, gauges, timers & histograms. This is harder to implement but more performant.
type CachedStatsReporter interface {
BaseStatsReporter
// AllocateCounter pre allocates a counter data structure with name & tags.
AllocateCounter(
name string,
tags map[string]string,
) CachedCount
// AllocateGauge pre allocates a gauge data structure with name & tags.
AllocateGauge(
name string,
tags map[string]string,
) CachedGauge
// AllocateTimer pre allocates a timer data structure with name & tags.
AllocateTimer(
name string,
tags map[string]string,
) CachedTimer
// AllocateHistogram pre allocates a histogram data structure with name, tags,
// value buckets and duration buckets.
AllocateHistogram(
name string,
tags map[string]string,
buckets Buckets,
) CachedHistogram
}
// CachedCount interface for reporting an individual counter
type CachedCount interface {
ReportCount(value int64)
}
// CachedGauge interface for reporting an individual gauge
type CachedGauge interface {
ReportGauge(value float64)
}
// CachedTimer interface for reporting an individual timer
type CachedTimer interface {
ReportTimer(interval time.Duration)
}
// CachedHistogram interface for reporting histogram samples to buckets
type CachedHistogram interface {
ValueBucket(
bucketLowerBound, bucketUpperBound float64,
) CachedHistogramBucket
DurationBucket(
bucketLowerBound, bucketUpperBound time.Duration,
) CachedHistogramBucket
}
// CachedHistogramBucket interface for reporting histogram samples to a specific bucket
type CachedHistogramBucket interface {
ReportSamples(value int64)
}
|
