Repository navigation
feat(node): Add awsLambdaWebIntegration for Lambda Web Functions
#25355
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.
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
base: develop
Are you sure you want to change the base?
Changes from all commits
d58bbf1
d3d016c
df51796
14f0953
baeac4d
7600202
ecc8d6c
2907a51
bf3b43e
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| import * as Sentry from '@sentry/node'; | ||
| import { loggingTransport } from '@sentry-internal/node-integration-tests'; | ||
|
|
||
| Sentry.init({ | ||
| dsn: 'https://public@example.com/1', | ||
| tracesSampleRate: process.env.NO_TRACING ? undefined : 1, | ||
| transport: loggingTransport, | ||
| }); |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| import * as Sentry from '@sentry/node'; | ||
| import { startExpressServerAndSendPortToRunner } from '@sentry-internal/node-integration-tests'; | ||
| import express from 'express'; | ||
|
|
||
| const app = express(); | ||
| let releaseFirst; | ||
| const secondRequestStarted = new Promise(resolve => { | ||
| releaseFirst = resolve; | ||
| }); | ||
|
|
||
| app.get('/:request', async (req, res) => { | ||
| if (req.params.request === 'first') { | ||
| process.stdout.write('FIRST_STARTED\n'); | ||
| await secondRequestStarted; | ||
| } else { | ||
| releaseFirst(); | ||
| } | ||
|
|
||
| Sentry.captureException(new Error(req.params.request)); | ||
| Sentry.logger.info('Request handled'); | ||
| Sentry.metrics.count('request_count', 1); | ||
| res.send({ ok: true }); | ||
| setImmediate(() => { | ||
| void Sentry.flush(); | ||
| }); | ||
| }); | ||
|
|
||
| startExpressServerAndSendPortToRunner(app); |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| import { | ||
| CLOUD_PLATFORM, | ||
| CLOUD_PROVIDER, | ||
| CLOUD_REGION, | ||
| FAAS_COLDSTART, | ||
| FAAS_INVOCATION_ID, | ||
| SENTRY_OP, | ||
| } from '@sentry/conventions/attributes'; | ||
| import { expect, vi } from 'vitest'; | ||
| import { createEsmAndCjsTests } from '../../../utils/runner'; | ||
|
|
||
| createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => { | ||
| test.each([ | ||
| { name: 'default tracing', tracing: true }, | ||
| { name: 'tracing disabled', tracing: false }, | ||
| ])('$name: isolates concurrent requests and leaves logs and metrics unenriched', async ({ tracing }) => { | ||
| const runner = createRunner() | ||
| .withEnv({ | ||
| AWS_LAMBDA_HTTP_ENDPOINT: '0.0.0.0:3000', | ||
| AWS_REGION: 'us-east-1', | ||
| AWS_LAMBDA_FUNCTION_MEMORY_SIZE: '2048', | ||
| AWS_LAMBDA_INITIALIZATION_TYPE: 'native-http', | ||
| AWS_EXECUTION_ENV: 'AWS_Lambda_nodejs24.x-lite', | ||
| NO_TRACING: tracing ? '' : '1', | ||
| }) | ||
| .unordered(); | ||
| const spans = []; | ||
| for (const request of ['first', 'second']) { | ||
| runner.expect({ | ||
| event: { | ||
| exception: { values: [expect.objectContaining({ value: request })] }, | ||
| contexts: { | ||
| cloud_resource: { | ||
| [CLOUD_PROVIDER]: 'aws', | ||
| [CLOUD_PLATFORM]: 'aws_lambda', | ||
| [CLOUD_REGION]: 'us-east-1', | ||
| }, | ||
| 'aws.lambda': { | ||
| memory_size: 2_147_483_648, | ||
| initialization_type: 'native-http', | ||
| cold_start: request === 'first', | ||
| aws_request_id: request, | ||
| endpoint_name: `${request}-endpoint`, | ||
| }, | ||
| }, | ||
| }, | ||
| }); | ||
| if (tracing) { | ||
| spans.push({ | ||
| request, | ||
| collected: runner.collectStreamedSpansUntilSegment( | ||
| span => span.attributes[FAAS_INVOCATION_ID]?.value === request, | ||
| ), | ||
| }); | ||
| } | ||
| } | ||
| const assertUnenriched = (items: { attributes?: Record<string, unknown> }[]): void => { | ||
| expect(items).toHaveLength(2); | ||
| for (const item of items) { | ||
| expect(Object.keys(item.attributes || {}).filter(key => /^(aws\.lambda\.|faas\.|cloud\.)/.test(key))).toEqual( | ||
| [], | ||
| ); | ||
| } | ||
| }; | ||
| runner.expect({ log: container => assertUnenriched(container.items) }); | ||
| runner.expect({ trace_metric: container => assertUnenriched(container.items) }); | ||
| const running = runner.start(); | ||
| const first = running.makeRequest('get', '/first', { | ||
| headers: { 'lambda-web-request-id': 'first', 'lambda-web-endpoint-name': 'first-endpoint' }, | ||
| }); | ||
| await vi.waitFor(() => expect(running.getLogs().join('\n')).toContain('FIRST_STARTED'), { timeout: 10_000 }); | ||
| await Promise.all([ | ||
| first, | ||
| running.makeRequest('get', '/second', { | ||
| headers: { 'lambda-web-request-id': 'second', 'lambda-web-endpoint-name': 'second-endpoint' }, | ||
| }), | ||
| ]); | ||
| await running.completed(); | ||
| for (const { request, collected } of spans) { | ||
| const items = await collected; | ||
| expect(items.find(item => item.is_segment)).toMatchObject({ | ||
| name: 'GET /:request', | ||
| attributes: { | ||
| [SENTRY_OP]: { type: 'string', value: 'http.server' }, | ||
| [CLOUD_PLATFORM]: { type: 'string', value: 'aws_lambda' }, | ||
| [CLOUD_REGION]: { type: 'string', value: 'us-east-1' }, | ||
| 'faas.max_memory': { type: 'integer', value: 2_147_483_648 }, | ||
| [FAAS_COLDSTART]: { type: 'boolean', value: request === 'first' }, | ||
| [FAAS_INVOCATION_ID]: { type: 'string', value: request }, | ||
| 'aws.lambda.web.endpoint_name': { type: 'string', value: `${request}-endpoint` }, | ||
| }, | ||
| }); | ||
| } | ||
| }); | ||
| }); | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| import { FAAS_COLDSTART, FAAS_INVOCATION_ID } from '@sentry/conventions/attributes'; | ||
| import type { IntegrationFn, SpanAttributes } from '@sentry/core'; | ||
| import { defineIntegration, getIsolationScope, safeSetSpanJSONAttributes } from '@sentry/core'; | ||
|
|
||
| let requestHandled = false; | ||
|
|
||
| const _awsLambdaWebIntegration = (() => { | ||
| const enabled = !!process.env.AWS_LAMBDA_HTTP_ENDPOINT; | ||
| const memory = Number(process.env.AWS_LAMBDA_FUNCTION_MEMORY_SIZE) * 1024 * 1024; | ||
| const lambdaContext = { | ||
| memory_size: Number.isFinite(memory) && memory > 0 ? memory : undefined, | ||
| initialization_type: process.env.AWS_LAMBDA_INITIALIZATION_TYPE, | ||
| }; | ||
| const environmentAttributes = { | ||
| 'faas.max_memory': lambdaContext.memory_size, | ||
| 'aws.lambda.initialization_type': lambdaContext.initialization_type, | ||
|
Comment on lines
+15
to
+16
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we already have those attributes in conventions?
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. not yet: getsentry/sentry-conventions#715
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Def wanna make these not hard-coded once that lands and probably, wait on this until then. If we need to land this first for some reason, then we should open a tracking issue to make sure it's not forgotten. |
||
| }; | ||
|
|
||
| return { | ||
| name: 'AwsLambdaWeb', | ||
| setup(client) { | ||
| if (!enabled) return; | ||
|
|
||
| client.on('httpServerRequest', (_request, _response, request) => { | ||
| const coldStart = !requestHandled; | ||
| requestHandled = true; | ||
| const requestId = request.headers?.['lambda-web-request-id']; | ||
| const endpointName = request.headers?.['lambda-web-endpoint-name']; | ||
| const scope = getIsolationScope(); | ||
| scope.setContext('aws.lambda', { | ||
| ...scope.getScopeData().contexts['aws.lambda'], | ||
| cold_start: coldStart, | ||
| aws_request_id: typeof requestId === 'string' ? requestId : undefined, | ||
| endpoint_name: typeof endpointName === 'string' ? endpointName : undefined, | ||
| }); | ||
| }); | ||
| }, | ||
| processEvent(event) { | ||
| if (!enabled) return event; | ||
| event.contexts = { | ||
| ...event.contexts, | ||
| 'aws.lambda': { ...lambdaContext, ...event.contexts?.['aws.lambda'] }, | ||
| }; | ||
| return event; | ||
| }, | ||
| processSegmentSpan(span) { | ||
| if (!enabled) return; | ||
|
|
||
| const requestContext = getIsolationScope().getScopeData().contexts['aws.lambda']; | ||
| const attributes: SpanAttributes = { ...environmentAttributes }; | ||
| if (typeof requestContext?.cold_start === 'boolean') { | ||
| attributes[FAAS_COLDSTART] = requestContext.cold_start; | ||
| } | ||
| if (typeof requestContext?.aws_request_id === 'string') { | ||
| attributes[FAAS_INVOCATION_ID] = requestContext.aws_request_id; | ||
| } | ||
| if (typeof requestContext?.endpoint_name === 'string') { | ||
| attributes['aws.lambda.web.endpoint_name'] = requestContext.endpoint_name; | ||
| } | ||
| safeSetSpanJSONAttributes(span, attributes); | ||
| }, | ||
| }; | ||
| }) satisfies IntegrationFn; | ||
|
|
||
| /** Enrich AWS Lambda Web Function spans and error contexts with platform metadata. */ | ||
| export const awsLambdaWebIntegration = defineIntegration(_awsLambdaWebIntegration); | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,6 +5,7 @@ import { readdir, readFile } from 'node:fs'; | |
| import * as os from 'node:os'; | ||
| import { join } from 'node:path'; | ||
| import { promisify } from 'node:util'; | ||
| import { CLOUD_PLATFORM, CLOUD_PROVIDER, CLOUD_REGION } from '@sentry/conventions/attributes'; | ||
| import type { | ||
| AppContext, | ||
| CloudResourceContext, | ||
|
|
@@ -524,10 +525,11 @@ function getCloudResourceContext(): CloudResourceContext | undefined { | |
| }; | ||
| } else if (process.env.AWS_REGION) { | ||
| // https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html | ||
| const executionEnv = process.env.AWS_EXECUTION_ENV; | ||
| return { | ||
| 'cloud.provider': 'aws', | ||
| 'cloud.region': process.env.AWS_REGION, | ||
| 'cloud.platform': process.env.AWS_EXECUTION_ENV, | ||
| [CLOUD_PROVIDER]: 'aws', | ||
| [CLOUD_REGION]: process.env.AWS_REGION, | ||
| [CLOUD_PLATFORM]: executionEnv?.startsWith('AWS_Lambda') ? 'aws_lambda' : executionEnv, | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Silent cloud.platform value changeMedium Severity
Triggered by project rule: PR Review Guidelines for Cursor Bot Reviewed by Cursor Bugbot for commit bf3b43e. Configure here. |
||
| }; | ||
| } else if (process.env.GCP_PROJECT) { | ||
| // https://cloud.google.com/composer/docs/how-to/managing/environment-variables#reserved_variables | ||
|
|
||


Uh oh!
There was an error while loading. Please reload this page.