/
graph.go
506 lines (464 loc) · 15.7 KB
/
graph.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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
// Copyright (c) 2022 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 observability
import (
"context"
"sync"
"time"
"go.uber.org/net/metrics"
"go.uber.org/net/metrics/bucket"
"go.uber.org/yarpc/api/transport"
"go.uber.org/yarpc/internal/digester"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
)
var (
_timeNow = time.Now // for tests
_defaultGraphSize = 128
// Latency buckets for histograms. At some point, we may want to make these
// configurable.
_bucketsMs = bucket.NewRPCLatency()
// Bytes buckets for payload size histograms, containing exponential buckets
// in range of 0B, 1B, 2B, ... 256MB.
_bucketsBytes = append([]int64{0}, bucket.NewExponential(1, 2, 29)...)
)
type directionName string
const (
_directionOutbound directionName = "outbound"
_directionInbound directionName = "inbound"
// _droppedTagValue represents the value of a metric tag when the tag
// is being blocked.
_droppedTagValue = "__dropped__"
)
// A graph represents a collection of services: each service is a node, and we
// collect stats for each caller-callee-transport-encoding-procedure-rk-sk-rd edge.
type graph struct {
meter *metrics.Scope
logger *zap.Logger
extract ContextExtractor
metricTagsBlocklist []string
edgesMu sync.RWMutex
edges map[string]*edge
inboundLevels, outboundLevels levels
}
func newGraph(meter *metrics.Scope, logger *zap.Logger, extract ContextExtractor, metricTagsBlocklist []string) graph {
return graph{
edges: make(map[string]*edge, _defaultGraphSize),
meter: meter,
logger: logger,
extract: extract,
metricTagsBlocklist: metricTagsBlocklist,
inboundLevels: levels{
success: zapcore.DebugLevel,
failure: zapcore.ErrorLevel,
applicationError: zapcore.ErrorLevel,
serverError: zapcore.ErrorLevel,
clientError: zapcore.ErrorLevel,
},
outboundLevels: levels{
success: zapcore.DebugLevel,
failure: zapcore.ErrorLevel,
applicationError: zapcore.ErrorLevel,
serverError: zapcore.ErrorLevel,
clientError: zapcore.ErrorLevel,
},
}
}
// begin starts a call along an edge.
func (g *graph) begin(ctx context.Context, rpcType transport.Type, direction directionName, req *transport.Request) call {
now := _timeNow()
d := digester.New()
d.Add(req.Caller)
d.Add(req.Service)
d.Add(req.Transport)
d.Add(string(req.Encoding))
d.Add(req.Procedure)
d.Add(req.RoutingKey)
d.Add(req.RoutingDelegate)
d.Add(string(direction))
d.Add(rpcType.String())
e := g.getOrCreateEdge(d.Digest(), req, string(direction), rpcType)
d.Free()
levels := &g.inboundLevels
if direction != _directionInbound {
levels = &g.outboundLevels
}
return call{
edge: e,
extract: g.extract,
started: now,
ctx: ctx,
req: req,
rpcType: rpcType,
direction: direction,
levels: levels,
}
}
func (g *graph) getOrCreateEdge(key []byte, req *transport.Request, direction string, rpcType transport.Type) *edge {
if e := g.getEdge(key); e != nil {
return e
}
return g.createEdge(key, req, direction, rpcType)
}
func (g *graph) getEdge(key []byte) *edge {
g.edgesMu.RLock()
e := g.edges[string(key)]
g.edgesMu.RUnlock()
return e
}
func (g *graph) createEdge(key []byte, req *transport.Request, direction string, rpcType transport.Type) *edge {
g.edgesMu.Lock()
// Since we'll rarely hit this code path, the overhead of defer is acceptable.
defer g.edgesMu.Unlock()
if e, ok := g.edges[string(key)]; ok {
// Someone beat us to the punch.
return e
}
e := newEdge(g.logger, g.meter, g.metricTagsBlocklist, req, direction, rpcType)
g.edges[string(key)] = e
return e
}
// An edge is a collection of RPC stats for a particular
// caller-callee-encoding-procedure-sk-rd-rk edge in the service graph.
type edge struct {
logger *zap.Logger
calls *metrics.Counter
successes *metrics.Counter
panics *metrics.Counter
callerFailures *metrics.CounterVector
serverFailures *metrics.CounterVector
latencies *metrics.Histogram
callerErrLatencies *metrics.Histogram
serverErrLatencies *metrics.Histogram
ttls *metrics.Histogram
timeoutTtls *metrics.Histogram
requestPayloadSizes *metrics.Histogram
responsePayloadSizes *metrics.Histogram
streaming *streamEdge
}
// streamEdge metrics should only be used for streaming requests.
type streamEdge struct {
sends *metrics.Counter
sendSuccesses *metrics.Counter
sendFailures *metrics.CounterVector
receives *metrics.Counter
receiveSuccesses *metrics.Counter
receiveFailures *metrics.CounterVector
streamDurations *metrics.Histogram
streamRequestPayloadSizes *metrics.Histogram
streamResponsePayloadSizes *metrics.Histogram
streamsActive *metrics.Gauge
}
// newEdge constructs a new edge. Since Registries enforce metric uniqueness,
// edges should be cached and re-used for each RPC.
func newEdge(logger *zap.Logger, meter *metrics.Scope, metricTagsBlocklist []string, req *transport.Request, direction string, rpcType transport.Type) *edge {
tags := metrics.Tags{
"source": req.Caller,
"dest": req.Service,
"transport": unknownIfEmpty(req.Transport),
"procedure": req.Procedure,
"encoding": string(req.Encoding),
"routing_key": req.RoutingKey,
"routing_delegate": req.RoutingDelegate,
"direction": direction,
"rpc_type": rpcType.String(),
}
for _, tagName := range metricTagsBlocklist {
tags[tagName] = _droppedTagValue
}
// metrics for all RPCs
calls, err := meter.Counter(metrics.Spec{
Name: "calls",
Help: "Total number of RPCs.",
ConstTags: tags,
})
if err != nil {
logger.Error("Failed to create calls counter.", zap.Error(err))
}
successes, err := meter.Counter(metrics.Spec{
Name: "successes",
Help: "Number of successful RPCs.",
ConstTags: tags,
})
if err != nil {
logger.Error("Failed to create successes counter.", zap.Error(err))
}
panics, err := meter.Counter(metrics.Spec{
Name: "panics",
Help: "Number of RPCs failed because of panic.",
ConstTags: tags,
})
if err != nil {
logger.Error("Failed to create panics counter.", zap.Error(err))
}
callerFailures, err := meter.CounterVector(metrics.Spec{
Name: "caller_failures",
Help: "Number of RPCs failed because of caller error.",
ConstTags: tags,
VarTags: []string{_error, _errorNameMetricsKey},
})
if err != nil {
logger.Error("Failed to create caller failures vector.", zap.Error(err))
}
serverFailures, err := meter.CounterVector(metrics.Spec{
Name: "server_failures",
Help: "Number of RPCs failed because of server error.",
ConstTags: tags,
VarTags: []string{_error, _errorNameMetricsKey},
})
if err != nil {
logger.Error("Failed to create server failures vector.", zap.Error(err))
}
// metrics for only unary and oneway
var latencies, callerErrLatencies, serverErrLatencies, ttls, timeoutTtls,
requestPayloadSizes, responsePayloadSizes *metrics.Histogram
if rpcType == transport.Unary || rpcType == transport.Oneway {
latencies, err = meter.Histogram(metrics.HistogramSpec{
Spec: metrics.Spec{
Name: "success_latency_ms",
Help: "Latency distribution of successful RPCs.",
ConstTags: tags,
},
Unit: time.Millisecond,
Buckets: _bucketsMs,
})
if err != nil {
logger.Error("Failed to create success latency distribution.", zap.Error(err))
}
callerErrLatencies, err = meter.Histogram(metrics.HistogramSpec{
Spec: metrics.Spec{
Name: "caller_failure_latency_ms",
Help: "Latency distribution of RPCs failed because of caller error.",
ConstTags: tags,
},
Unit: time.Millisecond,
Buckets: _bucketsMs,
})
if err != nil {
logger.Error("Failed to create caller failure latency distribution.", zap.Error(err))
}
serverErrLatencies, err = meter.Histogram(metrics.HistogramSpec{
Spec: metrics.Spec{
Name: "server_failure_latency_ms",
Help: "Latency distribution of RPCs failed because of server error.",
ConstTags: tags,
},
Unit: time.Millisecond,
Buckets: _bucketsMs,
})
if err != nil {
logger.Error("Failed to create server failure latency distribution.", zap.Error(err))
}
ttls, err = meter.Histogram(metrics.HistogramSpec{
Spec: metrics.Spec{
Name: "ttl_ms",
Help: "TTL distribution of the RPCs passed by the caller",
ConstTags: tags,
},
Unit: time.Millisecond,
Buckets: _bucketsMs,
})
if err != nil {
logger.Error("Failed to create ttl distribution.", zap.Error(err))
}
timeoutTtls, err = meter.Histogram(metrics.HistogramSpec{
Spec: metrics.Spec{
Name: "timeout_ttl_ms",
Help: "TTL distribution of the RPCs passed by caller which failed due to timeout",
ConstTags: tags,
},
Unit: time.Millisecond,
Buckets: _bucketsMs,
})
if err != nil {
logger.Error("Failed to create timeout ttl distribution.", zap.Error(err))
}
requestPayloadSizes, err = meter.Histogram(metrics.HistogramSpec{
Spec: metrics.Spec{
Name: "request_payload_size_bytes",
Help: "Request payload size distribution of the RPCs in bytes",
ConstTags: tags,
},
Unit: time.Millisecond, // Unit is relevent for this histogram
Buckets: _bucketsBytes,
})
if err != nil {
logger.Error("Failed to create request payload size histogram.", zap.Error(err))
}
responsePayloadSizes, err = meter.Histogram(metrics.HistogramSpec{
Spec: metrics.Spec{
Name: "response_payload_size_bytes",
Help: "Response payload size distribution of the RPCs in bytes",
ConstTags: tags,
},
Unit: time.Millisecond, // Unit is relevent for this histogram
Buckets: _bucketsBytes,
})
if err != nil {
logger.Error("Failed to create response payload size histogram.", zap.Error(err))
}
}
// metrics for only streams
var streaming *streamEdge
if rpcType == transport.Streaming {
// sends
sends, err := meter.Counter(metrics.Spec{
Name: "stream_sends",
Help: "Total number of streaming messages sent.",
ConstTags: tags,
})
if err != nil {
logger.DPanic("Failed to create streaming sends counter.", zap.Error(err))
}
sendSuccesses, err := meter.Counter(metrics.Spec{
Name: "stream_send_successes",
Help: "Number of successful streaming messages sent.",
ConstTags: tags,
})
if err != nil {
logger.DPanic("Failed to create streaming sends successes counter.", zap.Error(err))
}
sendFailures, err := meter.CounterVector(metrics.Spec{
Name: "stream_send_failures",
Help: "Number streaming messages that failed to send.",
ConstTags: tags,
VarTags: []string{_error},
})
if err != nil {
logger.DPanic("Failed to create streaming sends failure counter.", zap.Error(err))
}
// receives
receives, err := meter.Counter(metrics.Spec{
Name: "stream_receives",
Help: "Total number of streaming messages recevied.",
ConstTags: tags,
})
if err != nil {
logger.DPanic("Failed to create streaming receives counter.", zap.Error(err))
}
receiveSuccesses, err := meter.Counter(metrics.Spec{
Name: "stream_receive_successes",
Help: "Number of successful streaming messages received.",
ConstTags: tags,
})
if err != nil {
logger.DPanic("Failed to create streaming receives successes counter.", zap.Error(err))
}
receiveFailures, err := meter.CounterVector(metrics.Spec{
Name: "stream_receive_failures",
Help: "Number streaming messages failed to be recieved.",
ConstTags: tags,
VarTags: []string{_error},
})
if err != nil {
logger.DPanic("Failed to create streaming receives failure counter.", zap.Error(err))
}
// entire stream
streamDurations, err := meter.Histogram(metrics.HistogramSpec{
Spec: metrics.Spec{
Name: "stream_duration_ms",
Help: "Latency distribution of total stream duration.",
ConstTags: tags,
},
Unit: time.Millisecond,
Buckets: _bucketsMs,
})
if err != nil {
logger.DPanic("Failed to create stream duration histogram.", zap.Error(err))
}
streamRequestPayloadSizes, err := meter.Histogram(metrics.HistogramSpec{
Spec: metrics.Spec{
Name: "stream_request_payload_size_bytes",
Help: "Stream request payload size distribution",
ConstTags: tags,
},
Unit: time.Millisecond,
Buckets: _bucketsBytes,
})
if err != nil {
logger.DPanic("Failed to create stream request payload size histogram", zap.Error(err))
}
streamResponsePayloadSizes, err := meter.Histogram(metrics.HistogramSpec{
Spec: metrics.Spec{
Name: "stream_response_payload_size_bytes",
Help: "Stream response payload size distribution",
ConstTags: tags,
},
Unit: time.Millisecond,
Buckets: _bucketsBytes,
})
if err != nil {
logger.DPanic("Failed to create stream response payload size histogram", zap.Error(err))
}
streamsActive, err := meter.Gauge(metrics.Spec{
Name: "streams_active",
Help: "Number of active streams.",
ConstTags: tags,
})
if err != nil {
logger.DPanic("Failed to create active stream gauge.", zap.Error(err))
}
streaming = &streamEdge{
sends: sends,
sendSuccesses: sendSuccesses,
sendFailures: sendFailures,
receives: receives,
receiveSuccesses: receiveSuccesses,
receiveFailures: receiveFailures,
streamDurations: streamDurations,
streamRequestPayloadSizes: streamRequestPayloadSizes,
streamResponsePayloadSizes: streamResponsePayloadSizes,
streamsActive: streamsActive,
}
}
logger = logger.With(
zap.String("source", req.Caller),
zap.String("dest", req.Service),
zap.String("transport", unknownIfEmpty(req.Transport)),
zap.String("procedure", req.Procedure),
zap.String("encoding", string(req.Encoding)),
zap.String("routingKey", req.RoutingKey),
zap.String("routingDelegate", req.RoutingDelegate),
zap.String("direction", direction),
)
return &edge{
logger: logger,
calls: calls,
successes: successes,
panics: panics,
callerFailures: callerFailures,
serverFailures: serverFailures,
requestPayloadSizes: requestPayloadSizes,
responsePayloadSizes: responsePayloadSizes,
latencies: latencies,
callerErrLatencies: callerErrLatencies,
serverErrLatencies: serverErrLatencies,
ttls: ttls,
timeoutTtls: timeoutTtls,
streaming: streaming,
}
}
// unknownIfEmpty works around hard-coded default value of "default" in go.uber.org/net/metrics
func unknownIfEmpty(t string) string {
if t == "" {
t = "unknown"
}
return t
}