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.

Sign up for GitHub

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

Jump to bottom

Integrate TraceState with http_trace_context propagator #563

Merged
merged 7 commits into from
Mar 4, 2021
Merged

Integrate TraceState with http_trace_context propagator #563

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c5dfaaa
fix
lalitb Feb 5, 2021
4bddf91
Merge branch 'main' into w3c-tracestate
lalitb Feb 26, 2021
3844b8a
fix
lalitb Feb 26, 2021
abf0e08
add tests
lalitb Feb 26, 2021
d7d2bcd
Merge branch 'main' into w3c-tracestate
lalitb Mar 3, 2021
eb30695
Merge branch 'main' into w3c-tracestate
lalitb Mar 4, 2021
6833336
Merge branch 'main' into w3c-tracestate
lalitb Mar 4, 2021
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
15 changes: 10 additions & 5 deletions api/include/opentelemetry/trace/propagation/http_trace_context.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ class HttpTraceContext : public TextMapPropagator<T>
}
}

static void InjectTraceParent(const SpanContext &span_context, T &carrier, Setter setter)
static void InjectTraceHeaders(const SpanContext &span_context, T &carrier, Setter setter)
{
char trace_id[32];
TraceId(span_context.trace_id()).ToLowerBase16(trace_id);
Expand All @@ -199,11 +199,12 @@ class HttpTraceContext : public TextMapPropagator<T>
hex_string.push_back(trace_flags[i]);
}
setter(carrier, kTraceParent, hex_string);
setter(carrier, kTraceState, span_context.trace_state()->ToHeader());
}

static void InjectImpl(Setter setter, T &carrier, const SpanContext &span_context)
{
InjectTraceParent(span_context, carrier, setter);
InjectTraceHeaders(span_context, carrier, setter);
}

static bool IsValidHex(nostd::string_view string_view)
Expand All @@ -217,7 +218,8 @@ class HttpTraceContext : public TextMapPropagator<T>
return true;
}

static SpanContext ExtractContextFromTraceParent(nostd::string_view trace_parent)
static SpanContext ExtractContextFromTraceHeaders(nostd::string_view trace_parent,
nostd::string_view trace_state)
{
if (trace_parent.length() != kHeaderSize || trace_parent[kHeaderElementLengths[0]] != '-' ||
trace_parent[kHeaderElementLengths[0] + kHeaderElementLengths[1] + 1] != '-' ||
Expand Down Expand Up @@ -251,18 +253,21 @@ class HttpTraceContext : public TextMapPropagator<T>
TraceId trace_id_obj = GenerateTraceIdFromString(trace_id);
SpanId span_id_obj = GenerateSpanIdFromString(span_id);
TraceFlags trace_flags_obj = GenerateTraceFlagsFromString(trace_flags);
return SpanContext(trace_id_obj, span_id_obj, trace_flags_obj, true);

return SpanContext(trace_id_obj, span_id_obj, trace_flags_obj, true,
opentelemetry::trace::TraceState::FromHeader(trace_state));
}

static SpanContext ExtractImpl(Getter getter, const T &carrier)
{
nostd::string_view trace_parent = getter(carrier, kTraceParent);
nostd::string_view trace_state = getter(carrier, kTraceState);
if (trace_parent == "")
{
return SpanContext(false, false);
}

return ExtractContextFromTraceParent(trace_parent);
return ExtractContextFromTraceHeaders(trace_parent, trace_state);
}
};
} // namespace propagation
Expand Down
23 changes: 22 additions & 1 deletion api/test/trace/propagation/http_text_format_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,23 @@ TEST(TextMapPropagatorTest, NoSendEmptyTraceState)
EXPECT_FALSE(carrier.count("tracestate") > 0);
}

TEST(TextMapPropagatorTest, PropogateTraceState)
{
const std::map<std::string, std::string> carrier = {
{"traceparent", "00-4bf92f3577b34da6a3ce929d0e0e4736-0102030405060708-01"},
{"tracestate", "congo=t61rcWkgMzE"}};
context::Context ctx1 = context::Context{
"current-span",
nostd::shared_ptr<trace::Span>(new trace::DefaultSpan(trace::SpanContext::GetInvalid()))};
context::Context ctx2 = format.Extract(Getter, carrier, ctx1);
std::map<std::string, std::string> c2 = {};
format.Inject(Setter, c2, ctx2);

EXPECT_TRUE(carrier.count("traceparent") > 0);
EXPECT_TRUE(carrier.count("tracestate") > 0);
EXPECT_EQ(c2["tracestate"], "congo=t61rcWkgMzE");
}

TEST(TextMapPropagatorTest, PropagateInvalidContext)
{
// Do not propagate invalid trace context.
Expand All @@ -94,6 +111,7 @@ TEST(TextMapPropagatorTest, PropagateInvalidContext)
nostd::shared_ptr<trace::Span>(new trace::DefaultSpan(trace::SpanContext::GetInvalid()))};
format.Inject(Setter, carrier, ctx);
EXPECT_TRUE(carrier.count("traceparent") == 0);
EXPECT_TRUE(carrier.count("tracestate") == 0);
}

TEST(TextMapPropagatorTest, SetRemoteSpan)
Expand All @@ -118,8 +136,10 @@ TEST(TextMapPropagatorTest, GetCurrentSpan)
{
constexpr uint8_t buf_span[] = {1, 2, 3, 4, 5, 6, 7, 8};
constexpr uint8_t buf_trace[] = {1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16};

auto trace_state = trace::TraceState::FromHeader("congo=t61rcWkgMzE");
trace::SpanContext span_context{trace::TraceId{buf_trace}, trace::SpanId{buf_span},
trace::TraceFlags{true}, false};
trace::TraceFlags{true}, false, trace_state};
nostd::shared_ptr<trace::Span> sp{new trace::DefaultSpan{span_context}};

// Set `sp` as the currently active span, which must be used by `Inject`.
Expand All @@ -128,4 +148,5 @@ TEST(TextMapPropagatorTest, GetCurrentSpan)
std::map<std::string, std::string> headers = {};
format.Inject(Setter, headers, context::RuntimeContext::GetCurrent());
EXPECT_EQ(headers["traceparent"], "00-0102030405060708090a0b0c0d0e0f10-0102030405060708-01");
EXPECT_EQ(headers["tracestate"], "congo=t61rcWkgMzE");
}