-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update the OTLP exporter batching of traces (#623)
Instead of batching based on the Resource pointer which is not guaranteed to uniquely identify common Resources, use the `String` method which is. Renames the external test package to be identified as the integration testing. This testing structure (the mock exporter) batches exported resources transmitted from the resource. This is needed as there is no guarantees that a batch will be exported in a single payload, therefore, it is not an ideal place to add resource batch testing for the exporter itself. Add unit tests to ensure the Exporter is correctly batching spans by resource.
- Loading branch information
Showing
4 changed files
with
268 additions
and
6 deletions.
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
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
File renamed without changes.
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,253 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package otlp | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
| "time" | ||
|
|
||
| coltracepb "github.com/open-telemetry/opentelemetry-proto/gen/go/collector/trace/v1" | ||
| commonpb "github.com/open-telemetry/opentelemetry-proto/gen/go/common/v1" | ||
| resourcepb "github.com/open-telemetry/opentelemetry-proto/gen/go/resource/v1" | ||
| tracepb "github.com/open-telemetry/opentelemetry-proto/gen/go/trace/v1" | ||
| "github.com/stretchr/testify/assert" | ||
| "google.golang.org/grpc" | ||
| "google.golang.org/grpc/codes" | ||
|
|
||
| "go.opentelemetry.io/otel/api/core" | ||
| apitrace "go.opentelemetry.io/otel/api/trace" | ||
| tracesdk "go.opentelemetry.io/otel/sdk/export/trace" | ||
| "go.opentelemetry.io/otel/sdk/resource" | ||
| ) | ||
|
|
||
| type traceServiceClientStub struct { | ||
| rs []tracepb.ResourceSpans | ||
| } | ||
|
|
||
| func (t *traceServiceClientStub) Export(ctx context.Context, in *coltracepb.ExportTraceServiceRequest, opts ...grpc.CallOption) (*coltracepb.ExportTraceServiceResponse, error) { | ||
| for _, rs := range in.GetResourceSpans() { | ||
| if rs == nil { | ||
| continue | ||
| } | ||
| t.rs = append(t.rs, *rs) | ||
| } | ||
| return &coltracepb.ExportTraceServiceResponse{}, nil | ||
| } | ||
|
|
||
| func (t *traceServiceClientStub) ResourceSpans() []tracepb.ResourceSpans { | ||
| return t.rs | ||
| } | ||
|
|
||
| func (t *traceServiceClientStub) Reset() { | ||
| t.rs = nil | ||
| } | ||
|
|
||
| func TestExportSpans(t *testing.T) { | ||
| tsc := &traceServiceClientStub{} | ||
| exp := NewUnstartedExporter() | ||
| exp.traceExporter = tsc | ||
| exp.started = true | ||
|
|
||
| // March 31, 2020 5:01:26 1234nanos (UTC) | ||
| startTime := time.Unix(1585674086, 1234) | ||
| endTime := startTime.Add(10 * time.Second) | ||
|
|
||
| for _, test := range []struct { | ||
| sd []*tracesdk.SpanData | ||
| want []tracepb.ResourceSpans | ||
| }{ | ||
| { | ||
| []*tracesdk.SpanData(nil), | ||
| []tracepb.ResourceSpans(nil), | ||
| }, | ||
| { | ||
| []*tracesdk.SpanData{}, | ||
| []tracepb.ResourceSpans(nil), | ||
| }, | ||
| { | ||
| []*tracesdk.SpanData{ | ||
| { | ||
| SpanContext: core.SpanContext{ | ||
| TraceID: core.TraceID([16]byte{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1}), | ||
| SpanID: core.SpanID([8]byte{0, 0, 0, 0, 0, 0, 0, 1}), | ||
| TraceFlags: byte(1), | ||
| }, | ||
| SpanKind: apitrace.SpanKindServer, | ||
| Name: "parent process", | ||
| StartTime: startTime, | ||
| EndTime: endTime, | ||
| Attributes: []core.KeyValue{ | ||
| core.Key("user").String("alice"), | ||
| core.Key("authenticated").Bool(true), | ||
| }, | ||
| StatusCode: codes.OK, | ||
| StatusMessage: "Ok", | ||
| Resource: resource.New(core.Key("instance").String("tester-a")), | ||
| }, | ||
| { | ||
| SpanContext: core.SpanContext{ | ||
| TraceID: core.TraceID([16]byte{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1}), | ||
| SpanID: core.SpanID([8]byte{0, 0, 0, 0, 0, 0, 0, 2}), | ||
| TraceFlags: byte(1), | ||
| }, | ||
| ParentSpanID: core.SpanID([8]byte{0, 0, 0, 0, 0, 0, 0, 1}), | ||
| SpanKind: apitrace.SpanKindInternal, | ||
| Name: "internal process", | ||
| StartTime: startTime, | ||
| EndTime: endTime, | ||
| Attributes: []core.KeyValue{ | ||
| core.Key("user").String("alice"), | ||
| core.Key("authenticated").Bool(true), | ||
| }, | ||
| StatusCode: codes.OK, | ||
| StatusMessage: "Ok", | ||
| Resource: resource.New(core.Key("instance").String("tester-a")), | ||
| }, | ||
| { | ||
| SpanContext: core.SpanContext{ | ||
| TraceID: core.TraceID([16]byte{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2}), | ||
| SpanID: core.SpanID([8]byte{0, 0, 0, 0, 0, 0, 0, 1}), | ||
| TraceFlags: byte(1), | ||
| }, | ||
| SpanKind: apitrace.SpanKindServer, | ||
| Name: "parent process", | ||
| StartTime: startTime, | ||
| EndTime: endTime, | ||
| Attributes: []core.KeyValue{ | ||
| core.Key("user").String("bob"), | ||
| core.Key("authenticated").Bool(false), | ||
| }, | ||
| StatusCode: codes.Unauthenticated, | ||
| StatusMessage: "Unauthenticated", | ||
| Resource: resource.New(core.Key("instance").String("tester-b")), | ||
| }, | ||
| }, | ||
| []tracepb.ResourceSpans{ | ||
| { | ||
| Resource: &resourcepb.Resource{ | ||
| Attributes: []*commonpb.AttributeKeyValue{ | ||
| { | ||
| Key: "instance", | ||
| Type: commonpb.AttributeKeyValue_STRING, | ||
| StringValue: "tester-a", | ||
| }, | ||
| }, | ||
| }, | ||
| InstrumentationLibrarySpans: []*tracepb.InstrumentationLibrarySpans{ | ||
| { | ||
| Spans: []*tracepb.Span{ | ||
| { | ||
| TraceId: []byte{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1}, | ||
| SpanId: []byte{0, 0, 0, 0, 0, 0, 0, 1}, | ||
| Name: "parent process", | ||
| Kind: tracepb.Span_SERVER, | ||
| StartTimeUnixNano: uint64(startTime.UnixNano()), | ||
| EndTimeUnixNano: uint64(endTime.UnixNano()), | ||
| Attributes: []*commonpb.AttributeKeyValue{ | ||
| { | ||
| Key: "user", | ||
| Type: commonpb.AttributeKeyValue_STRING, | ||
| StringValue: "alice", | ||
| }, | ||
| { | ||
| Key: "authenticated", | ||
| Type: commonpb.AttributeKeyValue_BOOL, | ||
| BoolValue: true, | ||
| }, | ||
| }, | ||
| Status: &tracepb.Status{ | ||
| Code: tracepb.Status_Ok, | ||
| Message: "Ok", | ||
| }, | ||
| }, | ||
| { | ||
| TraceId: []byte{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1}, | ||
| SpanId: []byte{0, 0, 0, 0, 0, 0, 0, 2}, | ||
| ParentSpanId: []byte{0, 0, 0, 0, 0, 0, 0, 1}, | ||
| Name: "internal process", | ||
| Kind: tracepb.Span_INTERNAL, | ||
| StartTimeUnixNano: uint64(startTime.UnixNano()), | ||
| EndTimeUnixNano: uint64(endTime.UnixNano()), | ||
| Attributes: []*commonpb.AttributeKeyValue{ | ||
| { | ||
| Key: "user", | ||
| Type: commonpb.AttributeKeyValue_STRING, | ||
| StringValue: "alice", | ||
| }, | ||
| { | ||
| Key: "authenticated", | ||
| Type: commonpb.AttributeKeyValue_BOOL, | ||
| BoolValue: true, | ||
| }, | ||
| }, | ||
| Status: &tracepb.Status{ | ||
| Code: tracepb.Status_Ok, | ||
| Message: "Ok", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| Resource: &resourcepb.Resource{ | ||
| Attributes: []*commonpb.AttributeKeyValue{ | ||
| { | ||
| Key: "instance", | ||
| Type: commonpb.AttributeKeyValue_STRING, | ||
| StringValue: "tester-b", | ||
| }, | ||
| }, | ||
| }, | ||
| InstrumentationLibrarySpans: []*tracepb.InstrumentationLibrarySpans{ | ||
| { | ||
| Spans: []*tracepb.Span{ | ||
| { | ||
| TraceId: []byte{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2}, | ||
| SpanId: []byte{0, 0, 0, 0, 0, 0, 0, 1}, | ||
| Name: "parent process", | ||
| Kind: tracepb.Span_SERVER, | ||
| StartTimeUnixNano: uint64(startTime.UnixNano()), | ||
| EndTimeUnixNano: uint64(endTime.UnixNano()), | ||
| Attributes: []*commonpb.AttributeKeyValue{ | ||
| { | ||
| Key: "user", | ||
| Type: commonpb.AttributeKeyValue_STRING, | ||
| StringValue: "bob", | ||
| }, | ||
| { | ||
| Key: "authenticated", | ||
| Type: commonpb.AttributeKeyValue_BOOL, | ||
| BoolValue: false, | ||
| }, | ||
| }, | ||
| Status: &tracepb.Status{ | ||
| Code: tracepb.Status_Unauthenticated, | ||
| Message: "Unauthenticated", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| } { | ||
| tsc.Reset() | ||
| exp.ExportSpans(context.Background(), test.sd) | ||
| assert.ElementsMatch(t, test.want, tsc.ResourceSpans()) | ||
| } | ||
| } |