feat(logging): OpenTelemetry trace/span ID integration for Go logging library #10030
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
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 |
|---|---|---|
|
|
@@ -48,6 +48,9 @@ import ( | |
| "github.com/google/go-cmp/cmp" | ||
| "github.com/google/go-cmp/cmp/cmpopts" | ||
| gax "github.com/googleapis/gax-go/v2" | ||
| sdktrace "go.opentelemetry.io/otel/sdk/trace" | ||
| "go.opentelemetry.io/otel/trace" | ||
| "go.opentelemetry.io/otel/trace/noop" | ||
| "golang.org/x/oauth2" | ||
| "google.golang.org/api/iterator" | ||
| "google.golang.org/api/option" | ||
|
|
@@ -609,6 +612,132 @@ func TestToLogEntry(t *testing.T) { | |
| } | ||
| } | ||
|
|
||
| func TestToLogEntryOTelIntegration(t *testing.T) { | ||
| // Some slight modifications need to be done for testing ToLogEntry | ||
| // for the OpenTelemetry integration, so they are in a separate function. | ||
| u := &url.URL{Scheme: "http"} | ||
| tests := []struct { | ||
| name string | ||
| in logging.Entry | ||
| want *logpb.LogEntry // if want is nil, pull wants from spanContext | ||
| }{ | ||
| { | ||
| name: "Using OpenTelemetry with a valid span", | ||
| in: logging.Entry{ | ||
| HTTPRequest: &logging.HTTPRequest{ | ||
| Request: &http.Request{ | ||
| URL: u, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| name: "Using OpenTelemetry only with a valid span + valid traceparent headers (precedence test)", | ||
| in: logging.Entry{ | ||
| HTTPRequest: &logging.HTTPRequest{ | ||
| Request: &http.Request{ | ||
| URL: u, | ||
| Header: http.Header{ | ||
| "Traceparent": {"00-105445aa7843bc8bf206b12000100012-000000000000004a-01"}, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| name: "Using OpenTelemetry only with a valid span + valid XCTC headers (precedence test)", | ||
| in: logging.Entry{ | ||
| HTTPRequest: &logging.HTTPRequest{ | ||
| Request: &http.Request{ | ||
| URL: u, | ||
| Header: http.Header{ | ||
| "X-Cloud-Trace-Context": {"105445aa7843bc8bf206b120000000/0000000000000bbb;o=1"}, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| name: "Using OpenTelemetry with a valid span + trace info set in Entry object", | ||
| in: logging.Entry{ | ||
| HTTPRequest: &logging.HTTPRequest{ | ||
| Request: &http.Request{ | ||
| URL: u, | ||
| }, | ||
| }, | ||
| Trace: "abc", | ||
| SpanID: "def", | ||
| TraceSampled: false, | ||
| }, | ||
| want: &logpb.LogEntry{ | ||
| Trace: "abc", | ||
| SpanId: "def", | ||
| TraceSampled: false, | ||
| }, | ||
| }, | ||
| { | ||
| name: "Using OpenTelemetry without a request", | ||
| in: logging.Entry{}, | ||
| want: &logpb.LogEntry{}, | ||
| }, | ||
| } | ||
| for _, test := range tests { | ||
| t.Run(test.name, func(t *testing.T) { | ||
| var span trace.Span | ||
| ctx := context.Background() | ||
|
|
||
| // Set up an OTel SDK tracer if integration test, mock noop tracer if not. | ||
| if integrationTest { | ||
|
There was a problem hiding this comment. Do we have a dedicated place for integration tests in Go Logging library? There was a problem hiding this comment. I don't think we have any right now, but if enough system tests happen that are kinda different from integration tests controlled by the |
||
| tracerProvider := sdktrace.NewTracerProvider() | ||
| defer tracerProvider.Shutdown(ctx) | ||
|
|
||
| ctx, span = tracerProvider.Tracer("integration-test-tracer").Start(ctx, "test span") | ||
| defer span.End() | ||
| } else { | ||
| otelTraceID, _ := trace.TraceIDFromHex(strings.Repeat("a", 32)) | ||
| otelSpanID, _ := trace.SpanIDFromHex(strings.Repeat("f", 16)) | ||
| otelTraceFlags := trace.FlagsSampled // tracesampled = true | ||
| mockSpanContext := trace.NewSpanContext(trace.SpanContextConfig{ | ||
| TraceID: otelTraceID, | ||
| SpanID: otelSpanID, | ||
| TraceFlags: otelTraceFlags, | ||
| }) | ||
| ctx = trace.ContextWithSpanContext(ctx, mockSpanContext) | ||
| ctx, span = noop.NewTracerProvider().Tracer("test tracer").Start(ctx, "test span") | ||
| defer span.End() | ||
| } | ||
|
|
||
| if test.in.HTTPRequest != nil && test.in.HTTPRequest.Request != nil { | ||
| test.in.HTTPRequest.Request = test.in.HTTPRequest.Request.WithContext(ctx) | ||
| } | ||
| spanContext := trace.SpanContextFromContext(ctx) | ||
|
|
||
| // if want is nil, pull wants from spanContext | ||
| if test.want == nil { | ||
| test.want = &logpb.LogEntry{ | ||
| Trace: "projects/P/traces/" + spanContext.TraceID().String(), | ||
| SpanId: spanContext.SpanID().String(), | ||
| TraceSampled: spanContext.TraceFlags().IsSampled(), | ||
| } | ||
| } | ||
|
|
||
| e, err := logging.ToLogEntry(test.in, "projects/P") | ||
| if err != nil { | ||
| t.Fatalf("Unexpected error: %+v: %v", test.in, err) | ||
| } | ||
| if got := e.Trace; got != test.want.Trace { | ||
| t.Errorf("TraceId: %+v: SpanContext: %+v: got %q, want %q", test.in, spanContext, got, test.want.Trace) | ||
| } | ||
| if got := e.SpanId; got != test.want.SpanId { | ||
| t.Errorf("SpanId: %+v: SpanContext: %+v: got %q, want %q", test.in, spanContext, got, test.want.SpanId) | ||
| } | ||
| if got := e.TraceSampled; got != test.want.TraceSampled { | ||
| t.Errorf("TraceSampled: %+v: SpanContext: %+v: got %t, want %t", test.in, spanContext, got, test.want.TraceSampled) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| // compareEntries compares most fields list of Entries against expected. compareEntries does not compare: | ||
| // - HTTPRequest | ||
| // - Operation | ||
|
|
||
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.
Do we plan to add system tests to start otel span and compare auto-generated otel spanId with the injected logEntry spanId?
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.
@cindy-peng I just added an integration/system test for the exact same test case, just with different span setups.