-
Notifications
You must be signed in to change notification settings - Fork 1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add opencensus binary propagation bridge
- Loading branch information
Showing
9 changed files
with
442 additions
and
33 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| // 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 binary // import "go.opentelemetry.io/otel/bridge/opencensus/binary" | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| ocpropagation "go.opencensus.io/trace/propagation" | ||
|
|
||
| "go.opentelemetry.io/otel/bridge/opencensus/utils" | ||
| "go.opentelemetry.io/otel/propagation" | ||
| "go.opentelemetry.io/otel/trace" | ||
| ) | ||
|
|
||
| type key uint | ||
|
|
||
| const binaryKey key = 0 | ||
|
|
||
| // traceContextKey is the same as opencensus: | ||
| // https://github.com/census-instrumentation/opencensus-go/blob/3fb168f674736c026e623310bfccb0691e6dec8a/plugin/ocgrpc/trace_common.go#L30 | ||
| const binaryHeader = "grpc-trace-bin" | ||
|
|
||
| // Binary is an OpenTelemetry implementation of the OpenCensus grpc binary format. | ||
| // Binary propagation was temporarily removed from opentelemetry. See | ||
| // https://github.com/open-telemetry/opentelemetry-specification/issues/437 | ||
| type Binary struct{} | ||
|
|
||
| var _ propagation.TextMapPropagator = Binary{} | ||
|
|
||
| // Inject injects context into the TextMapCarrier | ||
| func (b Binary) Inject(ctx context.Context, carrier propagation.TextMapCarrier) { | ||
| binaryContext := ctx.Value(binaryKey) | ||
| if state, ok := binaryContext.(string); binaryContext != nil && ok { | ||
| carrier.Set(binaryHeader, state) | ||
| } | ||
|
|
||
| sc := trace.SpanContextFromContext(ctx) | ||
| if !sc.IsValid() { | ||
| return | ||
| } | ||
| h := ocpropagation.Binary(utils.OTelSpanContextToOc(sc)) | ||
| carrier.Set(binaryHeader, string(h)) | ||
| } | ||
|
|
||
| // Extract extracts the SpanContext from the TextMapCarrier | ||
| func (b Binary) Extract(ctx context.Context, carrier propagation.TextMapCarrier) context.Context { | ||
| state := carrier.Get(binaryHeader) | ||
| if state != "" { | ||
| ctx = context.WithValue(ctx, binaryKey, state) | ||
| } | ||
|
|
||
| sc := b.extract(carrier) | ||
| if !sc.IsValid() { | ||
| return ctx | ||
| } | ||
| return trace.ContextWithRemoteSpanContext(ctx, sc) | ||
| } | ||
|
|
||
| func (b Binary) extract(carrier propagation.TextMapCarrier) trace.SpanContext { | ||
| h := carrier.Get(binaryHeader) | ||
| if h == "" { | ||
| return trace.SpanContext{} | ||
| } | ||
| ocContext, ok := ocpropagation.FromBinary([]byte(h)) | ||
| if !ok { | ||
| return trace.SpanContext{} | ||
| } | ||
| return utils.OCSpanContextToOTel(ocContext) | ||
| } | ||
|
|
||
| // Fields returns the fields that this propagator modifies. | ||
| func (b Binary) Fields() []string { | ||
| return []string{binaryHeader} | ||
| } |
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,138 @@ | ||
| // 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 binary | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "net/http" | ||
| "testing" | ||
|
|
||
| "go.opentelemetry.io/otel/oteltest" | ||
| "go.opentelemetry.io/otel/trace" | ||
| ) | ||
|
|
||
| var ( | ||
| traceID = trace.TraceID([16]byte{14, 54, 12}) | ||
| spanID = trace.SpanID([8]byte{2, 8, 14, 20}) | ||
| childSpanID = trace.SpanID([8]byte{0, 0, 0, 0, 0, 0, 0, 2}) | ||
| headerFmt = "\x00\x00\x0e6\f\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00%s\x02%s" | ||
| ) | ||
|
|
||
| func TestFields(t *testing.T) { | ||
| b := Binary{} | ||
| fields := b.Fields() | ||
| if len(fields) != 1 { | ||
| t.Fatalf("Got %d fields, expected 1", len(fields)) | ||
| } | ||
| if fields[0] != "grpc-trace-bin" { | ||
| t.Errorf("Got fields[0] == %s, expected grpc-trace-bin", fields[0]) | ||
| } | ||
| } | ||
|
|
||
| func TestInject(t *testing.T) { | ||
| mockTracer := oteltest.DefaultTracer() | ||
| prop := Binary{} | ||
| for _, tt := range []struct { | ||
| desc string | ||
| sc trace.SpanContext | ||
| wantHeader string | ||
| }{ | ||
| { | ||
| desc: "valid spancontext, sampled", | ||
| sc: trace.SpanContext{ | ||
| TraceID: traceID, | ||
| SpanID: spanID, | ||
| TraceFlags: trace.FlagsSampled, | ||
| }, | ||
| wantHeader: fmt.Sprintf(headerFmt, "\x02", "\x01"), | ||
| }, | ||
| { | ||
| desc: "valid spancontext, not sampled", | ||
| sc: trace.SpanContext{ | ||
| TraceID: traceID, | ||
| SpanID: spanID, | ||
| }, | ||
| wantHeader: fmt.Sprintf(headerFmt, "\x03", "\x00"), | ||
| }, | ||
| { | ||
| desc: "valid spancontext, with unsupported bit set in traceflags", | ||
| sc: trace.SpanContext{ | ||
| TraceID: traceID, | ||
| SpanID: spanID, | ||
| TraceFlags: 0xff, | ||
| }, | ||
| wantHeader: fmt.Sprintf(headerFmt, "\x04", "\x01"), | ||
| }, | ||
| { | ||
| desc: "invalid spancontext", | ||
| sc: trace.SpanContext{}, | ||
| wantHeader: "", | ||
| }, | ||
| } { | ||
| t.Run(tt.desc, func(t *testing.T) { | ||
| req, _ := http.NewRequest("GET", "http://example.com", nil) | ||
| ctx := context.Background() | ||
| if tt.sc.IsValid() { | ||
| ctx = trace.ContextWithRemoteSpanContext(ctx, tt.sc) | ||
| ctx, _ = mockTracer.Start(ctx, "inject") | ||
| } | ||
| prop.Inject(ctx, req.Header) | ||
|
|
||
| gotHeader := req.Header.Get("grpc-trace-bin") | ||
| if gotHeader != tt.wantHeader { | ||
| t.Errorf("Got header = %q, want %q", gotHeader, tt.wantHeader) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
| func TestExtract(t *testing.T) { | ||
| prop := Binary{} | ||
| for _, tt := range []struct { | ||
| desc string | ||
| header string | ||
| wantSc trace.SpanContext | ||
| }{ | ||
| { | ||
| desc: "valid binary header", | ||
| header: fmt.Sprintf(headerFmt, "\x02", "\x00"), | ||
| wantSc: trace.SpanContext{ | ||
| TraceID: traceID, | ||
| SpanID: childSpanID, | ||
| }, | ||
| }, | ||
| { | ||
| desc: "valid binary and sampled", | ||
| header: fmt.Sprintf(headerFmt, "\x02", "\x01"), | ||
| wantSc: trace.SpanContext{ | ||
| TraceID: traceID, | ||
| SpanID: childSpanID, | ||
| TraceFlags: trace.FlagsSampled, | ||
| }, | ||
| }, | ||
| } { | ||
| t.Run(tt.desc, func(t *testing.T) { | ||
| req, _ := http.NewRequest("GET", "http://example.com", nil) | ||
| req.Header.Set("grpc-trace-bin", tt.header) | ||
|
|
||
| ctx := context.Background() | ||
| ctx = prop.Extract(ctx, req.Header) | ||
| gotSc := trace.RemoteSpanContextFromContext(ctx) | ||
| if gotSc != tt.wantSc { | ||
| t.Errorf("Got SpanContext: %+v, wanted %+v", gotSc, tt.wantSc) | ||
| } | ||
| }) | ||
| } | ||
| } |
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 |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| // 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 opencensus // import "go.opentelemetry.io/otel/bridge/opencensus" |
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 |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| // 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 utils // import "go.opentelemetry.io/otel/bridge/opencensus/utils" | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| octrace "go.opencensus.io/trace" | ||
|
|
||
| "go.opentelemetry.io/otel/global" | ||
| "go.opentelemetry.io/otel/trace" | ||
| ) | ||
|
|
||
| // OTelSpanContextToOc converts from an OpenTelemetry SpanContext to an | ||
| // OpenCensus SpanContext, and handles any incompatibilities with the global | ||
| // error handler. | ||
| func OTelSpanContextToOc(sc trace.SpanContext) octrace.SpanContext { | ||
| if sc.IsDebug() || sc.IsDeferred() { | ||
| global.Handle(fmt.Errorf("ignoring OpenTelemetry Debug or Deferred trace flags for span %q because they are not supported by OpenCensus", sc.SpanID)) | ||
| } | ||
| var to octrace.TraceOptions | ||
| if sc.IsSampled() { | ||
| // OpenCensus doesn't expose functions to directly set sampled | ||
| to = 0x1 | ||
| } | ||
| return octrace.SpanContext{ | ||
| TraceID: octrace.TraceID(sc.TraceID), | ||
| SpanID: octrace.SpanID(sc.SpanID), | ||
| TraceOptions: to, | ||
| } | ||
| } | ||
|
|
||
| // OCSpanContextToOTel converts from an OpenCensus SpanContext to an | ||
| // OpenTelemetry SpanContext. | ||
| func OCSpanContextToOTel(sc octrace.SpanContext) trace.SpanContext { | ||
| var traceFlags byte | ||
| if sc.IsSampled() { | ||
| traceFlags = trace.FlagsSampled | ||
| } | ||
| return trace.SpanContext{ | ||
| TraceID: trace.TraceID(sc.TraceID), | ||
| SpanID: trace.SpanID(sc.SpanID), | ||
| TraceFlags: traceFlags, | ||
| } | ||
| } |
Oops, something went wrong.