/
methods.go
174 lines (151 loc) · 5.16 KB
/
methods.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
// Copyright (c) 2016 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 instrument
import (
"fmt"
"sync/atomic"
"time"
"github.com/uber-go/tally"
)
var (
nullStopWatchStart tally.Stopwatch
)
// sampledTimer is a sampled timer that implements the tally timer interface.
// NB(xichen): the sampling logic should eventually be implemented in tally.
type sampledTimer struct {
tally.Timer
cnt uint64
rate uint64
}
// NewSampledTimer creates a new sampled timer.
func NewSampledTimer(base tally.Timer, rate float64) (tally.Timer, error) {
if rate <= 0.0 || rate > 1.0 {
return nil, fmt.Errorf("sampling rate %f must be between 0.0 and 1.0", rate)
}
return &sampledTimer{
Timer: base,
rate: uint64(1.0 / rate),
}, nil
}
// MustCreateSampledTimer creates a new sampled timer, and panics if an error
// is encountered.
func MustCreateSampledTimer(base tally.Timer, rate float64) tally.Timer {
t, err := NewSampledTimer(base, rate)
if err != nil {
panic(err)
}
return t
}
func (t *sampledTimer) shouldSample() bool {
return atomic.AddUint64(&t.cnt, 1)%t.rate == 0
}
func (t *sampledTimer) Start() tally.Stopwatch {
if !t.shouldSample() {
return nullStopWatchStart
}
return t.Timer.Start()
}
func (t *sampledTimer) Stop(startTime tally.Stopwatch) {
if startTime == nullStopWatchStart { // nolint: badtime
// If startTime is nullStopWatchStart, do nothing.
return
}
startTime.Stop()
}
func (t *sampledTimer) Record(d time.Duration) {
if !t.shouldSample() {
return
}
t.Timer.Record(d)
}
// MethodMetrics is a bundle of common metrics with a uniform naming scheme.
type MethodMetrics struct {
Errors tally.Counter
Success tally.Counter
ErrorsLatency tally.Timer
SuccessLatency tally.Timer
}
// ReportSuccess reports a success.
func (m *MethodMetrics) ReportSuccess(d time.Duration) {
m.Success.Inc(1)
m.SuccessLatency.Record(d)
}
// ReportError reports an error.
func (m *MethodMetrics) ReportError(d time.Duration) {
m.Errors.Inc(1)
m.ErrorsLatency.Record(d)
}
// ReportSuccessOrError increments Error/Success counter dependending on the error.
func (m *MethodMetrics) ReportSuccessOrError(e error, d time.Duration) {
if e != nil {
m.ReportError(d)
} else {
m.ReportSuccess(d)
}
}
// NewMethodMetrics returns a new Method metrics for the given method name.
func NewMethodMetrics(scope tally.Scope, methodName string, samplingRate float64) MethodMetrics {
return MethodMetrics{
Errors: scope.Counter(methodName + ".errors"),
Success: scope.Counter(methodName + ".success"),
ErrorsLatency: MustCreateSampledTimer(scope.Timer(methodName+".errors-latency"), samplingRate),
SuccessLatency: MustCreateSampledTimer(scope.Timer(methodName+".success-latency"), samplingRate),
}
}
// BatchMethodMetrics is a bundle of common metrics for methods with batch semantics.
type BatchMethodMetrics struct {
RetryableErrors tally.Counter
NonRetryableErrors tally.Counter
Errors tally.Counter
Success tally.Counter
Latency tally.Timer
}
// NewBatchMethodMetrics creates new batch method metrics.
func NewBatchMethodMetrics(
scope tally.Scope,
methodName string,
samplingRate float64,
) BatchMethodMetrics {
return BatchMethodMetrics{
RetryableErrors: scope.Counter(methodName + ".retryable-errors"),
NonRetryableErrors: scope.Counter(methodName + ".non-retryable-errors"),
Errors: scope.Counter(methodName + ".errors"),
Success: scope.Counter(methodName + ".success"),
Latency: MustCreateSampledTimer(scope.Timer(methodName+".latency"), samplingRate),
}
}
// ReportSuccess reports successess.
func (m *BatchMethodMetrics) ReportSuccess(n int) {
m.Success.Inc(int64(n))
}
// ReportRetryableErrors reports retryable errors.
func (m *BatchMethodMetrics) ReportRetryableErrors(n int) {
m.RetryableErrors.Inc(int64(n))
m.Errors.Inc(int64(n))
}
// ReportNonRetryableErrors reports non-retryable errors.
func (m *BatchMethodMetrics) ReportNonRetryableErrors(n int) {
m.NonRetryableErrors.Inc(int64(n))
m.Errors.Inc(int64(n))
}
// ReportLatency reports latency.
func (m *BatchMethodMetrics) ReportLatency(d time.Duration) {
m.Latency.Record(d)
}