Skip to content

feat(aws): Enable Lambda extension by default when using the Lamba layer #17684

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 4 commits into from
Sep 24, 2025
Merged

feat(aws): Enable Lambda extension by default when using the Lamba layer #17684

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2fc89a4
chore(aws): Remove experimental flag for Lambda extension
msonnb Sep 17, 2025
8d9e6cf
rename option
msonnb Sep 18, 2025
a131d05
wording
msonnb Sep 18, 2025
9513fa0
only default to true if tunnel isn't set
msonnb Sep 18, 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
16 changes: 0 additions & 16 deletions ...st-applications/aws-serverless/src/lambda-functions-layer/ExperimentalExtension/index.mjs
View file
Open in desktop

This file was deleted.

48 changes: 0 additions & 48 deletions dev-packages/e2e-tests/test-applications/aws-serverless/tests/layer.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,52 +242,4 @@ test.describe('Lambda layer', () => {
}),
);
});

test('experimental extension works', async ({ lambdaClient }) => {
const transactionEventPromise = waitForTransaction('aws-serverless-lambda-sam', transactionEvent => {
return transactionEvent?.transaction === 'LayerExperimentalExtension';
});

await lambdaClient.send(
new InvokeCommand({
FunctionName: 'LayerExperimentalExtension',
Payload: JSON.stringify({}),
}),
);

const transactionEvent = await transactionEventPromise;

expect(transactionEvent.transaction).toEqual('LayerExperimentalExtension');
expect(transactionEvent.contexts?.trace).toEqual({
data: {
'sentry.sample_rate': 1,
'sentry.source': 'custom',
'sentry.origin': 'auto.otel.aws-lambda',
'sentry.op': 'function.aws.lambda',
'cloud.account.id': '012345678912',
'faas.execution': expect.any(String),
'faas.id': 'arn:aws:lambda:us-east-1:012345678912:function:LayerExperimentalExtension',
'faas.coldstart': true,
'otel.kind': 'SERVER',
},
op: 'function.aws.lambda',
origin: 'auto.otel.aws-lambda',
span_id: expect.stringMatching(/[a-f0-9]{16}/),
status: 'ok',
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
});

expect(transactionEvent.spans).toHaveLength(1);

expect(transactionEvent.spans).toContainEqual(
expect.objectContaining({
data: expect.objectContaining({
'sentry.op': 'test',
'sentry.origin': 'manual',
}),
description: 'manual-span',
op: 'test',
}),
);
});
});
16 changes: 7 additions & 9 deletions packages/aws-serverless/src/init.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,10 @@ export function getDefaultIntegrations(_options: Options): Integration[] {
}

export interface AwsServerlessOptions extends NodeOptions {
_experiments?: NodeOptions['_experiments'] & {
/**
* If proxying Sentry events through the Sentry Lambda extension should be enabled.
*/
enableLambdaExtension?: boolean;
};
/**
* If Sentry events should be proxied through the Lambda extension when using the Lambda layer. Defaults to `true` when using the Lambda layer.
*/
useLayerExtension?: boolean;
}

/**
Expand All @@ -29,14 +27,14 @@ export interface AwsServerlessOptions extends NodeOptions {
* @param options Configuration options for the SDK, @see {@link AWSLambdaOptions}.
*/
export function init(options: AwsServerlessOptions = {}): NodeClient | undefined {
const sdkSource = getSDKSource();
const opts = {
defaultIntegrations: getDefaultIntegrations(options),
useLayerExtension: sdkSource === 'aws-lambda-layer' && !options.tunnel,
...options,
};

const sdkSource = getSDKSource();

if (opts._experiments?.enableLambdaExtension) {
if (opts.useLayerExtension) {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Missing Warning for Unsupported Lambda Extension

The warning for unsupported useLayerExtension usage is missing. When useLayerExtension is explicitly set to true but the SDK is not from the Lambda layer, users no longer receive feedback that the Lambda extension is only supported with the layer. This warning was removed during the refactor.

Fix in Cursor Fix in Web

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@msonnb this is good feedback IMHO, it makes sense to warn in this case :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think Cursor is confusing something, this is still here:

sentry-javascript/packages/aws-serverless/src/init.ts

Line 49 in a131d05

DEBUG_BUILD && debug.warn('The Sentry Lambda extension is only supported when using the AWS Lambda layer.');

if (sdkSource === 'aws-lambda-layer') {
if (!opts.tunnel) {
DEBUG_BUILD && debug.log('Proxying Sentry events through the Sentry Lambda extension');
Expand Down
55 changes: 41 additions & 14 deletions packages/aws-serverless/test/init.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,12 @@ const mockGetSDKSource = vi.mocked(getSDKSource);
const mockInitWithoutDefaultIntegrations = vi.mocked(initWithoutDefaultIntegrations);

describe('init', () => {
describe('experimental Lambda extension support', () => {
describe('Lambda extension setup', () => {
test('should preserve user-provided tunnel option when Lambda extension is enabled', () => {
mockGetSDKSource.mockReturnValue('aws-lambda-layer');
const options: AwsServerlessOptions = {
tunnel: 'https://custom-tunnel.example.com',
_experiments: {
enableLambdaExtension: true,
},
useLayerExtension: true,
};

init(options);
Expand All @@ -40,9 +38,7 @@ describe('init', () => {
test('should set default tunnel when Lambda extension is enabled and SDK source is aws-lambda-layer', () => {
mockGetSDKSource.mockReturnValue('aws-lambda-layer');
const options: AwsServerlessOptions = {
_experiments: {
enableLambdaExtension: true,
},
useLayerExtension: true,
};

init(options);
Expand All @@ -57,9 +53,7 @@ describe('init', () => {
test('should not set tunnel when Lambda extension is disabled', () => {
mockGetSDKSource.mockReturnValue('aws-lambda-layer');
const options: AwsServerlessOptions = {
_experiments: {
enableLambdaExtension: false,
},
useLayerExtension: false,
};

init(options);
Expand All @@ -74,9 +68,7 @@ describe('init', () => {
test('should not set tunnel when SDK source is not aws-lambda-layer even with Lambda extension enabled', () => {
mockGetSDKSource.mockReturnValue('npm');
const options: AwsServerlessOptions = {
_experiments: {
enableLambdaExtension: true,
},
useLayerExtension: true,
};

init(options);
Expand All @@ -88,17 +80,52 @@ describe('init', () => {
);
});

test('should not set tunnel when no experiments are provided', () => {
test('should default useLayerExtension to true when SDK source is aws-lambda-layer', () => {
mockGetSDKSource.mockReturnValue('aws-lambda-layer');
const options: AwsServerlessOptions = {};

init(options);

expect(mockInitWithoutDefaultIntegrations).toHaveBeenCalledWith(
expect.objectContaining({
useLayerExtension: true,
tunnel: 'http://localhost:9000/envelope',
}),
);
});

test('should default useLayerExtension to false when SDK source is not aws-lambda-layer', () => {
mockGetSDKSource.mockReturnValue('npm');
const options: AwsServerlessOptions = {};

init(options);

expect(mockInitWithoutDefaultIntegrations).toHaveBeenCalledWith(
expect.objectContaining({
useLayerExtension: false,
}),
);
expect(mockInitWithoutDefaultIntegrations).toHaveBeenCalledWith(
expect.not.objectContaining({
tunnel: expect.any(String),
}),
);
});

test('should default useLayerExtension to false when tunnel is provided even when SDK source is aws-lambda-layer', () => {
mockGetSDKSource.mockReturnValue('aws-lambda-layer');
const options: AwsServerlessOptions = {
tunnel: 'https://custom-tunnel.example.com',
};

init(options);

expect(mockInitWithoutDefaultIntegrations).toHaveBeenCalledWith(
expect.objectContaining({
useLayerExtension: false,
tunnel: 'https://custom-tunnel.example.com',
}),
);
});
});
});
Loading