Skip to content

fix(trace): keep sampling priority numeric in SpanContextWrapper.fromTraceContext #850

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

Open
SiddhithaBhoopathy wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix(trace): keep sampling priority numeric in SpanContextWrapper.fromTraceContext #850

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ec6299
fix(trace): keep sampling priority numeric in SpanContextWrapper.from…
SiddhithaBhoopathy Oct 22, 2026
8f15251
test: update remaining string sampling priority assertions and custom…
SiddhithaBhoopathy Oct 22, 2026
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
54 changes: 36 additions & 18 deletions integration_tests_local/snapshots/logs/cjs-custom-extractor.log
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@ XXXX [INFO] (rapid) INVOKE START(requestId: XXXX)
},
"metrics": {
"_dd.measured": 1,
"process_id":XXXX
"process_id":XXXX,
"_sampling_priority_v1": 1
},
"start":XXXX,
"duration":XXXX
Expand Down Expand Up @@ -96,7 +97,8 @@ XXXX [INFO] (rapid) INVOKE START(requestId: XXXX)
},
"metrics": {
"_dd.measured": 1,
"process_id":XXXX
"process_id":XXXX,
"_sampling_priority_v1": 1
},
"start":XXXX,
"duration":XXXX
Expand Down Expand Up @@ -162,7 +164,8 @@ XXXX [INFO] (rapid) INVOKE START(requestId: XXXX)
"metrics": {
"_dd.measured": 1,
"size_bytes": 37,
"process_id":XXXX
"process_id":XXXX,
"_sampling_priority_v1": 1
},
"start":XXXX,
"duration":XXXX
Expand Down Expand Up @@ -198,7 +201,8 @@ XXXX [INFO] (rapid) INVOKE START(requestId: XXXX)
},
"metrics": {
"_dd.measured": 1,
"process_id":XXXX
"process_id":XXXX,
"_sampling_priority_v1": 1
},
"start":XXXX,
"duration":XXXX
Expand Down Expand Up @@ -264,7 +268,8 @@ XXXX [INFO] (rapid) INVOKE START(requestId: XXXX)
"metrics": {
"_dd.measured": 1,
"size_bytes": 37,
"process_id":XXXX
"process_id":XXXX,
"_sampling_priority_v1": 1
},
"start":XXXX,
"duration":XXXX
Expand Down Expand Up @@ -300,7 +305,8 @@ XXXX [INFO] (rapid) INVOKE START(requestId: XXXX)
},
"metrics": {
"_dd.measured": 1,
"process_id":XXXX
"process_id":XXXX,
"_sampling_priority_v1": 1
},
"start":XXXX,
"duration":XXXX
Expand Down Expand Up @@ -366,7 +372,8 @@ XXXX [INFO] (rapid) INVOKE START(requestId: XXXX)
"metrics": {
"_dd.measured": 1,
"size_bytes": 37,
"process_id":XXXX
"process_id":XXXX,
"_sampling_priority_v1": 1
},
"start":XXXX,
"duration":XXXX
Expand Down Expand Up @@ -402,7 +409,8 @@ XXXX [INFO] (rapid) INVOKE START(requestId: XXXX)
},
"metrics": {
"_dd.measured": 1,
"process_id":XXXX
"process_id":XXXX,
"_sampling_priority_v1": 1
},
"start":XXXX,
"duration":XXXX
Expand Down Expand Up @@ -467,7 +475,8 @@ START RequestId: XXXX Version: $LATEST
"metrics": {
"_dd.measured": 1,
"object_size": 8388608,
"process_id":XXXX
"process_id":XXXX,
"_sampling_priority_v1": 1
},
"start":XXXX,
"duration":XXXX
Expand Down Expand Up @@ -503,7 +512,8 @@ START RequestId: XXXX Version: $LATEST
},
"metrics": {
"_dd.measured": 1,
"process_id":XXXX
"process_id":XXXX,
"_sampling_priority_v1": 1
},
"start":XXXX,
"duration":XXXX
Expand Down Expand Up @@ -568,7 +578,8 @@ START RequestId: XXXX Version: $LATEST
"metrics": {
"_dd.measured": 1,
"object_size": 100,
"process_id":XXXX
"process_id":XXXX,
"_sampling_priority_v1": 1
},
"start":XXXX,
"duration":XXXX
Expand Down Expand Up @@ -604,7 +615,8 @@ START RequestId: XXXX Version: $LATEST
},
"metrics": {
"_dd.measured": 1,
"process_id":XXXX
"process_id":XXXX,
"_sampling_priority_v1": 1
},
"start":XXXX,
"duration":XXXX
Expand Down Expand Up @@ -669,7 +681,8 @@ XXXX [INFO] (rapid) INVOKE START(requestId: XXXX)
"metrics": {
"_dd.measured": 1,
"object_size": 100,
"process_id":XXXX
"process_id":XXXX,
"_sampling_priority_v1": 1
},
"start":XXXX,
"duration":XXXX
Expand Down Expand Up @@ -705,7 +718,8 @@ XXXX [INFO] (rapid) INVOKE START(requestId: XXXX)
},
"metrics": {
"_dd.measured": 1,
"process_id":XXXX
"process_id":XXXX,
"_sampling_priority_v1": 1
},
"start":XXXX,
"duration":XXXX
Expand Down Expand Up @@ -769,7 +783,8 @@ XXXX [INFO] (rapid) INVOKE START(requestId: XXXX)
},
"metrics": {
"_dd.measured": 1,
"process_id":XXXX
"process_id":XXXX,
"_sampling_priority_v1": 1
},
"start":XXXX,
"duration":XXXX
Expand Down Expand Up @@ -805,7 +820,8 @@ XXXX [INFO] (rapid) INVOKE START(requestId: XXXX)
},
"metrics": {
"_dd.measured": 1,
"process_id":XXXX
"process_id":XXXX,
"_sampling_priority_v1": 1
},
"start":XXXX,
"duration":XXXX
Expand Down Expand Up @@ -868,7 +884,8 @@ XXXX [INFO] (rapid) INVOKE START(requestId: XXXX)
"metrics": {
"_dd.measured": 1,
"retry_count": 1,
"process_id":XXXX
"process_id":XXXX,
"_sampling_priority_v1": 1
},
"start":XXXX,
"duration":XXXX
Expand Down Expand Up @@ -904,7 +921,8 @@ XXXX [INFO] (rapid) INVOKE START(requestId: XXXX)
},
"metrics": {
"_dd.measured": 1,
"process_id":XXXX
"process_id":XXXX,
"_sampling_priority_v1": 1
},
"start":XXXX,
"duration":XXXX
Expand Down
4 changes: 2 additions & 2 deletions src/trace/context/extractor.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ describe("TraceContextExtractor", () => {

expect(traceContext?.toTraceId()).toBe("4110911582297405551");
expect(traceContext?.toSpanId()).toBe("797643193680388251");
expect(traceContext?.sampleMode()).toBe("2");
expect(traceContext?.sampleMode()).toBe(2);
expect(traceContext?.source).toBe("event");
});
});
Expand Down Expand Up @@ -797,7 +797,7 @@ describe("TraceContextExtractor", () => {

expect(traceContext?.toTraceId()).toBe("4110911582297405557");
expect(traceContext?.toSpanId()).toBe("797643193680388254");
expect(traceContext?.sampleMode()).toBe("2");
expect(traceContext?.sampleMode()).toBe(2);
expect(traceContext?.source).toBe("xray");
});
});
Expand Down
2 changes: 1 addition & 1 deletion src/trace/context/extractors/custom.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ describe("CustomTraceExtractor", () => {

expect(traceContext?.toTraceId()).toBe("4110911582297405551");
expect(traceContext?.toSpanId()).toBe("797643193680388251");
expect(traceContext?.sampleMode()).toBe("2");
expect(traceContext?.sampleMode()).toBe(2);
expect(traceContext?.source).toBe("event");
});

Expand Down
2 changes: 1 addition & 1 deletion src/trace/context/extractors/sns-sqs.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ describe("SNSSQSEventTraceExtractor", () => {

expect(traceContext?.toTraceId()).toBe("5027664352514971920");
expect(traceContext?.toSpanId()).toBe("1797917631284315439");
expect(traceContext?.sampleMode()).toBe("1");
expect(traceContext?.sampleMode()).toBe(1);
expect(traceContext?.source).toBe("event");
});

Expand Down
2 changes: 1 addition & 1 deletion src/trace/context/extractors/sns.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ describe("SNSEventTraceExtractor", () => {

expect(traceContext?.toTraceId()).toBe("1705928277274000281");
expect(traceContext?.toSpanId()).toBe("1366252104075042743");
expect(traceContext?.sampleMode()).toBe("1");
expect(traceContext?.sampleMode()).toBe(1);
expect(traceContext?.source).toBe("event");
});

Expand Down
2 changes: 1 addition & 1 deletion src/trace/context/extractors/sqs.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ describe("SQSEventTraceExtractor", () => {

expect(traceContext?.toTraceId()).toBe("625397077193750208");
expect(traceContext?.toSpanId()).toBe("6538302989251745223");
expect(traceContext?.sampleMode()).toBe("1");
expect(traceContext?.sampleMode()).toBe(1);
expect(traceContext?.source).toBe("event");
});

Expand Down
20 changes: 19 additions & 1 deletion src/trace/span-context-wrapper.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,30 @@ describe("SpanContextWrapper", () => {

expect(spanContext?.toTraceId()).toBe("8768810343773813232");
expect(spanContext?.toSpanId()).toBe("6918894271950871724");
expect(spanContext?.sampleMode()).toBe("1");
expect(spanContext?.sampleMode()).toBe(1);
expect(spanContext?.source).toBe("event");
expect(spanContext?.spanContext._traceId.toArray()).toEqual([121, 177, 18, 140, 107, 104, 185, 240]);
expect(spanContext?.spanContext._spanId.toArray()).toEqual([96, 4, 217, 174, 182, 29, 220, 172]);
});

// dd-trace only injects x-datadog-sampling-priority when the priority is an integer.
it.each([
["USER_KEEP", SampleMode.USER_KEEP],
["USER_REJECT", SampleMode.USER_REJECT],
["AUTO_KEEP", SampleMode.AUTO_KEEP],
["AUTO_REJECT", SampleMode.AUTO_REJECT],
])("fromTraceContext keeps %s sampling priority as an integer", (_, sampleMode) => {
const spanContext = SpanContextWrapper.fromTraceContext({
traceId: "8768810343773813232",
parentId: "6918894271950871724",
sampleMode,
source: TraceSource.Xray,
});

expect(spanContext?.sampleMode()).toBe(sampleMode);
expect(Number.isInteger(spanContext?.spanContext._sampling.priority)).toBe(true);
});

describe("sampleMode", () => {
it("should return AUTO_KEEP when sampling priority is not available in spanContext", () => {
const spanContext = new SpanContextWrapper(
Expand Down
2 changes: 1 addition & 1 deletion src/trace/span-context-wrapper.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export class SpanContextWrapper implements SpanContext {
return null;
}

const samplingPriority = traceContext.sampleMode.toString(10);
const samplingPriority = traceContext.sampleMode;
const source = traceContext.source;
try {
// Try requiring class from the tracer.
Expand Down
4 changes: 2 additions & 2 deletions src/trace/xray-service.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ describe("XrayService", () => {

expect(traceContext?.toTraceId()).toBe("3995693151288333088");
expect(traceContext?.toSpanId()).toBe("10713633173203262661");
expect(traceContext?.sampleMode()).toBe("2");
expect(traceContext?.sampleMode()).toBe(2);
expect(traceContext?.source).toBe("xray");
});

Expand Down Expand Up @@ -371,7 +371,7 @@ describe("XrayService", () => {

expect(ddTraceContext?.toTraceId()).toEqual("625397077193750208");
expect(ddTraceContext?.toSpanId()).toEqual("6538302989251745223");
expect(ddTraceContext?.sampleMode()).toEqual("1");
expect(ddTraceContext?.sampleMode()).toEqual(1);
});

it("returns null when AWS trace header is NOT injected by dd-trace", () => {
Expand Down
Loading