-
Notifications
You must be signed in to change notification settings - Fork 691
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Refactor tracing interceptor #450
Merged
bwplotka
merged 9 commits into
grpc-ecosystem:v2
from
XSAM:refactor-tracing-interceptor
Apr 25, 2022
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
7450973
Add tracing interceptor
XSAM be1e991
Fix CI
XSAM d0650ba
Follow dependencies changes
XSAM 822802a
Fix comments
XSAM 7854af0
Avoid redundant else and return early
XSAM 135fdbd
Update interceptors/tracing/interceptors_test.go
XSAM 9202a15
Remove kv package
XSAM 7e04286
Merge remote-tracking branch 'origin/v2' into refactor-tracing-interc…
XSAM 545d37a
Remove keyvalue
XSAM File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
// Copyright (c) The go-grpc-middleware Authors. | ||
// Licensed under the Apache License 2.0. | ||
|
||
package tracing | ||
|
||
import ( | ||
"context" | ||
|
||
"google.golang.org/grpc" | ||
|
||
"github.com/grpc-ecosystem/go-grpc-middleware/v2/interceptors" | ||
) | ||
|
||
type SpanKind string | ||
|
||
const ( | ||
SpanKindServer SpanKind = "server" | ||
SpanKindClient SpanKind = "client" | ||
) | ||
|
||
func reportable(tracer Tracer) interceptors.CommonReportableFunc { | ||
return func(ctx context.Context, c interceptors.CallMeta, isClient bool) (interceptors.Reporter, context.Context) { | ||
kind := SpanKindServer | ||
if isClient { | ||
kind = SpanKindClient | ||
} | ||
|
||
newCtx, span := tracer.Start(ctx, c.FullMethod(), kind) | ||
return &reporter{ctx: newCtx, span: span}, newCtx | ||
} | ||
} | ||
|
||
// UnaryClientInterceptor returns a new unary client interceptor that optionally traces the execution of external gRPC calls. | ||
// Tracer will use tags (from tags package) available in current context as fields. | ||
func UnaryClientInterceptor(tracer Tracer) grpc.UnaryClientInterceptor { | ||
return interceptors.UnaryClientInterceptor(reportable(tracer)) | ||
} | ||
|
||
// StreamClientInterceptor returns a new streaming client interceptor that optionally traces the execution of external gRPC calls. | ||
// Tracer will use tags (from tags package) available in current context as fields. | ||
func StreamClientInterceptor(tracer Tracer) grpc.StreamClientInterceptor { | ||
return interceptors.StreamClientInterceptor(reportable(tracer)) | ||
} | ||
|
||
// UnaryServerInterceptor returns a new unary server interceptors that optionally traces endpoint handling. | ||
// Tracer will use tags (from tags package) available in current context as fields. | ||
func UnaryServerInterceptor(tracer Tracer) grpc.UnaryServerInterceptor { | ||
return interceptors.UnaryServerInterceptor(reportable(tracer)) | ||
} | ||
|
||
// StreamServerInterceptor returns a new stream server interceptors that optionally traces endpoint handling. | ||
// Tracer will use tags (from tags package) available in current context as fields. | ||
func StreamServerInterceptor(tracer Tracer) grpc.StreamServerInterceptor { | ||
return interceptors.StreamServerInterceptor(reportable(tracer)) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,322 @@ | ||
// Copyright (c) The go-grpc-middleware Authors. | ||
// Licensed under the Apache License 2.0. | ||
|
||
package tracing_test | ||
|
||
import ( | ||
"context" | ||
"io" | ||
"strconv" | ||
"sync/atomic" | ||
"testing" | ||
|
||
"github.com/stretchr/testify/assert" | ||
"github.com/stretchr/testify/require" | ||
"github.com/stretchr/testify/suite" | ||
"google.golang.org/grpc" | ||
"google.golang.org/grpc/codes" | ||
"google.golang.org/grpc/metadata" | ||
|
||
"github.com/grpc-ecosystem/go-grpc-middleware/v2/interceptors/tracing" | ||
"github.com/grpc-ecosystem/go-grpc-middleware/v2/testing/testpb" | ||
) | ||
|
||
var ( | ||
id int64 = 0 | ||
traceIDHeaderKey = "traceid" | ||
spanIDHeaderKey = "spanid" | ||
) | ||
|
||
func extractFromContext(ctx context.Context, kind tracing.SpanKind) *mockSpan { | ||
var m metadata.MD | ||
if kind == tracing.SpanKindClient { | ||
m, _ = metadata.FromOutgoingContext(ctx) | ||
} else { | ||
m, _ = metadata.FromIncomingContext(ctx) | ||
} | ||
|
||
traceIDValues := m.Get(traceIDHeaderKey) | ||
if len(traceIDValues) == 0 { | ||
return nil | ||
} | ||
spanIDValues := m.Get(spanIDHeaderKey) | ||
if len(spanIDValues) == 0 { | ||
return nil | ||
} | ||
|
||
return &mockSpan{ | ||
traceID: traceIDValues[0], | ||
spanID: spanIDValues[0], | ||
} | ||
} | ||
|
||
func injectWithContext(ctx context.Context, span *mockSpan, kind tracing.SpanKind) context.Context { | ||
var m metadata.MD | ||
if kind == tracing.SpanKindClient { | ||
m, _ = metadata.FromOutgoingContext(ctx) | ||
} else { | ||
m, _ = metadata.FromIncomingContext(ctx) | ||
} | ||
m = m.Copy() | ||
|
||
m.Set(traceIDHeaderKey, span.traceID) | ||
m.Set(spanIDHeaderKey, span.spanID) | ||
|
||
ctx = metadata.NewOutgoingContext(ctx, m) | ||
return ctx | ||
} | ||
|
||
func genID() string { | ||
return strconv.FormatInt(atomic.AddInt64(&id, 1), 10) | ||
} | ||
|
||
// Implements Tracker | ||
type mockTracer struct { | ||
spanStore map[string]*mockSpan | ||
} | ||
|
||
func (t *mockTracer) ListSpan(kind tracing.SpanKind) []*mockSpan { | ||
var spans []*mockSpan | ||
for _, v := range t.spanStore { | ||
if v.kind == kind { | ||
spans = append(spans, v) | ||
} | ||
} | ||
return spans | ||
} | ||
|
||
func (t *mockTracer) Reset() { | ||
t.spanStore = make(map[string]*mockSpan) | ||
} | ||
|
||
func newMockTracer() *mockTracer { | ||
return &mockTracer{ | ||
spanStore: make(map[string]*mockSpan), | ||
} | ||
} | ||
|
||
func (t *mockTracer) Start(ctx context.Context, spanName string, kind tracing.SpanKind) (context.Context, tracing.Span) { | ||
span := mockSpan{ | ||
spanID: genID(), | ||
name: spanName, | ||
kind: kind, | ||
statusCode: codes.OK, | ||
} | ||
|
||
parentSpan := extractFromContext(ctx, kind) | ||
if parentSpan != nil { | ||
// Fetch span from context as parent span | ||
span.traceID = parentSpan.traceID | ||
span.parentSpanID = parentSpan.spanID | ||
} else { | ||
span.traceID = genID() | ||
} | ||
|
||
t.spanStore[span.spanID] = &span | ||
if kind == tracing.SpanKindClient { | ||
ctx = injectWithContext(ctx, &span, kind) | ||
} | ||
return ctx, &span | ||
} | ||
|
||
// Implements Span | ||
type mockSpan struct { | ||
traceID string | ||
spanID string | ||
parentSpanID string | ||
|
||
name string | ||
kind tracing.SpanKind | ||
end bool | ||
|
||
statusCode codes.Code | ||
statusMessage string | ||
|
||
msgSendCounter int | ||
msgReceivedCounter int | ||
eventNameList []string | ||
attributesList [][]interface{} | ||
} | ||
|
||
func (s *mockSpan) SetAttributes(keyvals ...interface{}) { | ||
s.attributesList = append(s.attributesList, keyvals) | ||
} | ||
|
||
func (s *mockSpan) End() { | ||
s.end = true | ||
} | ||
|
||
func (s *mockSpan) SetStatus(code codes.Code, message string) { | ||
s.statusCode = code | ||
s.statusMessage = message | ||
} | ||
|
||
func (s *mockSpan) AddEvent(name string, keyvals ...interface{}) { | ||
s.eventNameList = append(s.eventNameList, name) | ||
|
||
if len(keyvals)%2 == 1 { | ||
keyvals = append(keyvals, nil) | ||
} | ||
|
||
for i := 0; i < len(keyvals); i += 2 { | ||
k, keyOK := keyvals[i].(string) | ||
v, valueOK := keyvals[i+1].(string) | ||
|
||
if keyOK && valueOK && k == "message.type" { | ||
switch v { | ||
case tracing.RPCMessageTypeSent: | ||
s.msgSendCounter++ | ||
case tracing.RPCMessageTypeReceived: | ||
s.msgReceivedCounter++ | ||
} | ||
} | ||
} | ||
} | ||
|
||
type tracingSuite struct { | ||
*testpb.InterceptorTestSuite | ||
tracer *mockTracer | ||
} | ||
|
||
func (s *tracingSuite) BeforeTest(suiteName, testName string) { | ||
s.tracer.Reset() | ||
} | ||
|
||
func (s *tracingSuite) TestPing() { | ||
method := "/testing.testpb.v1.TestService/Ping" | ||
errorMethod := "/testing.testpb.v1.TestService/PingError" | ||
t := s.T() | ||
|
||
testCases := []struct { | ||
name string | ||
error bool | ||
errorMessage string | ||
}{ | ||
{ | ||
name: "OK", | ||
error: false, | ||
}, | ||
{ | ||
name: "invalid argument error", | ||
error: true, | ||
errorMessage: "Userspace error.", | ||
}, | ||
} | ||
|
||
for _, tc := range testCases { | ||
t.Run(tc.name, func(t *testing.T) { | ||
s.tracer.Reset() | ||
|
||
var err error | ||
if tc.error { | ||
req := &testpb.PingErrorRequest{ErrorCodeReturned: uint32(codes.InvalidArgument)} | ||
_, err = s.Client.PingError(s.SimpleCtx(), req) | ||
} else { | ||
req := &testpb.PingRequest{Value: "something"} | ||
_, err = s.Client.Ping(s.SimpleCtx(), req) | ||
} | ||
if tc.error { | ||
require.Error(t, err) | ||
} else { | ||
require.NoError(t, err) | ||
} | ||
|
||
clientSpans := s.tracer.ListSpan(tracing.SpanKindClient) | ||
serverSpans := s.tracer.ListSpan(tracing.SpanKindServer) | ||
require.Len(t, clientSpans, 1) | ||
require.Len(t, serverSpans, 1) | ||
|
||
clientSpan := clientSpans[0] | ||
assert.True(t, clientSpan.end) | ||
assert.Equal(t, 1, clientSpan.msgSendCounter) | ||
assert.Equal(t, 1, clientSpan.msgReceivedCounter) | ||
assert.Equal(t, []string{"message", "message"}, clientSpan.eventNameList) | ||
|
||
serverSpan := serverSpans[0] | ||
assert.True(t, serverSpan.end) | ||
assert.Equal(t, 1, serverSpan.msgSendCounter) | ||
assert.Equal(t, 1, serverSpan.msgReceivedCounter) | ||
assert.Equal(t, []string{"message", "message"}, serverSpan.eventNameList) | ||
|
||
assert.Equal(t, clientSpan.traceID, serverSpan.traceID) | ||
assert.Equal(t, clientSpan.spanID, serverSpan.parentSpanID) | ||
|
||
if tc.error { | ||
assert.Equal(t, codes.InvalidArgument, clientSpan.statusCode) | ||
assert.Equal(t, tc.errorMessage, clientSpan.statusMessage) | ||
assert.Equal(t, errorMethod, clientSpan.name) | ||
assert.Equal(t, [][]interface{}{{[]interface{}{"rpc.grpc.status_code", int64(3)}}}, clientSpan.attributesList) | ||
|
||
assert.Equal(t, errorMethod, serverSpan.name) | ||
assert.Equal(t, [][]interface{}{{[]interface{}{"rpc.grpc.status_code", int64(3)}}}, serverSpan.attributesList) | ||
} else { | ||
assert.Equal(t, codes.OK, clientSpan.statusCode) | ||
assert.Equal(t, method, clientSpan.name) | ||
assert.Equal(t, [][]interface{}{{[]interface{}{"rpc.grpc.status_code", int64(0)}}}, clientSpan.attributesList) | ||
|
||
assert.Equal(t, method, serverSpan.name) | ||
assert.Equal(t, [][]interface{}{{[]interface{}{"rpc.grpc.status_code", int64(0)}}}, serverSpan.attributesList) | ||
} | ||
}) | ||
} | ||
} | ||
|
||
func (s *tracingSuite) TestPingList() { | ||
t := s.T() | ||
method := "/testing.testpb.v1.TestService/PingList" | ||
|
||
stream, err := s.Client.PingList(s.SimpleCtx(), &testpb.PingListRequest{Value: "something"}) | ||
require.NoError(t, err) | ||
|
||
for { | ||
_, err := stream.Recv() | ||
if err == io.EOF { | ||
break | ||
} | ||
require.NoError(t, err) | ||
} | ||
|
||
clientSpans := s.tracer.ListSpan(tracing.SpanKindClient) | ||
serverSpans := s.tracer.ListSpan(tracing.SpanKindServer) | ||
require.Len(t, clientSpans, 1) | ||
require.Len(t, serverSpans, 1) | ||
|
||
clientSpan := clientSpans[0] | ||
assert.True(t, clientSpan.end) | ||
assert.Equal(t, 1, clientSpan.msgSendCounter) | ||
assert.Equal(t, testpb.ListResponseCount+1, clientSpan.msgReceivedCounter) | ||
assert.Equal(t, codes.OK, clientSpan.statusCode) | ||
assert.Equal(t, method, clientSpan.name) | ||
|
||
serverSpan := serverSpans[0] | ||
assert.True(t, serverSpan.end) | ||
assert.Equal(t, testpb.ListResponseCount, serverSpan.msgSendCounter) | ||
assert.Equal(t, 1, serverSpan.msgReceivedCounter) | ||
assert.Equal(t, codes.OK, serverSpan.statusCode) | ||
assert.Equal(t, method, serverSpan.name) | ||
} | ||
|
||
func TestSuite(t *testing.T) { | ||
tracer := newMockTracer() | ||
|
||
s := tracingSuite{ | ||
InterceptorTestSuite: &testpb.InterceptorTestSuite{ | ||
TestService: &testpb.TestPingService{T: t}, | ||
}, | ||
tracer: tracer, | ||
} | ||
s.InterceptorTestSuite.ClientOpts = []grpc.DialOption{ | ||
grpc.WithUnaryInterceptor(tracing.UnaryClientInterceptor(tracer)), | ||
grpc.WithStreamInterceptor(tracing.StreamClientInterceptor(tracer)), | ||
} | ||
s.InterceptorTestSuite.ServerOpts = []grpc.ServerOption{ | ||
grpc.ChainUnaryInterceptor( | ||
tracing.UnaryServerInterceptor(tracer), | ||
), | ||
grpc.ChainStreamInterceptor( | ||
tracing.StreamServerInterceptor(tracer), | ||
), | ||
} | ||
|
||
suite.Run(t, &s) | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks neat!