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

W3C Phase 3 Extract p Regardless of Order #2385

Merged
merged 17 commits into from
May 15, 2024
Merged

W3C Phase 3 Extract p Regardless of Order #2385

Changes from 4 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
281e99a
Updating .NET to supported version
link04 Apr 22, 2024
e3bf0db
Adding W3C Phase 2 test
link04 Apr 23, 2024
4a5177a
Removing not needed tag from test
link04 Apr 23, 2024
5e57fd6
Updating test and running lint
link04 Apr 24, 2024
e121ae9
Adressing PR comments
link04 Apr 24, 2024
4b960bb
Updated based on RFC discussion
link04 Apr 29, 2024
890362c
Skipping for now as it passes locally
link04 Apr 30, 2024
becef58
Updated based on the latest RFC clarification/changes
link04 May 9, 2024
bf51452
munir - update phase 3 tests to match new spec
mabdinur May 9, 2024
e8fefee
update system tests to match spec
mabdinur May 13, 2024
7e1e190
rfc update: p value takes precedence over x-datadog headers
mabdinur May 14, 2024
aa8fd91
fix skip annotations and remove comments
mabdinur May 14, 2024
b3b3370
clean up extract first test
mabdinur May 14, 2024
635e898
Apply suggestions from code review
mabdinur May 14, 2024
65e92fa
Merge branch 'main' into maximo/w3c-phase-3
mabdinur May 14, 2024
a7c369d
support fallback 2
mabdinur May 14, 2024
b5996ce
Revert "support fallback 2"
mabdinur May 15, 2024
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
206 changes: 204 additions & 2 deletions tests/parametric/test_headers_tracecontext.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,13 @@ def temporary_enable_optin_tracecontext_single_key() -> Any:
return parametrize("library_env", [env])


def temporary_enable_optin_extract_first() -> Any:
env = {
"DD_TRACE_PROPAGATION_EXTRACT_FIRST": "true",
}
return parametrize("library_env", [env])


link04 marked this conversation as resolved.
Show resolved Hide resolved
@scenarios.parametric
@features.datadog_headers_propagation
class Test_Headers_Tracecontext:
Expand Down Expand Up @@ -715,7 +722,7 @@ def test_tracestate_duplicated_keys(self, test_agent, test_library):
assert "foo=1" in str(tracestate4) or "foo=2" in str(tracestate4)

@missing_feature(context.library < "python@2.7.0", reason="Not implemented")
@missing_feature(context.library == "dotnet", reason="Not implemented")
@missing_feature(context.library < "dotnet@2.51.0", reason="Not implemented")
@missing_feature(context.library < "php@0.99.0", reason="Not implemented")
@missing_feature(context.library < "nodejs@5.6.0", reason="Not implemented")
@missing_feature(context.library == "java", reason="Not implemented")
Expand Down Expand Up @@ -785,7 +792,7 @@ def test_tracestate_w3c_p_extract(self, test_agent, test_library):
assert case4["meta"]["_dd.parent_id"] == "0000000000000000"

@missing_feature(context.library < "python@2.7.0", reason="Not implemented")
@missing_feature(context.library == "dotnet", reason="Not implemented")
@missing_feature(context.library < "dotnet@2.51.0", reason="Not implemented")
@missing_feature(context.library < "php@0.99.0", reason="Not implemented")
@missing_feature(context.library < "nodejs@5.6.0", reason="Not implemented")
@missing_feature(context.library == "java", reason="Not implemented")
Expand All @@ -807,6 +814,201 @@ def test_tracestate_w3c_p_inject(self, test_agent, test_library):
# FIXME: nodejs paramerric app sets span.span_id to a string, convert this to an int
assert "p:{:016x}".format(int(span.span_id)) in tracestate

# W3C Phase 3 to try adding the tag if the span id matches regardless of headers order(if tracecontext is accounted)
@missing_feature(context.library == "python", reason="Not implemented")
@missing_feature(context.library < "dotnet@2.51.0", reason="Not implemented")
@missing_feature(context.library == "php", reason="Not implemented")
@missing_feature(context.library == "nodejs", reason="Not implemented")
@missing_feature(context.library == "java", reason="Not implemented")
@missing_feature(context.library == "cpp", reason="Not implemented")
@missing_feature(context.library == "ruby", reason="Not implemented")
@missing_feature(context.library == "golang", reason="Not implemented")
def test_tracestate_w3c_p_phase_3_extract_inject(self, test_agent, test_library):
link04 marked this conversation as resolved.
Show resolved Hide resolved
"""
Ensure the last parent id tag is set according to the W3C phase 3 spec
"""
with test_library:
# 1) Datadog and tracecontext headers, trace-id and span-id match
headers1 = make_single_request_and_get_inject_headers(
test_library,
[
["traceparent", "00-11111111111111110000000000000001-000000003ade68b1-01"],
["tracestate", "dd=s:2;p:0123456789abcdef,foo=1"],
["x-datadog-trace-id", "1"],
["x-datadog-parent-id", "987654321"],
],
)

# 2) Datadog and tracecontext headers, trace-id and span-id match, missing p
headers2 = make_single_request_and_get_inject_headers(
test_library,
[
["traceparent", "00-11111111111111110000000000000002-000000003ade68b1-01"],
["tracestate", "dd=s:2,foo=1"],
["x-datadog-trace-id", "2"],
["x-datadog-parent-id", "987654321"],
],
)

# 3) Datadog and tracecontext headers, only trace-id matches
headers3 = make_single_request_and_get_inject_headers(
test_library,
[
["traceparent", "00-11111111111111110000000000000003-000000003ade68b1-01"],
["tracestate", "dd=s:2;p:0123456789abcdef,foo=1"],
["x-datadog-trace-id", "3"],
["x-datadog-parent-id", "9876543210"],
],
)

# 4) Datadog headers only
headers4 = make_single_request_and_get_inject_headers(
test_library, [["x-datadog-trace-id", "4"], ["x-datadog-parent-id", "987654321"],],
)

# 5) Datadog and tracecontext headers, no x-datadog-trace-id, only tid DD tag matches
link04 marked this conversation as resolved.
Show resolved Hide resolved
headers5 = make_single_request_and_get_inject_headers(
test_library,
[
["traceparent", "00-00000000000000000000000000000005-000000003ade68b1-01"],
["tracestate", "dd=s:2;p:0123456789abcdef,foo=1"],
["x-datadog-tags", "_dd.p.tid=5"],
],
)

# 6) Datadog and tracecontext headers, not x-datadog-trace-id, tid and the spans id match
headers6 = make_single_request_and_get_inject_headers(
test_library,
[
["traceparent", "00-00000000000000000000000000000006-000000003ade68b1-01"],
["tracestate", "dd=s:2;p:0123456789abcdef,foo=1"],
["x-datadog-parent-id", "987654321"],
["x-datadog-tags", "_dd.p.tid=6"],
link04 marked this conversation as resolved.
Show resolved Hide resolved
],
)

traces = test_agent.wait_for_num_traces(6)

assert len(traces) == 6
case1, case2, case3, case4, case5, case6 = (
traces[0][0],
traces[1][0],
traces[2][0],
traces[3][0],
traces[4][0],
traces[5][0],
)

# 1) Datadog and tracecontext headers, trace-id and span-id match
assert case1["meta"]["_dd.parent_id"] == "0123456789abcdef"
link04 marked this conversation as resolved.
Show resolved Hide resolved

traceparent1, tracestate1 = get_tracecontext(headers1)
assert traceparent1.trace_id == "00000000000000000000000000000001"
assert "p:{:016x}".format(int(case1["span_id"])) in tracestate1["dd"]

# 2) Datadog and tracecontext headers, trace-id and span-id match, missing p
assert "_dd.parent_id" not in case2["meta"]

traceparent2, tracestate2 = get_tracecontext(headers2)
assert traceparent2.trace_id == "00000000000000000000000000000002"
assert "p:{:016x}".format(int(case2["span_id"])) in tracestate2["dd"]

# 3) Datadog and tracecontext headers, only trace-id matches
assert "_dd.parent_id" not in case3["meta"]

traceparent3, tracestate3 = get_tracecontext(headers3)
assert traceparent3.trace_id == "00000000000000000000000000000003"
assert "p:{:016x}".format(int(case3["span_id"])) in tracestate3["dd"]

# 4) Datadog headers only
assert "_dd.parent_id" not in case4["meta"]

traceparent4, tracestate4 = get_tracecontext(headers4)
assert traceparent4.trace_id == "00000000000000000000000000000004"
assert "p:{:016x}".format(int(case4["span_id"])) in tracestate4["dd"]

# 5) Datadog and tracecontext headers, only tid DD tag matches
assert "_dd.parent_id" not in case5["meta"]

traceparent5, tracestate5 = get_tracecontext(headers5)
assert traceparent5.trace_id == "00000000000000000000000000000005"
assert "p:{:016x}".format(int(case5["span_id"])) in tracestate5["dd"]

# 6) Datadog and tracecontext headers, not x-datadog-trace-id, tid and the spans id match
assert case6["meta"]["_dd.parent_id"] == "0123456789abcdef"

traceparent6, tracestate6 = get_tracecontext(headers6)
assert traceparent6.trace_id == "00000000000000000000000000000006"
assert "p:{:016x}".format(int(case6["span_id"])) in tracestate6["dd"]

# W3C Phase 3 to try adding the tag if the span id matches regardless of headers order(if tracecontext is accounted)
@missing_feature(context.library == "python", reason="Not implemented")
@missing_feature(context.library < "dotnet@2.51.0", reason="Not implemented")
@missing_feature(context.library == "php", reason="Not implemented")
@missing_feature(context.library == "nodejs", reason="Not implemented")
@missing_feature(context.library == "java", reason="Not implemented")
@missing_feature(context.library == "cpp", reason="Not implemented")
mabdinur marked this conversation as resolved.
Show resolved Hide resolved
@missing_feature(context.library == "ruby", reason="Not implemented")
@missing_feature(context.library == "golang", reason="Not implemented")
@temporary_enable_optin_extract_first()
link04 marked this conversation as resolved.
Show resolved Hide resolved
def test_tracestate_w3c_p_phase_3_extract_inject_extract_first(self, test_agent, test_library):
mabdinur marked this conversation as resolved.
Show resolved Hide resolved
"""
Ensure the last parent id tag is set according to the W3C phase 3 spec
"""
with test_library:
# 1) Datadog and tracecontext headers, trace-id and span-id match
headers1 = make_single_request_and_get_inject_headers(
test_library,
[
["traceparent", "00-00000000000000000000000000000001-000000003ade68b1-01"],
["tracestate", "dd=s:2;p:0123456789abcdef,foo=1"],
["x-datadog-trace-id", "1"],
["x-datadog-parent-id", "987654321"],
],
)

# 2) Datadog headers only
headers2 = make_single_request_and_get_inject_headers(
test_library, [["x-datadog-trace-id", "2"], ["x-datadog-parent-id", "987654321"],],
)

# 3) Datadog and tracecontext headers, not x-datadog-trace-id, tid and the spans id match
headers3 = make_single_request_and_get_inject_headers(
test_library,
[
["traceparent", "00-00000000000000000000000000000003-000000003ade68b1-01"],
["tracestate", "dd=s:2;p:0123456789abcdef,foo=1"],
["x-datadog-parent-id", "987654321"],
["x-datadog-tags", "_dd.p.tid=3"],
],
)

traces = test_agent.wait_for_num_traces(3)

assert len(traces) == 3
case1, case2, case3 = traces[0][0], traces[1][0], traces[2][0]

# 1) Datadog and tracecontext headers, trace-id and span-id match
assert "_dd.parent_id" not in case1["meta"]

traceparent1, tracestate1 = get_tracecontext(headers1)
assert traceparent1.trace_id == "00000000000000000000000000000001"
assert "p:{:016x}".format(int(case1["span_id"])) in tracestate1["dd"]
link04 marked this conversation as resolved.
Show resolved Hide resolved

# 2) Datadog headers only
assert "_dd.parent_id" not in case2["meta"]

traceparent2, tracestate2 = get_tracecontext(headers2)
assert traceparent2.trace_id != "00000000000000000000000000000002"
assert "p:{:016x}".format(int(case2["span_id"])) in tracestate2["dd"]

# 3) Datadog and tracecontext headers, not x-datadog-trace-id, tid and the spans id match
assert case3["meta"]["_dd.parent_id"] == "0123456789abcdef"

traceparent3, tracestate3 = get_tracecontext(headers3)
assert traceparent3.trace_id == "00000000000000000000000000000003"
assert "p:{:016x}".format(int(case3["span_id"])) in tracestate3["dd"]
link04 marked this conversation as resolved.
Show resolved Hide resolved

@temporary_enable_optin_tracecontext()
def test_tracestate_all_allowed_characters(self, test_agent, test_library):
"""
Expand Down
Loading