Skip to content

fix(aws-sdk): use custom client_context prop #2718

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
pichlermarc merged 2 commits into from
May 26, 2025
Merged

fix(aws-sdk): use custom client_context prop #2718

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
85a0a76
fix(aws-sdk): use `custom` client_context prop
smoke Feb 16, 2025
dd61438
Merge branch 'main' into fix/opentelemetry-instrumentation-aws-lambda…
pichlermarc May 23, 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
2 changes: 1 addition & 1 deletion plugins/node/opentelemetry-instrumentation-aws-sdk/doc/lambda.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ The following methods are automatically enhanced:
### Invoke

- Attributes are added by this instrumentation according to the [spec for Outgoing Invocations of a FaaS from a client](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/faas.md#outgoing-invocations) .
- OpenTelemetry trace context is injected into the `ClientContext` parameter, allowing functions to extract this using the `Custom` property within the function.
- OpenTelemetry trace context is injected into the `ClientContext` parameter, allowing functions to extract this using the `custom` property within the function.
4 changes: 2 additions & 2 deletions plugins/node/opentelemetry-instrumentation-aws-sdk/src/services/lambda.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,8 @@ const injectLambdaPropagationContext = (

const updatedClientContext = {
...parsedClientContext,
Custom: {
...parsedClientContext.Custom,
custom: {
...parsedClientContext.custom,
...propagatedContext,
},
};
Expand Down
14 changes: 7 additions & 7 deletions plugins/node/opentelemetry-instrumentation-aws-sdk/test/lambda.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ describe('Lambda', () => {
'base64'
).toString()
) as Record<string, any>;
expect(clientContext.Custom).toHaveProperty('traceparent');
expect(clientContext.custom).toHaveProperty('traceparent');
});

it('should skip context propagation in the event it would push the ClientContext over 3583 bytes', async () => {
Expand All @@ -168,7 +168,7 @@ describe('Lambda', () => {

const existingClientContext = Buffer.from(
JSON.stringify({
Custom: {
custom: {
text: [...Array(2600)]
.map(x => String.fromCharCode(48 + Math.random() * 74))
.join(''),
Expand Down Expand Up @@ -221,7 +221,7 @@ describe('Lambda', () => {
),
ClientContext: Buffer.from(
JSON.stringify({
Custom: {
custom: {
existing: 'data',
},
})
Expand All @@ -238,8 +238,8 @@ describe('Lambda', () => {
'base64'
).toString()
) as Record<string, any>;
expect(clientContext.Custom).toHaveProperty('existing', 'data');
expect(clientContext.Custom).toHaveProperty('traceparent');
expect(clientContext.custom).toHaveProperty('existing', 'data');
expect(clientContext.custom).toHaveProperty('traceparent');
});

it('should maintain any existing top-level fields in the client context', async () => {
Expand All @@ -265,7 +265,7 @@ describe('Lambda', () => {
platform: 'Symbian',
platformVersion: '9.2',
},
Custom: {
custom: {
existing: 'data',
},
};
Expand Down Expand Up @@ -293,7 +293,7 @@ describe('Lambda', () => {
).toString()
) as Record<string, any>;
expect(updatedClientContext.env).toStrictEqual(clientContext.env);
expect(updatedClientContext.Custom).toHaveProperty('traceparent');
expect(updatedClientContext.custom).toHaveProperty('traceparent');
});

// It probably should be valid JSON, and I'm not sure what the lambda internals make of it if
Expand Down