mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-12 10:04:29 +02:00
Merge branch 'master' into standards
This commit is contained in:
Tyler Yahn
GitHub
commit
c8e23c22bc
@ -15,127 +15,361 @@ package grpctrace
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"sync"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/golang/protobuf/proto"
|
||||
"google.golang.org/grpc"
|
||||
"google.golang.org/grpc/metadata"
|
||||
|
||||
"go.opentelemetry.io/otel/api/kv"
|
||||
"go.opentelemetry.io/otel/api/kv/value"
|
||||
export "go.opentelemetry.io/otel/sdk/export/trace"
|
||||
sdktrace "go.opentelemetry.io/otel/sdk/trace"
|
||||
)
|
||||
|
||||
type testExporter struct {
|
||||
spanMap map[string][]*export.SpanData
|
||||
mu sync.Mutex
|
||||
spanMap map[string]*export.SpanData
|
||||
}
|
||||
|
||||
func (t *testExporter) ExportSpan(ctx context.Context, s *export.SpanData) {
|
||||
t.spanMap[s.Name] = append(t.spanMap[s.Name], s)
|
||||
t.mu.Lock()
|
||||
defer t.mu.Unlock()
|
||||
t.spanMap[s.Name] = s
|
||||
}
|
||||
|
||||
type mockCCInvoker struct {
|
||||
type mockUICInvoker struct {
|
||||
ctx context.Context
|
||||
}
|
||||
|
||||
func (mcci *mockCCInvoker) invoke(ctx context.Context, method string, req, reply interface{}, cc *grpc.ClientConn, opts ...grpc.CallOption) error {
|
||||
mcci.ctx = ctx
|
||||
func (mcuici *mockUICInvoker) invoker(ctx context.Context, method string, req, reply interface{}, cc *grpc.ClientConn, opts ...grpc.CallOption) error {
|
||||
mcuici.ctx = ctx
|
||||
return nil
|
||||
}
|
||||
|
||||
type mockProtoMessage struct {
|
||||
type mockProtoMessage struct{}
|
||||
|
||||
func (mm *mockProtoMessage) Reset() {
|
||||
}
|
||||
|
||||
func (mm *mockProtoMessage) Reset() {}
|
||||
func (mm *mockProtoMessage) String() string { return "mock" }
|
||||
func (mm *mockProtoMessage) ProtoMessage() {}
|
||||
|
||||
type nameAttributeTestCase struct {
|
||||
testName string
|
||||
expectedName string
|
||||
fullNameFmt string
|
||||
func (mm *mockProtoMessage) String() string {
|
||||
return "mock"
|
||||
}
|
||||
|
||||
func (tc nameAttributeTestCase) fullName() string {
|
||||
return fmt.Sprintf(tc.fullNameFmt, tc.expectedName)
|
||||
func (mm *mockProtoMessage) ProtoMessage() {
|
||||
}
|
||||
|
||||
func TestUCISetsExpectedServiceNameAttribute(t *testing.T) {
|
||||
testCases := []nameAttributeTestCase{
|
||||
{
|
||||
"FullyQualifiedMethodName",
|
||||
"serviceName",
|
||||
"/github.com.foo.%s/bar",
|
||||
},
|
||||
{
|
||||
"SimpleMethodName",
|
||||
"serviceName",
|
||||
"/%s/bar",
|
||||
},
|
||||
{
|
||||
"MethodNameWithoutFullPath",
|
||||
"serviceName",
|
||||
"%s/bar",
|
||||
},
|
||||
{
|
||||
"InvalidMethodName",
|
||||
"",
|
||||
"invalidName",
|
||||
},
|
||||
{
|
||||
"NonAlphanumericMethodName",
|
||||
"serviceName_123",
|
||||
"/github.com.foo.%s/method",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tc := range testCases {
|
||||
t.Run(tc.testName, tc.testUCISetsExpectedNameAttribute)
|
||||
}
|
||||
}
|
||||
|
||||
func (tc nameAttributeTestCase) testUCISetsExpectedNameAttribute(t *testing.T) {
|
||||
exp := &testExporter{make(map[string][]*export.SpanData)}
|
||||
func TestUnaryClientInterceptor(t *testing.T) {
|
||||
exp := &testExporter{spanMap: make(map[string]*export.SpanData)}
|
||||
tp, _ := sdktrace.NewProvider(sdktrace.WithSyncer(exp),
|
||||
sdktrace.WithConfig(sdktrace.Config{DefaultSampler: sdktrace.AlwaysSample()}))
|
||||
|
||||
tr := tp.Tracer("grpctrace/client")
|
||||
ctx, span := tr.Start(context.Background(), tc.testName)
|
||||
defer span.End()
|
||||
sdktrace.WithConfig(sdktrace.Config{
|
||||
DefaultSampler: sdktrace.AlwaysSample(),
|
||||
},
|
||||
))
|
||||
|
||||
clientConn, err := grpc.Dial("fake:connection", grpc.WithInsecure())
|
||||
|
||||
if err != nil {
|
||||
t.Fatalf("failed to create client connection: %v", err)
|
||||
}
|
||||
|
||||
unaryInt := UnaryClientInterceptor(tr)
|
||||
tracer := tp.Tracer("grpctrace/client")
|
||||
unaryInterceptor := UnaryClientInterceptor(tracer)
|
||||
|
||||
req := &mockProtoMessage{}
|
||||
reply := &mockProtoMessage{}
|
||||
ccInvoker := &mockCCInvoker{}
|
||||
uniInterceptorInvoker := &mockUICInvoker{}
|
||||
|
||||
err = unaryInt(ctx, tc.fullName(), req, reply, clientConn, ccInvoker.invoke)
|
||||
checks := []struct {
|
||||
name string
|
||||
expectedAttr map[kv.Key]value.Value
|
||||
eventsAttr []map[kv.Key]value.Value
|
||||
}{
|
||||
{
|
||||
name: "/github.com.serviceName/bar",
|
||||
expectedAttr: map[kv.Key]value.Value{
|
||||
rpcServiceKey: value.String("serviceName"),
|
||||
netPeerIPKey: value.String("fake"),
|
||||
netPeerPortKey: value.String("connection"),
|
||||
},
|
||||
eventsAttr: []map[kv.Key]value.Value{
|
||||
{
|
||||
messageTypeKey: value.String("SENT"),
|
||||
messageIDKey: value.Int(1),
|
||||
messageUncompressedSizeKey: value.Int(proto.Size(proto.Message(req))),
|
||||
},
|
||||
{
|
||||
messageTypeKey: value.String("RECEIVED"),
|
||||
messageIDKey: value.Int(1),
|
||||
messageUncompressedSizeKey: value.Int(proto.Size(proto.Message(reply))),
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "/serviceName/bar",
|
||||
expectedAttr: map[kv.Key]value.Value{
|
||||
rpcServiceKey: value.String("serviceName"),
|
||||
netPeerIPKey: value.String("fake"),
|
||||
netPeerPortKey: value.String("connection"),
|
||||
},
|
||||
eventsAttr: []map[kv.Key]value.Value{
|
||||
{
|
||||
messageTypeKey: value.String("SENT"),
|
||||
messageIDKey: value.Int(1),
|
||||
messageUncompressedSizeKey: value.Int(proto.Size(proto.Message(req))),
|
||||
},
|
||||
{
|
||||
messageTypeKey: value.String("RECEIVED"),
|
||||
messageIDKey: value.Int(1),
|
||||
messageUncompressedSizeKey: value.Int(proto.Size(proto.Message(reply))),
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "serviceName/bar",
|
||||
expectedAttr: map[kv.Key]value.Value{
|
||||
rpcServiceKey: value.String("serviceName"),
|
||||
netPeerIPKey: value.String("fake"),
|
||||
netPeerPortKey: value.String("connection"),
|
||||
},
|
||||
eventsAttr: []map[kv.Key]value.Value{
|
||||
{
|
||||
messageTypeKey: value.String("SENT"),
|
||||
messageIDKey: value.Int(1),
|
||||
messageUncompressedSizeKey: value.Int(proto.Size(proto.Message(req))),
|
||||
},
|
||||
{
|
||||
messageTypeKey: value.String("RECEIVED"),
|
||||
messageIDKey: value.Int(1),
|
||||
messageUncompressedSizeKey: value.Int(proto.Size(proto.Message(reply))),
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "invalidName",
|
||||
expectedAttr: map[kv.Key]value.Value{
|
||||
rpcServiceKey: value.String(""),
|
||||
netPeerIPKey: value.String("fake"),
|
||||
netPeerPortKey: value.String("connection"),
|
||||
},
|
||||
eventsAttr: []map[kv.Key]value.Value{
|
||||
{
|
||||
messageTypeKey: value.String("SENT"),
|
||||
messageIDKey: value.Int(1),
|
||||
messageUncompressedSizeKey: value.Int(proto.Size(proto.Message(req))),
|
||||
},
|
||||
{
|
||||
messageTypeKey: value.String("RECEIVED"),
|
||||
messageIDKey: value.Int(1),
|
||||
messageUncompressedSizeKey: value.Int(proto.Size(proto.Message(reply))),
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "/github.com.foo.serviceName_123/method",
|
||||
expectedAttr: map[kv.Key]value.Value{
|
||||
rpcServiceKey: value.String("serviceName_123"),
|
||||
netPeerIPKey: value.String("fake"),
|
||||
netPeerPortKey: value.String("connection"),
|
||||
},
|
||||
eventsAttr: []map[kv.Key]value.Value{
|
||||
{
|
||||
messageTypeKey: value.String("SENT"),
|
||||
messageIDKey: value.Int(1),
|
||||
messageUncompressedSizeKey: value.Int(proto.Size(proto.Message(req))),
|
||||
},
|
||||
{
|
||||
messageTypeKey: value.String("RECEIVED"),
|
||||
messageIDKey: value.Int(1),
|
||||
messageUncompressedSizeKey: value.Int(proto.Size(proto.Message(reply))),
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, check := range checks {
|
||||
err = unaryInterceptor(context.Background(), check.name, req, reply, clientConn, uniInterceptorInvoker.invoker)
|
||||
if err != nil {
|
||||
t.Errorf("failed to run unary interceptor: %v", err)
|
||||
continue
|
||||
}
|
||||
|
||||
spanData, ok := exp.spanMap[check.name]
|
||||
if !ok {
|
||||
t.Errorf("no span data found for name < %s >", check.name)
|
||||
continue
|
||||
}
|
||||
|
||||
attrs := spanData.Attributes
|
||||
if len(check.expectedAttr) > len(attrs) {
|
||||
t.Errorf("attributes received are less than expected attributes, received %d, expected %d",
|
||||
len(attrs), len(check.expectedAttr))
|
||||
}
|
||||
for _, attr := range attrs {
|
||||
expectedAttr, ok := check.expectedAttr[attr.Key]
|
||||
if ok {
|
||||
if expectedAttr != attr.Value {
|
||||
t.Errorf("name: %s invalid %s found. expected %s, actual %s", check.name, string(attr.Key),
|
||||
expectedAttr.AsString(), attr.Value.AsString())
|
||||
}
|
||||
delete(check.expectedAttr, attr.Key)
|
||||
} else {
|
||||
t.Errorf("attribute %s not found in expected attributes map", string(attr.Key))
|
||||
}
|
||||
}
|
||||
|
||||
// Check if any expected attr not seen
|
||||
if len(check.expectedAttr) > 0 {
|
||||
for attr := range check.expectedAttr {
|
||||
t.Errorf("missing attribute %s in span", string(attr))
|
||||
}
|
||||
}
|
||||
|
||||
events := spanData.MessageEvents
|
||||
if len(check.eventsAttr) > len(events) {
|
||||
t.Errorf("events received are less than expected events, received %d, expected %d",
|
||||
len(events), len(check.eventsAttr))
|
||||
}
|
||||
for event := 0; event < len(check.eventsAttr); event++ {
|
||||
for _, attr := range events[event].Attributes {
|
||||
expectedAttr, ok := check.eventsAttr[event][attr.Key]
|
||||
if ok {
|
||||
if attr.Value != expectedAttr {
|
||||
t.Errorf("invalid value for attribute %s in events, expected %s actual %s",
|
||||
string(attr.Key), attr.Value.AsString(), expectedAttr.AsString())
|
||||
}
|
||||
delete(check.eventsAttr[event], attr.Key)
|
||||
} else {
|
||||
t.Errorf("attribute in event %s not found in expected attributes map", string(attr.Key))
|
||||
}
|
||||
}
|
||||
if len(check.eventsAttr[event]) > 0 {
|
||||
for attr := range check.eventsAttr[event] {
|
||||
t.Errorf("missing attribute %s in span event", string(attr))
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
type mockClientStream struct {
|
||||
Desc *grpc.StreamDesc
|
||||
Ctx context.Context
|
||||
}
|
||||
|
||||
func (mockClientStream) SendMsg(m interface{}) error { return nil }
|
||||
func (mockClientStream) RecvMsg(m interface{}) error { return nil }
|
||||
func (mockClientStream) CloseSend() error { return nil }
|
||||
func (c mockClientStream) Context() context.Context { return c.Ctx }
|
||||
func (mockClientStream) Header() (metadata.MD, error) { return nil, nil }
|
||||
func (mockClientStream) Trailer() metadata.MD { return nil }
|
||||
|
||||
func TestStreamClientInterceptor(t *testing.T) {
|
||||
exp := &testExporter{spanMap: make(map[string]*export.SpanData)}
|
||||
tp, _ := sdktrace.NewProvider(sdktrace.WithSyncer(exp),
|
||||
sdktrace.WithConfig(sdktrace.Config{
|
||||
DefaultSampler: sdktrace.AlwaysSample(),
|
||||
},
|
||||
))
|
||||
clientConn, err := grpc.Dial("fake:connection", grpc.WithInsecure())
|
||||
if err != nil {
|
||||
t.Fatalf("failed to run unary interceptor: %v", err)
|
||||
t.Fatalf("failed to create client connection: %v", err)
|
||||
}
|
||||
|
||||
spanData, hasSpanData := exp.spanMap[tc.fullName()]
|
||||
// tracer
|
||||
tracer := tp.Tracer("grpctrace/Server")
|
||||
streamCI := StreamClientInterceptor(tracer)
|
||||
|
||||
if !hasSpanData || len(spanData) == 0 {
|
||||
t.Fatalf("no span data found for name < %s >", tc.fullName())
|
||||
var mockClStr mockClientStream
|
||||
methodName := "/github.com.serviceName/bar"
|
||||
|
||||
streamClient, err := streamCI(context.Background(),
|
||||
&grpc.StreamDesc{ServerStreams: true},
|
||||
clientConn,
|
||||
methodName,
|
||||
func(ctx context.Context,
|
||||
desc *grpc.StreamDesc,
|
||||
cc *grpc.ClientConn,
|
||||
method string,
|
||||
opts ...grpc.CallOption) (grpc.ClientStream, error) {
|
||||
mockClStr = mockClientStream{Desc: desc, Ctx: ctx}
|
||||
return mockClStr, nil
|
||||
})
|
||||
|
||||
if err != nil {
|
||||
t.Fatalf("failed to initialize grpc stream client: %v", err)
|
||||
}
|
||||
|
||||
attributes := spanData[0].Attributes
|
||||
// no span exported while stream is open
|
||||
if _, ok := exp.spanMap[methodName]; ok {
|
||||
t.Fatalf("span shouldn't end while stream is open")
|
||||
}
|
||||
|
||||
var actualServiceName string
|
||||
for _, attr := range attributes {
|
||||
if attr.Key == rpcServiceKey {
|
||||
actualServiceName = attr.Value.AsString()
|
||||
req := &mockProtoMessage{}
|
||||
reply := &mockProtoMessage{}
|
||||
|
||||
// send and receive fake data
|
||||
for i := 0; i < 10; i++ {
|
||||
_ = streamClient.SendMsg(req)
|
||||
_ = streamClient.RecvMsg(reply)
|
||||
}
|
||||
|
||||
// close client and server stream
|
||||
_ = streamClient.CloseSend()
|
||||
mockClStr.Desc.ServerStreams = false
|
||||
_ = streamClient.RecvMsg(reply)
|
||||
|
||||
// added retry because span end is called in separate go routine
|
||||
var spanData *export.SpanData
|
||||
for retry := 0; retry < 5; retry++ {
|
||||
ok := false
|
||||
exp.mu.Lock()
|
||||
spanData, ok = exp.spanMap[methodName]
|
||||
exp.mu.Unlock()
|
||||
if ok {
|
||||
break
|
||||
}
|
||||
time.Sleep(time.Second * 1)
|
||||
}
|
||||
if spanData == nil {
|
||||
t.Fatalf("no span data found for name < %s >", methodName)
|
||||
}
|
||||
|
||||
attrs := spanData.Attributes
|
||||
expectedAttr := map[kv.Key]string{
|
||||
rpcServiceKey: "serviceName",
|
||||
netPeerIPKey: "fake",
|
||||
netPeerPortKey: "connection",
|
||||
}
|
||||
|
||||
for _, attr := range attrs {
|
||||
expected, ok := expectedAttr[attr.Key]
|
||||
if ok {
|
||||
if expected != attr.Value.AsString() {
|
||||
t.Errorf("name: %s invalid %s found. expected %s, actual %s", methodName, string(attr.Key),
|
||||
expected, attr.Value.AsString())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if tc.expectedName != actualServiceName {
|
||||
t.Fatalf("invalid service name found. expected %s, actual %s",
|
||||
tc.expectedName, actualServiceName)
|
||||
events := spanData.MessageEvents
|
||||
if len(events) != 20 {
|
||||
t.Fatalf("incorrect number of events expected 20 got %d", len(events))
|
||||
}
|
||||
for i := 0; i < 20; i += 2 {
|
||||
msgID := i/2 + 1
|
||||
validate := func(eventName string, attrs []kv.KeyValue) {
|
||||
for _, attr := range attrs {
|
||||
if attr.Key == messageTypeKey && attr.Value.AsString() != eventName {
|
||||
t.Errorf("invalid event on index: %d expecting %s event, receive %s event", i, eventName, attr.Value.AsString())
|
||||
}
|
||||
if attr.Key == messageIDKey && attr.Value != value.Int(msgID) {
|
||||
t.Errorf("invalid id for message event expected %d received %d", msgID, attr.Value.AsInt32())
|
||||
}
|
||||
}
|
||||
}
|
||||
validate("SENT", events[i].Attributes)
|
||||
validate("RECEIVED", events[i+1].Attributes)
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user