Add propagator interface and W3C propagator #85
- also remove PassThroughTracer
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| // Copyright 2019, 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 trace | ||
|
|
||
| import ( | ||
| "context" | ||
| "math/rand" | ||
| "sync/atomic" | ||
|
|
||
| "go.opentelemetry.io/api/core" | ||
| apitrace "go.opentelemetry.io/api/trace" | ||
| ) | ||
|
|
||
| // MockTracer is a simple tracer used for testing purpose only. | ||
| // It only supports ChildOf option. SpanId is atomically increased every time a | ||
| // new span is created. | ||
| type MockTracer struct { | ||
| // Sampled specifies if the new span should be sampled or not. | ||
| Sampled bool | ||
|
|
||
| // StartSpanId is used to initialize spanId. It is incremented by one | ||
| // every time a new span is created. | ||
| StartSpanId *uint64 | ||
| } | ||
|
|
||
| var _ apitrace.Tracer = (*MockTracer)(nil) | ||
|
|
||
| // WithResources does nothing and returns noop implementation of Tracer. | ||
| func (mt *MockTracer) WithResources(attributes ...core.KeyValue) apitrace.Tracer { | ||
| return mt | ||
| } | ||
|
|
||
| // WithComponent does nothing and returns noop implementation of Tracer. | ||
| func (mt *MockTracer) WithComponent(name string) apitrace.Tracer { | ||
| return mt | ||
| } | ||
|
|
||
| // WithService does nothing and returns noop implementation of Tracer. | ||
| func (mt *MockTracer) WithService(name string) apitrace.Tracer { | ||
| return mt | ||
| } | ||
|
|
||
| // WithSpan wraps around execution of func with noop span. | ||
| func (mt *MockTracer) WithSpan(ctx context.Context, name string, body func(context.Context) error) error { | ||
| return body(ctx) | ||
|
There was a problem hiding this comment. Shouldn't that do There was a problem hiding this comment. If needed for testing then yes. Otherwise it should be a noop. |
||
| } | ||
|
|
||
| // Start starts a MockSpan. It creates a new Span based on Reference SpanContext option. | ||
| // TracdID is used from Reference Span Context and SpanID is assigned. | ||
| // If Reference SpanContext option is not specified then random TraceID is used. | ||
| // No other options are supported. | ||
| func (mt *MockTracer) Start(ctx context.Context, name string, o ...apitrace.SpanOption) (context.Context, apitrace.Span) { | ||
| var opts apitrace.SpanOptions | ||
| for _, op := range o { | ||
| op(&opts) | ||
| } | ||
| var span *MockSpan | ||
| var sc core.SpanContext | ||
| if !opts.Reference.SpanContext.IsValid() { | ||
| sc = core.SpanContext{ | ||
| TraceID: core.TraceID{ | ||
| High: rand.Uint64(), | ||
| Low: rand.Uint64(), | ||
| }, | ||
| } | ||
| if mt.Sampled { | ||
| sc.TraceOptions = core.TraceOptionSampled | ||
| } | ||
| } else { | ||
| sc = opts.Reference.SpanContext | ||
| } | ||
| sc.SpanID = atomic.AddUint64(mt.StartSpanId, 1) | ||
| span = &MockSpan{ | ||
| sc: sc, | ||
| tracer: mt, | ||
| } | ||
|
|
||
| return apitrace.SetCurrentSpan(ctx, span), span | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -50,72 +50,71 @@ func (hp httpTraceContextPropagator) Inject(ctx context.Context, supplier apipro | ||
| } | ||
| } | ||
|
|
||
| func (hp httpTraceContextPropagator) Extract(ctx context.Context, supplier apipropagation.Supplier) core.SpanContext { | ||
| h := supplier.Get(traceparentHeader) | ||
| if h == "" { | ||
| return core.EmptySpanContext() | ||
| } | ||
|
|
||
| sections := strings.Split(h, "-") | ||
| if len(sections) < 4 { | ||
| return core.EmptySpanContext() | ||
| } | ||
|
|
||
|
There was a problem hiding this comment. Should we really check if all the characters in at least first four sections are either digits or lowercase letters from a to f? That's what the W3C trace context spec says in several places, like
or
|
||
| if len(sections[0]) != 2 { | ||
| return core.EmptySpanContext() | ||
| } | ||
| ver, err := hex.DecodeString(sections[0]) | ||
| if err != nil { | ||
| return core.EmptySpanContext() | ||
| } | ||
| version := int(ver[0]) | ||
| if version > maxVersion { | ||
|
There was a problem hiding this comment. Should this check be There was a problem hiding this comment. what is the expectation here? will version 1 be compatible with version 0? If so then it should just check for invalid value of the version. If not then it should check for specific version. There was a problem hiding this comment. I went through the spec and noticed this in 3.2.4 Versioning of traceparent:
So this needs to stay as is. |
||
| return core.EmptySpanContext() | ||
| } | ||
|
|
||
| if version == 0 && len(sections) != 4 { | ||
| return core.EmptySpanContext() | ||
| } | ||
|
|
||
| if len(sections[1]) != 32 { | ||
| return core.EmptySpanContext() | ||
| } | ||
|
|
||
| result, err := strconv.ParseUint(sections[1][0:16], 16, 64) | ||
| if err != nil { | ||
| return core.EmptySpanContext() | ||
| } | ||
| var sc core.SpanContext | ||
|
|
||
| sc.TraceID.High = result | ||
|
|
||
| result, err = strconv.ParseUint(sections[1][16:32], 16, 64) | ||
| if err != nil { | ||
| return core.EmptySpanContext() | ||
| } | ||
| sc.TraceID.Low = result | ||
|
|
||
|
There was a problem hiding this comment. Should we add a check
There was a problem hiding this comment. Never mind that - I see that we basically check it at the end of the function. |
||
| if len(sections[2]) != 16 { | ||
| return core.EmptySpanContext() | ||
| } | ||
| result, err = strconv.ParseUint(sections[2][0:], 16, 64) | ||
| if err != nil { | ||
|
There was a problem hiding this comment. Should this be
There was a problem hiding this comment. Never mind that, I see that we check it at the end of the function. |
||
| return core.EmptySpanContext() | ||
| } | ||
| sc.SpanID = result | ||
|
|
||
| opts, err := hex.DecodeString(sections[3]) | ||
|
There was a problem hiding this comment. We should check here if
There was a problem hiding this comment. Also, I wonder if we should have a check like
|
||
| if err != nil || len(opts) < 1 { | ||
| return core.EmptySpanContext() | ||
| } | ||
| sc.TraceOptions = opts[0] | ||
|
There was a problem hiding this comment. I think this should be |
||
|
|
||
| if !sc.IsValid() { | ||
| return core.EmptySpanContext() | ||
| } | ||
|
|
||
| return sc | ||
| } | ||
|
|
||
| func (hp httpTraceContextPropagator) GetAllKeys() []string { | ||
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.
And returns empty span context?
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.
fixed.