forked from open-telemetry/opentelemetry-go-contrib
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmetric_attributes_test.go
More file actions
720 lines (596 loc) · 21.5 KB
/
metric_attributes_test.go
File metadata and controls
720 lines (596 loc) · 21.5 KB
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
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
package otelgrpc_test
import (
"context"
"errors"
"io"
"net"
"strings"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/baggage"
"go.opentelemetry.io/otel/propagation"
"go.opentelemetry.io/otel/sdk/metric"
"go.opentelemetry.io/otel/sdk/metric/metricdata"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure"
testpb "google.golang.org/grpc/interop/grpc_testing"
"google.golang.org/grpc/metadata"
"google.golang.org/grpc/stats"
"go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc"
)
// testLabelerServer is a test server that implements the test service.
type testLabelerServer struct {
testpb.UnimplementedTestServiceServer
}
// EmptyCall is a test method that returns an empty response.
func (*testLabelerServer) EmptyCall(_ context.Context, _ *testpb.Empty) (*testpb.Empty, error) {
return &testpb.Empty{}, nil
}
// UnaryCall is a test method that returns a simple response.
func (*testLabelerServer) UnaryCall(_ context.Context, _ *testpb.SimpleRequest) (*testpb.SimpleResponse, error) {
return &testpb.SimpleResponse{}, nil
}
// StreamingInputCall is a test method that implements a client-side streaming RPC.
func (*testLabelerServer) StreamingInputCall(stream testpb.TestService_StreamingInputCallServer) error {
for {
_, err := stream.Recv()
if err != nil {
switch {
case errors.Is(err, io.EOF):
return stream.SendAndClose(&testpb.StreamingInputCallResponse{})
default:
return err
}
}
}
}
// StreamingOutputCall is a test method that implements a server-side streaming RPC.
func (*testLabelerServer) StreamingOutputCall(req *testpb.StreamingOutputCallRequest, stream testpb.TestService_StreamingOutputCallServer) error {
for _, param := range req.ResponseParameters {
payload := &testpb.Payload{
Type: testpb.PayloadType_COMPRESSABLE,
Body: make([]byte, param.Size),
}
if err := stream.Send(&testpb.StreamingOutputCallResponse{Payload: payload}); err != nil {
return err
}
}
return nil
}
const (
serverLabelingDirection = iota
clientLabelingDirection
)
// TestMetricAttributesFn_ServerSide tests that labels are added to server-side metrics for unary RPCs.
func TestMetricAttributesFn_ServerSide(t *testing.T) {
reader := metric.NewManualReader()
mp := metric.NewMeterProvider(metric.WithReader(reader))
lis, server := startTestServerWithOptions(t, mp, otelgrpc.WithMetricAttributesFn(func(ctx context.Context) []attribute.KeyValue {
md, ok := metadata.FromIncomingContext(ctx)
var origin string
if ok {
originVals := md.Get("x-origin")
if len(originVals) > 0 {
origin = originVals[0]
}
}
return []attribute.KeyValue{
attribute.String("origin", origin),
attribute.String("tier", "premium"),
}
}))
defer server.Stop()
ctx := metadata.NewOutgoingContext(t.Context(), metadata.Pairs("x-origin", "dynamic-origin"))
client := createTestClient(t, lis.Addr().String(), nil, nil)
_, err := client.EmptyCall(ctx, &testpb.Empty{})
require.NoError(t, err)
assertAllMetricsHaveLabels(t, reader, serverLabelingDirection, map[string]string{
"origin": "dynamic-origin",
"tier": "premium",
})
}
// TestMetricAttributesFn_ServerSideStreaming tests that labels are added to server-side metrics for server-side streaming RPCs.
func TestMetricAttributesFn_ServerSideStreaming(t *testing.T) {
reader := metric.NewManualReader()
mp := metric.NewMeterProvider(metric.WithReader(reader))
lis, server := startTestServerWithOptions(t, mp, otelgrpc.WithMetricAttributesFn(func(ctx context.Context) []attribute.KeyValue {
md, ok := metadata.FromIncomingContext(ctx)
var origin string
if ok {
originVals := md.Get("x-origin")
if len(originVals) > 0 {
origin = originVals[0]
}
}
return []attribute.KeyValue{
attribute.String("origin", origin),
attribute.String("tier", "streaming"),
}
}))
defer server.Stop()
ctx := metadata.NewOutgoingContext(t.Context(), metadata.Pairs("x-origin", "dynamic-stream-origin"))
client := createTestClient(t, lis.Addr().String(), nil, nil)
stream, err := client.StreamingOutputCall(ctx, &testpb.StreamingOutputCallRequest{
ResponseParameters: []*testpb.ResponseParameters{
{Size: 1}, {Size: 2},
},
})
require.NoError(t, err)
var count int
for {
_, err := stream.Recv()
if errors.Is(err, io.EOF) {
break
}
require.NoError(t, err)
count++
}
require.Equal(t, 2, count)
assertAllMetricsHaveLabels(t, reader, serverLabelingDirection, map[string]string{
"origin": "dynamic-stream-origin",
"tier": "streaming",
})
}
// TestMetricAttributesFn_ServerSide_Baggage tests that baggage can be used on the server-side to populate context values for MetricAttributesFn.
func TestMetricAttributesFn_ServerSide_Baggage(t *testing.T) {
reader := metric.NewManualReader()
mp := metric.NewMeterProvider(metric.WithReader(reader))
metricFunc := func(ctx context.Context) []attribute.KeyValue {
bag := baggage.FromContext(ctx)
if tier := bag.Member("tenant.tier"); tier.Value() != "" {
return []attribute.KeyValue{
attribute.String("tenant.tier", tier.Value()),
}
}
return []attribute.KeyValue{
attribute.String("tenant.tier", "NOT_FOUND"),
}
}
lis, server := startTestServerWithOptions(t, mp,
otelgrpc.WithMetricAttributesFn(metricFunc),
otelgrpc.WithPropagators(propagation.NewCompositeTextMapPropagator(
propagation.Baggage{},
)),
)
defer server.Stop()
conn, err := grpc.NewClient(
lis.Addr().String(),
grpc.WithTransportCredentials(insecure.NewCredentials()),
grpc.WithStatsHandler(otelgrpc.NewClientHandler(
otelgrpc.WithPropagators(propagation.NewCompositeTextMapPropagator(
propagation.Baggage{},
)),
)),
)
require.NoError(t, err)
t.Cleanup(func() { conn.Close() })
client := testpb.NewTestServiceClient(conn)
member, err := baggage.NewMember("tenant.tier", "premium")
require.NoError(t, err)
bag, err := baggage.New(member)
require.NoError(t, err)
ctx := baggage.ContextWithBaggage(t.Context(), bag)
_, err = client.EmptyCall(ctx, &testpb.Empty{})
require.NoError(t, err)
assertAllMetricsHaveLabels(t, reader, serverLabelingDirection, map[string]string{
"tenant.tier": "premium",
})
}
type enrichedServerHandler struct {
stats.Handler
}
type tenantTierKeyType struct{}
var tenantTierKey tenantTierKeyType
// TagRPC overrides the TagRPC method of the stats handler to add tenant tier to context.
func (h *enrichedServerHandler) TagRPC(ctx context.Context, info *stats.RPCTagInfo) context.Context {
ctx = context.WithValue(ctx, tenantTierKey, "premium")
return h.Handler.TagRPC(ctx, info)
}
// TestMetricAttributesFn_ServerSide_WithWrappedHandler tests that a wrapped stats handler
// can populate context values for MetricAttributesFn.
func TestMetricAttributesFn_ServerSide_WithWrappedHandler(t *testing.T) {
reader := metric.NewManualReader()
mp := metric.NewMeterProvider(metric.WithReader(reader))
metricFunc := func(ctx context.Context) []attribute.KeyValue {
if tier, ok := ctx.Value(tenantTierKey).(string); ok {
return []attribute.KeyValue{
attribute.String("tenant.tier", tier),
}
}
return []attribute.KeyValue{
attribute.String("tenant.tier", "NOT_FOUND"),
}
}
lis, err := net.Listen("tcp", "localhost:0")
require.NoError(t, err)
wrappedHandler := &enrichedServerHandler{
Handler: otelgrpc.NewServerHandler(
otelgrpc.WithMeterProvider(mp),
otelgrpc.WithMetricAttributesFn(metricFunc),
),
}
server := grpc.NewServer(
grpc.StatsHandler(wrappedHandler),
)
testpb.RegisterTestServiceServer(server, &testLabelerServer{})
go func() {
if err := server.Serve(lis); err != nil && !errors.Is(err, grpc.ErrServerStopped) {
t.Errorf("server failed: %v", err)
}
}()
defer server.Stop()
client := createTestClient(t, lis.Addr().String(), nil, nil)
_, err = client.EmptyCall(t.Context(), &testpb.Empty{})
require.NoError(t, err)
assertAllMetricsHaveLabels(t, reader, serverLabelingDirection, map[string]string{
"tenant.tier": "premium",
})
}
// TestMetricAttributesFn_ClientSide tests that labels are added to client-side metrics for unary RPCs.
func TestMetricAttributesFn_ClientSide(t *testing.T) {
serverLis, err := net.Listen("tcp", "localhost:0")
require.NoError(t, err)
server := grpc.NewServer()
testpb.RegisterTestServiceServer(server, &testLabelerServer{})
go func() {
if err := server.Serve(serverLis); err != nil && !errors.Is(err, grpc.ErrServerStopped) {
t.Errorf("server failed: %v", err)
}
}()
defer server.Stop()
reader := metric.NewManualReader()
mp := metric.NewMeterProvider(metric.WithReader(reader))
type rpcServiceKeyType struct{}
var rpcServiceKey rpcServiceKeyType
dynamicServiceName := "orders-service"
var interceptor grpc.UnaryClientInterceptor = func(ctx context.Context, method string, req, reply any, cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) error {
ctx = context.WithValue(ctx, rpcServiceKey, dynamicServiceName)
return invoker(ctx, method, req, reply, cc, opts...)
}
metricFunc := func(ctx context.Context) []attribute.KeyValue {
if svc, ok := ctx.Value(rpcServiceKey).(string); ok {
return []attribute.KeyValue{
attribute.String("rpc.service", svc),
attribute.String("client.version", "v1.2.3"),
}
}
return []attribute.KeyValue{
attribute.String("client.version", "v1.2.3"),
}
}
client := createTestClient(t, serverLis.Addr().String(), mp, metricFunc, interceptor)
_, err = client.EmptyCall(t.Context(), &testpb.Empty{})
require.NoError(t, err)
assertAllMetricsHaveLabels(t, reader, clientLabelingDirection, map[string]string{
"client.version": "v1.2.3",
"rpc.service": dynamicServiceName,
})
}
// TestMetricAttributesFn_ClientSideStreaming tests that labels are added to client-side metrics for client-side streaming RPCs.
func TestMetricAttributesFn_ClientSideStreaming(t *testing.T) {
serverLis, err := net.Listen("tcp", "localhost:0")
require.NoError(t, err)
server := grpc.NewServer()
testpb.RegisterTestServiceServer(server, &testLabelerServer{})
go func() {
if err := server.Serve(serverLis); err != nil && !errors.Is(err, grpc.ErrServerStopped) {
t.Errorf("server failed: %v", err)
}
}()
defer server.Stop()
reader := metric.NewManualReader()
mp := metric.NewMeterProvider(metric.WithReader(reader))
type rpcServiceKeyType struct{}
var rpcServiceKey rpcServiceKeyType
dynamicServiceName := "orders-service"
var interceptor grpc.StreamClientInterceptor = func(ctx context.Context, desc *grpc.StreamDesc, cc *grpc.ClientConn, method string, streamer grpc.Streamer, opts ...grpc.CallOption) (grpc.ClientStream, error) {
ctx = context.WithValue(ctx, rpcServiceKey, dynamicServiceName)
return streamer(ctx, desc, cc, method, opts...)
}
metricFunc := func(ctx context.Context) []attribute.KeyValue {
if svc, ok := ctx.Value(rpcServiceKey).(string); ok {
return []attribute.KeyValue{
attribute.String("rpc.service", svc),
attribute.String("client.version", "v2.0.0"),
}
}
return []attribute.KeyValue{
attribute.String("client.version", "v2.0.0"),
}
}
client := createTestClient(t, serverLis.Addr().String(), mp, metricFunc, interceptor)
stream, err := client.StreamingInputCall(t.Context())
require.NoError(t, err)
for range 3 {
err := stream.Send(&testpb.StreamingInputCallRequest{
Payload: &testpb.Payload{Body: []byte("hello")},
})
require.NoError(t, err)
}
_, err = stream.CloseAndRecv()
require.NoError(t, err)
assertAllMetricsHaveLabels(t, reader, clientLabelingDirection, map[string]string{
"client.version": "v2.0.0",
"rpc.service": dynamicServiceName,
})
}
// TestMetricAttributesFn_ClientSide_Baggage tests that baggage can be used on the client-side to populate context values for MetricAttributesFn.
func TestMetricAttributesFn_ClientSide_Baggage(t *testing.T) {
serverLis, err := net.Listen("tcp", "localhost:0")
require.NoError(t, err)
server := grpc.NewServer()
testpb.RegisterTestServiceServer(server, &testLabelerServer{})
go func() {
if err := server.Serve(serverLis); err != nil && !errors.Is(err, grpc.ErrServerStopped) {
t.Errorf("server failed: %v", err)
}
}()
defer server.Stop()
reader := metric.NewManualReader()
mp := metric.NewMeterProvider(metric.WithReader(reader))
metricFunc := func(ctx context.Context) []attribute.KeyValue {
bag := baggage.FromContext(ctx)
if env := bag.Member("environment"); env.Value() != "" {
return []attribute.KeyValue{
attribute.String("environment", env.Value()),
}
}
return []attribute.KeyValue{
attribute.String("environment", "NOT_FOUND"),
}
}
client := createTestClient(t, serverLis.Addr().String(), mp, metricFunc)
member, err := baggage.NewMember("environment", "staging")
require.NoError(t, err)
bag, err := baggage.New(member)
require.NoError(t, err)
ctx := baggage.ContextWithBaggage(t.Context(), bag)
_, err = client.EmptyCall(ctx, &testpb.Empty{})
require.NoError(t, err)
assertAllMetricsHaveLabels(t, reader, clientLabelingDirection, map[string]string{
"environment": "staging",
})
}
type enrichedClientHandler struct {
stats.Handler
}
type rpcServiceKeyType struct{}
var rpcServiceKey rpcServiceKeyType
// TagRPC overrides the TagRPC method of the stats handler to add service name to context.
func (h *enrichedClientHandler) TagRPC(ctx context.Context, info *stats.RPCTagInfo) context.Context {
ctx = context.WithValue(ctx, rpcServiceKey, "orders-service-wrapped")
return h.Handler.TagRPC(ctx, info)
}
// TestMetricAttributesFn_ClientSide_WithWrappedHandler tests that a wrapped client stats handler
// can populate context values for MetricAttributesFn.
func TestMetricAttributesFn_ClientSide_WithWrappedHandler(t *testing.T) {
serverLis, err := net.Listen("tcp", "localhost:0")
require.NoError(t, err)
server := grpc.NewServer()
testpb.RegisterTestServiceServer(server, &testLabelerServer{})
go func() {
if err := server.Serve(serverLis); err != nil && !errors.Is(err, grpc.ErrServerStopped) {
t.Errorf("server failed: %v", err)
}
}()
defer server.Stop()
reader := metric.NewManualReader()
mp := metric.NewMeterProvider(metric.WithReader(reader))
metricFunc := func(ctx context.Context) []attribute.KeyValue {
if svc, ok := ctx.Value(rpcServiceKey).(string); ok {
return []attribute.KeyValue{
attribute.String("rpc.service", svc),
}
}
return []attribute.KeyValue{
attribute.String("rpc.service", "NOT_FOUND"),
}
}
wrappedHandler := &enrichedClientHandler{
Handler: otelgrpc.NewClientHandler(
otelgrpc.WithMeterProvider(mp),
otelgrpc.WithMetricAttributesFn(metricFunc),
),
}
conn, err := grpc.NewClient(
serverLis.Addr().String(),
grpc.WithTransportCredentials(insecure.NewCredentials()),
grpc.WithStatsHandler(wrappedHandler),
)
require.NoError(t, err)
t.Cleanup(func() { conn.Close() })
client := testpb.NewTestServiceClient(conn)
_, err = client.EmptyCall(t.Context(), &testpb.Empty{})
require.NoError(t, err)
assertAllMetricsHaveLabels(t, reader, clientLabelingDirection, map[string]string{
"rpc.service": "orders-service-wrapped",
})
}
// TestMetricAttributesFn_ClientAndServerIndependent tests that labels are separated between the client- and the server-side metrics.
func TestMetricAttributesFn_ClientAndServerIndependent(t *testing.T) {
reader := metric.NewManualReader()
mp := metric.NewMeterProvider(metric.WithReader(reader))
// Dowstream server (the main server acts as a client to this server)
downstreamLis, downstreamServer := startTestServerWithOptions(t, nil)
defer downstreamServer.Stop()
// Main server setup
lis, server := startTestServerWithOptions(t, mp, otelgrpc.WithMetricAttributesFn(func(_ context.Context) []attribute.KeyValue {
return []attribute.KeyValue{
attribute.String("origin", "test-origin"),
attribute.String("tier", "premium"),
}
}))
defer server.Stop()
metricFunc := func(_ context.Context) []attribute.KeyValue {
return []attribute.KeyValue{
attribute.String("client.version", "v1.1.1"),
attribute.String("client.env", "staging"),
}
}
downstreamClient := createTestClient(t, downstreamLis.Addr().String(), mp, metricFunc)
// Client for the main server, triggering the flow (client -> server -> downstreamServer)
var interceptor grpc.UnaryClientInterceptor = func(ctx context.Context, method string, req, reply any, cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) error {
if method == "/grpc.testing.TestService/EmptyCall" {
_, _ = downstreamClient.EmptyCall(ctx, &testpb.Empty{})
}
return invoker(ctx, method, req, reply, cc, opts...)
}
client := createTestClient(t, lis.Addr().String(), nil, nil, interceptor)
_, err := client.EmptyCall(t.Context(), &testpb.Empty{})
require.NoError(t, err)
assertAllMetricsHaveLabels(t, reader, serverLabelingDirection, map[string]string{
"origin": "test-origin",
"tier": "premium",
})
assertAllMetricsHaveLabels(t, reader, clientLabelingDirection, map[string]string{
"client.version": "v1.1.1",
"client.env": "staging",
})
assertAllMetricsDoNotHaveLabels(t, reader, serverLabelingDirection, map[string]string{
"client.version": "v1.1.1",
"client.env": "staging",
})
assertAllMetricsDoNotHaveLabels(t, reader, clientLabelingDirection, map[string]string{
"origin": "test-origin",
"tier": "premium",
})
}
func startTestServerWithOptions(t *testing.T, mp *metric.MeterProvider, opts ...otelgrpc.Option) (net.Listener, *grpc.Server) {
t.Helper()
lis, err := net.Listen("tcp", "localhost:0")
require.NoError(t, err)
var allOpts []otelgrpc.Option
if mp != nil {
allOpts = append([]otelgrpc.Option{otelgrpc.WithMeterProvider(mp)}, opts...)
}
server := grpc.NewServer(
grpc.StatsHandler(otelgrpc.NewServerHandler(allOpts...)),
)
testpb.RegisterTestServiceServer(server, &testLabelerServer{})
go func() {
if err := server.Serve(lis); err != nil && !errors.Is(err, grpc.ErrServerStopped) {
t.Errorf("server failed: %v", err)
}
}()
return lis, server
}
func createTestClient(t *testing.T, addr string, mp *metric.MeterProvider, metricFunc func(ctx context.Context) []attribute.KeyValue, interceptors ...any) testpb.TestServiceClient {
t.Helper()
opts := []grpc.DialOption{
grpc.WithTransportCredentials(insecure.NewCredentials()),
}
var unaryInterceptors []grpc.UnaryClientInterceptor
var streamInterceptors []grpc.StreamClientInterceptor
for _, ic := range interceptors {
switch v := ic.(type) {
case grpc.UnaryClientInterceptor:
unaryInterceptors = append(unaryInterceptors, v)
case grpc.StreamClientInterceptor:
streamInterceptors = append(streamInterceptors, v)
default:
t.Fatalf("unsupported interceptor type: %T", v)
}
}
if len(unaryInterceptors) > 0 {
opts = append(opts, grpc.WithChainUnaryInterceptor(unaryInterceptors...))
}
if len(streamInterceptors) > 0 {
opts = append(opts, grpc.WithChainStreamInterceptor(streamInterceptors...))
}
if mp != nil && metricFunc != nil {
opts = append(opts,
grpc.WithStatsHandler(
otelgrpc.NewClientHandler(
otelgrpc.WithMeterProvider(mp),
otelgrpc.WithMetricAttributesFn(metricFunc),
),
),
)
}
conn, err := grpc.NewClient(addr, opts...)
require.NoError(t, err)
t.Cleanup(func() { conn.Close() })
return testpb.NewTestServiceClient(conn)
}
type dpWithAttrs struct {
metricName string
attrs map[string]string
}
func assertAllMetricsHaveLabels(t *testing.T, reader metric.Reader, direction int, expectedLabels map[string]string) {
t.Helper()
rm := metricdata.ResourceMetrics{}
err := reader.Collect(t.Context(), &rm)
require.NoError(t, err)
datapoints := collectDataPointsByMetric(rm, direction)
assert.NotEmpty(t, datapoints, "no metrics instrumented")
for _, dp := range datapoints {
for key, val := range expectedLabels {
attr, ok := dp.attrs[key]
t.Logf("metric %q has label %q", dp.metricName, attr)
assert.Truef(t, ok, "metric %q missing label %q", dp.metricName, key)
if ok {
assert.Equalf(t, val, attr, "metric %q has incorrect value for label %q: %s", dp.metricName, key, attr)
}
}
}
}
func assertAllMetricsDoNotHaveLabels(t *testing.T, reader metric.Reader, direction int, notExpectedLabels map[string]string) {
t.Helper()
rm := metricdata.ResourceMetrics{}
err := reader.Collect(t.Context(), &rm)
require.NoError(t, err)
datapoints := collectDataPointsByMetric(rm, direction)
for _, dp := range datapoints {
for key := range notExpectedLabels {
_, ok := dp.attrs[key]
assert.Falsef(t, ok, "metric %q should NOT have label %q", dp.metricName, key)
}
}
}
func collectDataPointsByMetric(rm metricdata.ResourceMetrics, direction int) []dpWithAttrs {
var result []dpWithAttrs
var prefix string
switch direction {
case serverLabelingDirection:
prefix = "rpc.server."
case clientLabelingDirection:
prefix = "rpc.client."
}
for _, scope := range rm.ScopeMetrics {
for _, m := range scope.Metrics {
if !strings.HasPrefix(m.Name, prefix) {
continue
}
switch data := m.Data.(type) {
case metricdata.Histogram[float64]:
for _, dp := range data.DataPoints {
result = append(result, dpWithAttrs{
metricName: m.Name,
attrs: extractAttributes(dp.Attributes),
})
}
case metricdata.Histogram[int64]:
for _, dp := range data.DataPoints {
result = append(result, dpWithAttrs{
metricName: m.Name,
attrs: extractAttributes(dp.Attributes),
})
}
}
}
}
return result
}
func extractAttributes(attrSet attribute.Set) map[string]string {
m := make(map[string]string)
iter := attrSet.Iter()
for iter.Next() {
kv := iter.Attribute()
m[string(kv.Key)] = kv.Value.AsString()
}
return m
}