-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Patch aws-lambda instrumentation to support ESM
commit d25c3c3 Author: Min Xia <xiami@amazon.com> Date: Tue Oct 8 15:45:36 2024 -0700 fix the lint error
- Loading branch information
Showing
4 changed files
with
205 additions
and
3 deletions.
There are no files selected for viewing
121 changes: 121 additions & 0 deletions
121
aws-distro-opentelemetry-node-autoinstrumentation/src/patches/aws/services/aws-lambda.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| import { AwsLambdaInstrumentation } from '@opentelemetry/instrumentation-aws-lambda'; | ||
| import * as path from 'path'; | ||
| import * as fs from 'fs'; | ||
| import { InstrumentationNodeModuleDefinition, InstrumentationNodeModuleFile, isWrapped } from '@opentelemetry/instrumentation'; | ||
| import { diag } from '@opentelemetry/api'; | ||
|
|
||
| export class AwsLambdaInstrumentationPatch extends AwsLambdaInstrumentation { | ||
|
|
||
| override init() { | ||
| // Custom logic before calling the original implementation | ||
| diag.debug('Initializing AwsLambdaInstrumentationPatch'); | ||
| const taskRoot = process.env.LAMBDA_TASK_ROOT; | ||
| const handlerDef = this._config.lambdaHandler ?? process.env._HANDLER; | ||
|
|
||
| // _HANDLER and LAMBDA_TASK_ROOT are always defined in Lambda but guard bail out if in the future this changes. | ||
| if (!taskRoot || !handlerDef) { | ||
| this._diag.debug( | ||
| 'Skipping lambda instrumentation: no _HANDLER/lambdaHandler or LAMBDA_TASK_ROOT.', | ||
| { taskRoot, handlerDef } | ||
| ); | ||
| return []; | ||
| } | ||
|
|
||
| const handler = path.basename(handlerDef); | ||
| const moduleRoot = handlerDef.substr(0, handlerDef.length - handler.length); | ||
|
|
||
| const [module, functionName] = handler.split('.', 2); | ||
|
|
||
| // Lambda loads user function using an absolute path. | ||
| let filename = path.resolve(taskRoot, moduleRoot, module); | ||
| if (!filename.endsWith('.js')) { | ||
| // its impossible to know in advance if the user has a cjs or js file. | ||
| // check that the .js file exists otherwise fallback to next known possibility | ||
| try { | ||
| fs.statSync(`${filename}.js`); | ||
| filename += '.js'; | ||
| } catch (e) { | ||
| // fallback to .cjs | ||
| try { | ||
| fs.statSync(`${filename}.cjs`); | ||
| filename += '.cjs'; | ||
| } catch (e) { | ||
| // fall back to .mjs | ||
| filename += '.mjs'; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| diag.debug('Instrumenting lambda handler', { | ||
| taskRoot, | ||
| handlerDef, | ||
| handler, | ||
| moduleRoot, | ||
| module, | ||
| filename, | ||
| functionName, | ||
| }); | ||
|
|
||
| if (filename.endsWith('.mjs') || process.env.IS_ESM) { | ||
| return [ | ||
| new InstrumentationNodeModuleDefinition( | ||
| // NB: The patching infrastructure seems to match names backwards, this must be the filename, while | ||
| // InstrumentationNodeModuleFile must be the module name. | ||
| filename, | ||
| ['*'], | ||
| (moduleExports: any) => { | ||
| diag.debug('Applying patch for lambda esm handler'); | ||
| if (isWrapped(moduleExports[functionName])) { | ||
| this._unwrap(moduleExports, functionName); | ||
| } | ||
| this._wrap( | ||
| moduleExports, | ||
| functionName, | ||
| (this as any)._getHandler() | ||
| ); | ||
| return moduleExports; | ||
| }, | ||
| (moduleExports?: any) => { | ||
| if (moduleExports == null) return; | ||
| diag.debug('Removing patch for lambda esm handler'); | ||
| this._unwrap(moduleExports, functionName); | ||
| } | ||
| ) | ||
| ]; | ||
| } else { | ||
| return [ | ||
| new InstrumentationNodeModuleDefinition( | ||
| // NB: The patching infrastructure seems to match names backwards, this must be the filename, while | ||
| // InstrumentationNodeModuleFile must be the module name. | ||
| filename, | ||
| ['*'], | ||
| undefined, | ||
| undefined, | ||
| [ | ||
| new InstrumentationNodeModuleFile( | ||
| module, | ||
| ['*'], | ||
| (moduleExports: any) => { | ||
| diag.debug('Applying patch for lambda handler'); | ||
| if (isWrapped(moduleExports[functionName])) { | ||
| this._unwrap(moduleExports, functionName); | ||
| } | ||
| this._wrap( | ||
| moduleExports, | ||
| functionName, | ||
| (this as any)._getHandler() | ||
| ); | ||
| return moduleExports; | ||
| }, | ||
| (moduleExports?: any) => { | ||
| if (moduleExports == null) return; | ||
| diag.debug('Removing patch for lambda handler'); | ||
| this._unwrap(moduleExports, functionName); | ||
| } | ||
| ), | ||
| ] | ||
| ), | ||
| ]; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| #!/bin/bash | ||
| export NODE_OPTIONS="${NODE_OPTIONS} --import @aws/aws-distro-opentelemetry-node-autoinstrumentation/register --experimental-loader=@opentelemetry/instrumentation/hook.mjs" | ||
| export LAMBDA_RESOURCE_ATTRIBUTES="cloud.region=$AWS_REGION,cloud.provider=aws,faas.name=$AWS_LAMBDA_FUNCTION_NAME,faas.version=$AWS_LAMBDA_FUNCTION_VERSION,faas.instance=$AWS_LAMBDA_LOG_STREAM_NAME,aws.log.group.names=$AWS_LAMBDA_LOG_GROUP_NAME"; | ||
| export IS_ESM=true | ||
|
|
||
| # - If OTEL_EXPORTER_OTLP_PROTOCOL is not set by user, the default exporting protocol is http/protobuf. | ||
| if [ -z "${OTEL_EXPORTER_OTLP_PROTOCOL}" ]; then | ||
| export OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf | ||
| fi | ||
|
|
||
| # - If OTEL_NODE_ENABLED_INSTRUMENTATIONS is not set by user, use default instrumentation | ||
| if [ -z "${OTEL_NODE_ENABLED_INSTRUMENTATIONS}" ]; then | ||
| export OTEL_NODE_ENABLED_INSTRUMENTATIONS="aws-lambda,aws-sdk" | ||
| fi | ||
|
|
||
| # - Set the service name | ||
| if [ -z "${OTEL_SERVICE_NAME}" ]; then | ||
| export OTEL_SERVICE_NAME=$AWS_LAMBDA_FUNCTION_NAME; | ||
| fi | ||
|
|
||
| # - Set the propagators | ||
| if [[ -z "$OTEL_PROPAGATORS" ]]; then | ||
| export OTEL_PROPAGATORS="tracecontext,baggage,xray" | ||
| fi | ||
|
|
||
| # - Set Application Signals configuration | ||
| if [ -z "${OTEL_AWS_APPLICATION_SIGNALS_ENABLED}" ]; then | ||
| export OTEL_AWS_APPLICATION_SIGNALS_ENABLED="true"; | ||
| fi | ||
|
|
||
| if [ -z "${OTEL_METRICS_EXPORTER}" ]; then | ||
| export OTEL_METRICS_EXPORTER="none"; | ||
| fi | ||
|
|
||
| # - Append Lambda Resource Attributes to OTel Resource Attribute List | ||
| if [ -z "${OTEL_RESOURCE_ATTRIBUTES}" ]; then | ||
| export OTEL_RESOURCE_ATTRIBUTES=$LAMBDA_RESOURCE_ATTRIBUTES; | ||
| else | ||
| export OTEL_RESOURCE_ATTRIBUTES="$LAMBDA_RESOURCE_ATTRIBUTES,$OTEL_RESOURCE_ATTRIBUTES"; | ||
| fi | ||
|
|
||
| if [[ $OTEL_RESOURCE_ATTRIBUTES != *"service.name="* ]]; then | ||
| export OTEL_RESOURCE_ATTRIBUTES="service.name=${AWS_LAMBDA_FUNCTION_NAME},${OTEL_RESOURCE_ATTRIBUTES}" | ||
| fi | ||
|
|
||
| exec "$@" |