forked from easyCZ/connect-go-prometheus
-
Notifications
You must be signed in to change notification settings - Fork 1
/
metrics.go
356 lines (318 loc) · 11.1 KB
/
metrics.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
package connect_go_prometheus
import (
prom "github.com/prometheus/client_golang/prometheus"
)
var (
DefaultClientMetrics = NewClientMetrics()
DefaultServerMetrics = NewServerMetrics()
)
func init() {
// Register default metrics against default prometheus metrics registry.
prom.MustRegister(DefaultServerMetrics)
prom.MustRegister(DefaultClientMetrics)
}
// NewServerMetrics creates new Connect metrics for server-side handling.
func NewServerMetrics(opts ...MetricsOption) *Metrics {
config := evaluateMetricsOptions(&metricsOptions{
histogramBuckets: prom.DefBuckets,
requestStartedName: "connect_server_started_total",
requestHandledName: "connect_server_handled_total",
requestHandledSecondsName: "connect_server_handled_seconds",
streamMsgSentName: "connect_server_msg_sent_total",
streamMsgReceivedName: "connect_server_msg_received_total",
bytesSentName: "connect_server_bytes_sent_total",
bytesReceivedName: "connect_server_bytes_received_total",
inflightRequestsName: "connect_server_inflight_requests",
}, opts...)
m := &Metrics{
isClient: false,
requestStarted: prom.NewCounterVec(prom.CounterOpts{
Namespace: config.namespace,
Subsystem: config.subsystem,
ConstLabels: config.constLabels,
Name: config.requestStartedName,
Help: "Total number of RPCs started handling server-side",
}, []string{"type", "service", "method"}),
requestHandled: prom.NewCounterVec(prom.CounterOpts{
Namespace: config.namespace,
Subsystem: config.subsystem,
ConstLabels: config.constLabels,
Name: config.requestHandledName,
Help: "Total number of RPCs handled server-side",
}, []string{"type", "service", "method", "code"}),
streamMsgSent: prom.NewCounterVec(prom.CounterOpts{
Namespace: config.namespace,
Subsystem: config.subsystem,
ConstLabels: config.constLabels,
Name: config.streamMsgSentName,
Help: "Total number of stream messages sent by server-side",
}, []string{"type", "service", "method"}),
streamMsgReceived: prom.NewCounterVec(prom.CounterOpts{
Namespace: config.namespace,
Subsystem: config.subsystem,
ConstLabels: config.constLabels,
Name: config.streamMsgReceivedName,
Help: "Total number of stream messages received by server-side",
}, []string{"type", "service", "method"}),
}
if config.withHistogram {
m.requestHandledSeconds = prom.NewHistogramVec(prom.HistogramOpts{
Namespace: config.namespace,
Subsystem: config.subsystem,
ConstLabels: config.constLabels,
Name: config.requestHandledSecondsName,
Help: "Histogram of RPCs handled server-side",
Buckets: config.histogramBuckets,
}, []string{"type", "service", "method", "code"})
}
if config.withByteMetrics {
m.bytesSent = prom.NewCounterVec(prom.CounterOpts{
Namespace: config.namespace,
Subsystem: config.subsystem,
ConstLabels: config.constLabels,
Name: config.bytesSentName,
Help: "Total number of bytes sent by server-side",
}, []string{"type", "service", "method"})
m.bytesReceived = prom.NewCounterVec(prom.CounterOpts{
Namespace: config.namespace,
Subsystem: config.subsystem,
ConstLabels: config.constLabels,
Name: config.bytesReceivedName,
Help: "Total number of bytes received by server-side",
}, []string{"type", "service", "method"})
}
if config.withInflightMetrics {
m.inflightRequests = prom.NewGaugeVec(prom.GaugeOpts{
Namespace: config.namespace,
Subsystem: config.subsystem,
ConstLabels: config.constLabels,
Name: config.inflightRequestsName,
Help: "Current number of inflight RPCs server-side",
}, []string{"type", "service", "method"})
}
return m
}
func NewClientMetrics(opts ...MetricsOption) *Metrics {
config := evaluateMetricsOptions(&metricsOptions{
histogramBuckets: prom.DefBuckets,
requestStartedName: "connect_client_started_total",
requestHandledName: "connect_client_handled_total",
requestHandledSecondsName: "connect_client_handled_seconds",
streamMsgSentName: "connect_client_msg_sent_total",
streamMsgReceivedName: "connect_client_msg_received_total",
bytesSentName: "connect_client_bytes_sent_total",
bytesReceivedName: "connect_client_bytes_received_total",
inflightRequestsName: "connect_client_inflight_requests",
}, opts...)
m := &Metrics{
isClient: true,
requestStarted: prom.NewCounterVec(prom.CounterOpts{
Namespace: config.namespace,
Subsystem: config.subsystem,
ConstLabels: config.constLabels,
Name: config.requestStartedName,
Help: "Total number of RPCs started handling client-side",
}, []string{"type", "service", "method"}),
requestHandled: prom.NewCounterVec(prom.CounterOpts{
Namespace: config.namespace,
Subsystem: config.subsystem,
ConstLabels: config.constLabels,
Name: config.requestHandledName,
Help: "Total number of RPCs handled client-side",
}, []string{"type", "service", "method", "code"}),
streamMsgSent: prom.NewCounterVec(prom.CounterOpts{
Namespace: config.namespace,
Subsystem: config.subsystem,
ConstLabels: config.constLabels,
Name: config.streamMsgSentName,
Help: "Total number of stream messages sent by client-side",
}, []string{"type", "service", "method"}),
streamMsgReceived: prom.NewCounterVec(prom.CounterOpts{
Namespace: config.namespace,
Subsystem: config.subsystem,
ConstLabels: config.constLabels,
Name: config.streamMsgReceivedName,
Help: "Total number of stream messages received by client-side",
}, []string{"type", "service", "method"}),
}
if config.withHistogram {
m.requestHandledSeconds = prom.NewHistogramVec(prom.HistogramOpts{
Namespace: config.namespace,
Subsystem: config.subsystem,
ConstLabels: config.constLabels,
Name: config.requestHandledSecondsName,
Help: "Histogram of RPCs handled client-side",
Buckets: config.histogramBuckets,
}, []string{"type", "service", "method", "code"})
}
if config.withByteMetrics {
m.bytesSent = prom.NewCounterVec(prom.CounterOpts{
Namespace: config.namespace,
Subsystem: config.subsystem,
ConstLabels: config.constLabels,
Name: config.bytesSentName,
Help: "Total number of bytes sent by client-side",
}, []string{"type", "service", "method"})
m.bytesReceived = prom.NewCounterVec(prom.CounterOpts{
Namespace: config.namespace,
Subsystem: config.subsystem,
ConstLabels: config.constLabels,
Name: config.bytesReceivedName,
Help: "Total number of bytes received by client-side",
}, []string{"type", "service", "method"})
}
if config.withInflightMetrics {
m.inflightRequests = prom.NewGaugeVec(prom.GaugeOpts{
Namespace: config.namespace,
Subsystem: config.subsystem,
ConstLabels: config.constLabels,
Name: config.inflightRequestsName,
Help: "Current number of inflight RPCs client-side",
}, []string{"type", "service", "method"})
}
return m
}
var _ prom.Collector = (*Metrics)(nil)
type Metrics struct {
isClient bool
requestStarted *prom.CounterVec
requestHandled *prom.CounterVec
requestHandledSeconds *prom.HistogramVec
streamMsgSent *prom.CounterVec
streamMsgReceived *prom.CounterVec
bytesSent *prom.CounterVec
bytesReceived *prom.CounterVec
inflightRequests *prom.GaugeVec
}
func (m *Metrics) Reset() {
m.requestStarted.Reset()
m.requestHandled.Reset()
if m.requestHandledSeconds != nil {
m.requestHandledSeconds.Reset()
}
m.streamMsgSent.Reset()
m.streamMsgReceived.Reset()
if m.bytesSent != nil {
m.bytesSent.Reset()
}
if m.bytesReceived != nil {
m.bytesReceived.Reset()
}
if m.inflightRequests != nil {
m.inflightRequests.Reset()
}
}
// Describe implements Describe as required by prom.Collector
func (m *Metrics) Describe(c chan<- *prom.Desc) {
m.requestStarted.Describe(c)
m.requestHandled.Describe(c)
if m.requestHandledSeconds != nil {
m.requestHandledSeconds.Describe(c)
}
m.streamMsgSent.Describe(c)
m.streamMsgReceived.Describe(c)
if m.bytesSent != nil {
m.bytesSent.Describe(c)
}
if m.bytesReceived != nil {
m.bytesReceived.Describe(c)
}
if m.inflightRequests != nil {
m.inflightRequests.Describe(c)
}
}
// Collect implements collect as required by prom.Collector
func (m *Metrics) Collect(c chan<- prom.Metric) {
m.requestStarted.Collect(c)
m.requestHandled.Collect(c)
if m.requestHandledSeconds != nil {
m.requestHandledSeconds.Collect(c)
}
m.streamMsgSent.Collect(c)
m.streamMsgReceived.Collect(c)
if m.bytesSent != nil {
m.bytesSent.Collect(c)
}
if m.bytesReceived != nil {
m.bytesReceived.Collect(c)
}
if m.inflightRequests != nil {
m.inflightRequests.Collect(c)
}
}
func (m *Metrics) ReportStarted(callType, service, method string) {
m.requestStarted.WithLabelValues(callType, service, method).Inc()
if m.inflightRequests != nil {
m.inflightRequests.WithLabelValues(callType, service, method).Inc()
}
}
func (m *Metrics) ReportHandled(callType, service, method, code string) {
m.requestHandled.WithLabelValues(callType, service, method, code).Inc()
if m.inflightRequests != nil {
m.inflightRequests.WithLabelValues(callType, service, method).Dec()
}
}
func (m *Metrics) ReportHandledSeconds(callType, service, method, code string, val float64) {
if m.requestHandledSeconds != nil {
m.requestHandledSeconds.WithLabelValues(callType, service, method, code).Observe(val)
}
}
type metricsOptions struct {
withHistogram bool
histogramBuckets []float64
namespace string
subsystem string
requestStartedName string
requestHandledName string
requestHandledSecondsName string
streamMsgSentName string
streamMsgReceivedName string
bytesSentName string
bytesReceivedName string
inflightRequestsName string
constLabels prom.Labels
withByteMetrics bool
withInflightMetrics bool
}
type MetricsOption func(opts *metricsOptions)
func WithHistogram(enabled bool) MetricsOption {
return func(opts *metricsOptions) {
opts.withHistogram = enabled
}
}
func WithHistogramBuckets(buckets []float64) MetricsOption {
return func(opts *metricsOptions) {
opts.histogramBuckets = buckets
}
}
func WithNamespace(namespace string) MetricsOption {
return func(opts *metricsOptions) {
opts.namespace = namespace
}
}
func WithSubsystem(subsystem string) MetricsOption {
return func(opts *metricsOptions) {
opts.subsystem = subsystem
}
}
func WithConstLabels(labels prom.Labels) MetricsOption {
return func(opts *metricsOptions) {
opts.constLabels = labels
}
}
func WithByteMetrics(enabled bool) MetricsOption {
return func(opts *metricsOptions) {
opts.withByteMetrics = enabled
}
}
func WithInflightMetrics(enabled bool) MetricsOption {
return func(opts *metricsOptions) {
opts.withInflightMetrics = enabled
}
}
func evaluateMetricsOptions(defaults *metricsOptions, opts ...MetricsOption) *metricsOptions {
for _, opt := range opts {
opt(defaults)
}
return defaults
}