Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Handle tracestate in TraceContext propagator #1447

Merged
merged 4 commits into from
Jan 12, 2021
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Prevent invalid tracestate from invalidating traceparent.
Signed-off-by: Anthony J Mirabella <a9@aneurysm9.com>
Aneurysm9 committed Jan 12, 2021

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
commit 8e6b1f963b070e74d4b5e1cbf4b92739194de4c4
21 changes: 13 additions & 8 deletions propagation/trace_context.go
Original file line number Diff line number Diff line change
@@ -132,11 +132,7 @@ func (tc TraceContext) extract(carrier TextMapCarrier) trace.SpanContext {
// Clear all flags other than the trace-context supported sampling bit.
sc.TraceFlags = opts[0] & trace.FlagsSampled

ts, err := parseTraceState(carrier.Get(tracestateHeader))
if err != nil {
return trace.SpanContext{}
}
sc.TraceState = ts
sc.TraceState = parseTraceState(carrier.Get(tracestateHeader))

if !sc.IsValid() {
return trace.SpanContext{}
@@ -150,15 +146,24 @@ func (tc TraceContext) Fields() []string {
return []string{traceparentHeader, tracestateHeader}
}

func parseTraceState(in string) (trace.TraceState, error) {
func parseTraceState(in string) trace.TraceState {
if in == "" {
return trace.TraceState{}, nil
return trace.TraceState{}
}

kvs := []label.KeyValue{}
for _, entry := range strings.Split(in, ",") {
parts := strings.SplitN(entry, "=", 2)
if len(parts) != 2 {
// Parse failure, abort!
return trace.TraceState{}
}
kvs = append(kvs, label.String(parts[0], parts[1]))
}
return trace.TraceStateFromKeyValues(kvs...)

// Ignoring error here as "failure to parse tracestate MUST NOT
// affect the parsing of traceparent."
// https://www.w3.org/TR/trace-context/#tracestate-header
ts, _ := trace.TraceStateFromKeyValues(kvs...)
return ts
}
19 changes: 17 additions & 2 deletions propagation/trace_context_test.go
Original file line number Diff line number Diff line change
@@ -307,8 +307,23 @@ func TestTraceStatePropagation(t *testing.T) {
parentHeader: "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00",
stateHeader: "key1=value1,invalid$@#=invalid",
},
valid: false,
wantSc: trace.SpanContext{},
valid: false,
wantSc: trace.SpanContext{
TraceID: traceID,
SpanID: spanID,
},
},
{
name: "valid parent, malformed state",
headers: map[string]string{
parentHeader: "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00",
stateHeader: "key1=value1,invalid",
},
valid: false,
wantSc: trace.SpanContext{
TraceID: traceID,
SpanID: spanID,
},
},
}