forked from go-kit/kit
/
providers.go
259 lines (213 loc) · 7.77 KB
/
providers.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
package provider
import (
"errors"
"time"
"github.com/prometheus/client_golang/prometheus"
"github.com/go-kit/kit/log"
"github.com/go-kit/kit/metrics"
"github.com/go-kit/kit/metrics/discard"
"github.com/go-kit/kit/metrics/dogstatsd"
kitexp "github.com/go-kit/kit/metrics/expvar"
"github.com/go-kit/kit/metrics/graphite"
kitprom "github.com/go-kit/kit/metrics/prometheus"
"github.com/go-kit/kit/metrics/statsd"
)
// Provider represents a union set of constructors and lifecycle management
// functions for each supported metrics backend. It should be used by those who
// need to easily swap out implementations, e.g. dynamically, or at a single
// point in an intermediating framework.
type Provider interface {
NewCounter(name, help string) metrics.Counter
NewHistogram(name, help string, min, max int64, sigfigs int, quantiles ...int) (metrics.Histogram, error)
NewGauge(name, help string) metrics.Gauge
Stop()
}
// NewGraphiteProvider will return a Provider implementation that is a simple
// wrapper around a graphite.Emitter. All metric names will be prefixed with the
// given value and data will be emitted once every interval. If no network value
// is given, it will default to "udp".
func NewGraphiteProvider(network, address, prefix string, interval time.Duration, logger log.Logger) (Provider, error) {
if network == "" {
network = "udp"
}
if address == "" {
return nil, errors.New("address is required")
}
return graphiteProvider{
e: graphite.NewEmitter(network, address, prefix, interval, logger),
}, nil
}
type graphiteProvider struct {
e *graphite.Emitter
}
var _ Provider = graphiteProvider{}
// NewCounter implements Provider. Help is ignored.
func (p graphiteProvider) NewCounter(name, _ string) metrics.Counter {
return p.e.NewCounter(name)
}
// NewHistogram implements Provider. Help is ignored.
func (p graphiteProvider) NewHistogram(name, _ string, min, max int64, sigfigs int, quantiles ...int) (metrics.Histogram, error) {
return p.e.NewHistogram(name, min, max, sigfigs, quantiles...)
}
// NewGauge implements Provider. Help is ignored.
func (p graphiteProvider) NewGauge(name, _ string) metrics.Gauge {
return p.e.NewGauge(name)
}
// Stop implements Provider.
func (p graphiteProvider) Stop() {
p.e.Stop()
}
// NewStatsdProvider will return a Provider implementation that is a simple
// wrapper around a statsd.Emitter. All metric names will be prefixed with the
// given value and data will be emitted once every interval or when the buffer
// has reached its max size. If no network value is given, it will default to
// "udp".
func NewStatsdProvider(network, address, prefix string, interval time.Duration, logger log.Logger) (Provider, error) {
if network == "" {
network = "udp"
}
if address == "" {
return nil, errors.New("address is required")
}
return statsdProvider{
e: statsd.NewEmitter(network, address, prefix, interval, logger),
}, nil
}
type statsdProvider struct {
e *statsd.Emitter
}
var _ Provider = statsdProvider{}
// NewCounter implements Provider. Help is ignored.
func (p statsdProvider) NewCounter(name, _ string) metrics.Counter {
return p.e.NewCounter(name)
}
// NewHistogram implements Provider. Help is ignored.
func (p statsdProvider) NewHistogram(name, _ string, min, max int64, sigfigs int, quantiles ...int) (metrics.Histogram, error) {
return p.e.NewHistogram(name), nil
}
// NewGauge implements Provider. Help is ignored.
func (p statsdProvider) NewGauge(name, _ string) metrics.Gauge {
return p.e.NewGauge(name)
}
// Stop will call the underlying statsd.Emitter's Stop method.
func (p statsdProvider) Stop() {
p.e.Stop()
}
// NewDogStatsdProvider will return a Provider implementation that is a simple
// wrapper around a dogstatsd.Emitter. All metric names will be prefixed with
// the given value and data will be emitted once every interval or when the
// buffer has reached its max size. If no network value is given, it will
// default to "udp".
func NewDogStatsdProvider(network, address, prefix string, interval time.Duration, logger log.Logger) (Provider, error) {
if network == "" {
network = "udp"
}
if address == "" {
return nil, errors.New("address is required")
}
return dogstatsdProvider{
e: dogstatsd.NewEmitter(network, address, prefix, interval, logger),
}, nil
}
type dogstatsdProvider struct {
e *dogstatsd.Emitter
}
var _ Provider = dogstatsdProvider{}
// NewCounter implements Provider. Help is ignored.
func (p dogstatsdProvider) NewCounter(name, _ string) metrics.Counter {
return p.e.NewCounter(name)
}
// NewHistogram implements Provider. Help is ignored.
func (p dogstatsdProvider) NewHistogram(name, _ string, min, max int64, sigfigs int, quantiles ...int) (metrics.Histogram, error) {
return p.e.NewHistogram(name), nil
}
// NewGauge implements Provider. Help is ignored.
func (p dogstatsdProvider) NewGauge(name, _ string) metrics.Gauge {
return p.e.NewGauge(name)
}
// Stop will call the underlying statsd.Emitter's Stop method.
func (p dogstatsdProvider) Stop() {
p.e.Stop()
}
// NewExpvarProvider is a very thin wrapper over the expvar package.
// If a prefix is provided, it will prefix all metric names.
func NewExpvarProvider(prefix string) Provider {
return expvarProvider{prefix: prefix}
}
type expvarProvider struct {
prefix string
}
var _ Provider = expvarProvider{}
// NewCounter implements Provider. Help is ignored.
func (p expvarProvider) NewCounter(name, _ string) metrics.Counter {
return kitexp.NewCounter(p.prefix + name)
}
// NewHistogram implements Provider. Help is ignored.
func (p expvarProvider) NewHistogram(name, _ string, min, max int64, sigfigs int, quantiles ...int) (metrics.Histogram, error) {
return kitexp.NewHistogram(p.prefix+name, min, max, sigfigs, quantiles...), nil
}
// NewGauge implements Provider. Help is ignored.
func (p expvarProvider) NewGauge(name, _ string) metrics.Gauge {
return kitexp.NewGauge(p.prefix + name)
}
// Stop is a no-op.
func (expvarProvider) Stop() {}
type prometheusProvider struct {
namespace string
subsystem string
}
var _ Provider = prometheusProvider{}
// NewPrometheusProvider returns a Prometheus provider that uses the provided
// namespace and subsystem for all metrics.
func NewPrometheusProvider(namespace, subsystem string) Provider {
return prometheusProvider{
namespace: namespace,
subsystem: subsystem,
}
}
// NewCounter implements Provider.
func (p prometheusProvider) NewCounter(name, help string) metrics.Counter {
return kitprom.NewCounter(prometheus.CounterOpts{
Namespace: p.namespace,
Subsystem: p.subsystem,
Name: name,
Help: help,
}, nil)
}
// NewHistogram ignores all parameters except name and help.
func (p prometheusProvider) NewHistogram(name, help string, _, _ int64, _ int, _ ...int) (metrics.Histogram, error) {
return kitprom.NewHistogram(prometheus.HistogramOpts{
Namespace: p.namespace,
Subsystem: p.subsystem,
Name: name,
Help: help,
}, nil), nil
}
// NewGauge implements Provider.
func (p prometheusProvider) NewGauge(name, help string) metrics.Gauge {
return kitprom.NewGauge(prometheus.GaugeOpts{
Namespace: p.namespace,
Subsystem: p.subsystem,
Name: name,
Help: help,
}, nil)
}
// Stop is a no-op.
func (prometheusProvider) Stop() {}
var _ Provider = discardProvider{}
// NewDiscardProvider returns a provider that will discard all metrics.
func NewDiscardProvider() Provider {
return discardProvider{}
}
type discardProvider struct{}
func (p discardProvider) NewCounter(name string, _ string) metrics.Counter {
return discard.NewCounter(name)
}
func (p discardProvider) NewHistogram(name string, _ string, _ int64, _ int64, _ int, _ ...int) (metrics.Histogram, error) {
return discard.NewHistogram(name), nil
}
func (p discardProvider) NewGauge(name string, _ string) metrics.Gauge {
return discard.NewGauge(name)
}
// Stop is a no-op.
func (p discardProvider) Stop() {}