Skip to content

Support extracting X-Ray Trace Header Lambda Invoke Store #722

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

Merged
merged 5 commits into from
Sep 10, 2025
Merged

Support extracting X-Ray Trace Header Lambda Invoke Store #722

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
48ef03f
support extracting X-Ray Trace Header via InvokeStore
jj22ee Sep 2, 2025
a8268d6
add tar file for draft pr testing temporarily
jj22ee Sep 2, 2025
c5d1ab1
Revert "add tar file for draft pr testing temporarily"
jj22ee Sep 5, 2025
a840a0b
add @aws/lambda-invoke-store dependency
jj22ee Sep 5, 2025
ec63e26
Merge branch 'master' into xray-header-from-context-support
jj22ee Sep 9, 2025
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
21 changes: 21 additions & 0 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 5 additions & 1 deletion packages/core/lib/env/aws_lambda.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ var SegmentUtils = require('../segments/segment_utils');
var logger = require('../logger');
const TraceID = require('../segments/attributes/trace_id');

const { InvokeStore } = require('@aws/lambda-invoke-store');

/**
* @namespace
* @ignore
Expand Down Expand Up @@ -80,7 +82,9 @@ var facadeSegment = function facadeSegment() {
};

segment.resolveLambdaTraceData = function resolveLambdaTraceData() {
var xAmznLambda = process.env._X_AMZN_TRACE_ID;
const traceIdFromInvokeStore = InvokeStore.getXRayTraceId();
const traceIdFromEnv = process.env._X_AMZN_TRACE_ID;
var xAmznLambda = traceIdFromInvokeStore ?? traceIdFromEnv;

if (xAmznLambda) {

Expand Down
3 changes: 2 additions & 1 deletion packages/core/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
"//": "@types/cls-hooked is exposed in API so must be in dependencies, not devDependencies",
"dependencies": {
"@aws-sdk/types": "^3.4.1",
"@aws/lambda-invoke-store": "^0.0.1",
"@smithy/service-error-classification": "^2.0.4",
"@types/cls-hooked": "^4.3.3",
"atomic-batcher": "^1.0.2",
Expand Down Expand Up @@ -55,4 +56,4 @@
],
"license": "Apache-2.0",
"repository": "https://github.com/aws/aws-xray-sdk-node/tree/master/packages/core"
}
}
45 changes: 45 additions & 0 deletions packages/core/test/unit/env/aws_lambda.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ var chai = require('chai');
var sinon = require('sinon');
var sinonChai = require('sinon-chai');

chai.should();
chai.use(sinonChai);

var contextUtils = require('../../../lib/context_utils');
Expand All @@ -13,6 +14,7 @@ var Segment = require('../../../lib/segments/segment');
var SegmentUtils = require('../../../lib/segments/segment_utils');
var SegmentEmitter = require('../../../lib/segment_emitter');
const TraceID = require('../../../lib/segments/attributes/trace_id');
const { InvokeStore } = require('@aws/lambda-invoke-store');

describe('AWSLambda', function() {
var sandbox;
Expand Down Expand Up @@ -147,6 +149,8 @@ describe('AWSLambda', function() {

describe('#resolveLambdaTraceData', function() {
var sandbox, traceId;
var INVOKE_STORE_TRACE_ID = 'Root=1-12345678-12345678901234567890abcd;Parent=abcdef0123456789;Sampled=1';
var ENV_TRACE_ID = 'Root=1-87654321-09876543210987654321dcba;Parent=fedcba9876543210;Sampled=0';

beforeEach(function() {
sandbox = sinon.createSandbox();
Expand Down Expand Up @@ -197,6 +201,47 @@ describe('AWSLambda', function() {
facade.resolveLambdaTraceData();
populateStub.should.have.not.been.called;
});

it('should prioritize InvokeStore trace ID over environment variable if both are defined', function() {
process.env._X_AMZN_TRACE_ID = ENV_TRACE_ID;
Lambda.init();

sandbox.stub(InvokeStore, 'getXRayTraceId').returns(INVOKE_STORE_TRACE_ID);
populateStub.reset();

var facade = setSegmentStub.args[0][0];
facade.resolveLambdaTraceData();

populateStub.should.have.been.calledWith(facade, INVOKE_STORE_TRACE_ID);
});

it('should use InvokeStore trace ID when environment variable is undefined', function() {
delete process.env._X_AMZN_TRACE_ID;

Lambda.init();

sandbox.stub(InvokeStore, 'getXRayTraceId').returns(INVOKE_STORE_TRACE_ID);
populateStub.reset();

var facade = setSegmentStub.args[0][0];
facade.resolveLambdaTraceData();

populateStub.should.have.been.calledWith(facade, INVOKE_STORE_TRACE_ID);
});

it('should use environment variable when InvokeStore returns undefined', function() {
process.env._X_AMZN_TRACE_ID = INVOKE_STORE_TRACE_ID;
Lambda.init();

process.env._X_AMZN_TRACE_ID = ENV_TRACE_ID;
sandbox.stub(InvokeStore, 'getXRayTraceId').returns(undefined);
populateStub.reset();

var facade = setSegmentStub.args[0][0];
facade.resolveLambdaTraceData();

populateStub.should.have.been.calledWith(facade, ENV_TRACE_ID);
});
});
});

Expand Down
Loading