@opentelemetry/instrumentation-aws-lambda
Advanced tools
OpenTelemetry AWS Lambda automatic instrumentation package.
@opentelemetry/instrumentation-aws-lambda is an npm package that provides automatic instrumentation for AWS Lambda functions using OpenTelemetry. It helps in collecting and exporting telemetry data such as traces and metrics, which can be used for monitoring and observability of serverless applications.
Automatic Tracing
This feature allows you to automatically trace AWS Lambda function invocations. The code sample demonstrates how to set up the NodeTracerProvider and register the AWS Lambda instrumentation.
const { NodeTracerProvider } = require('@opentelemetry/node');
const { AwsLambdaInstrumentation } = require('@opentelemetry/instrumentation-aws-lambda');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');
const provider = new NodeTracerProvider();
provider.register();
registerInstrumentations({
instrumentations: [
new AwsLambdaInstrumentation(),
],
});
exports.handler = async (event) => {
// Your Lambda function code
};Custom Span Attributes
This feature allows you to add custom attributes to spans within your AWS Lambda function. The code sample shows how to retrieve the current span and set a custom attribute.
const { context, trace } = require('@opentelemetry/api');
exports.handler = async (event) => {
const span = trace.getSpan(context.active());
if (span) {
span.setAttribute('custom.attribute', 'value');
}
// Your Lambda function code
};Error Handling
This feature allows you to record exceptions and set the status of spans when errors occur in your AWS Lambda function. The code sample demonstrates how to catch errors, record them, and set the span status.
const { context, trace } = require('@opentelemetry/api');
exports.handler = async (event) => {
const span = trace.getSpan(context.active());
try {
// Your Lambda function code
} catch (error) {
if (span) {
span.recordException(error);
span.setStatus({ code: 2, message: error.message });
}
throw error;
}
};This package provides automatic instrumentation for HTTP and HTTPS modules in Node.js. It is similar to @opentelemetry/instrumentation-aws-lambda in that it helps in collecting telemetry data, but it is specifically designed for HTTP/HTTPS requests rather than AWS Lambda functions.
This package provides automatic instrumentation for Express.js applications. It is similar to @opentelemetry/instrumentation-aws-lambda in terms of providing observability, but it focuses on Express.js middleware and routes instead of AWS Lambda functions.
This package provides automatic instrumentation and monitoring for AWS Lambda functions using Datadog. It is similar to @opentelemetry/instrumentation-aws-lambda in that it helps in collecting telemetry data for Lambda functions, but it is specifically designed to work with Datadog's monitoring platform.
This module provides automatic instrumentation for AWS Lambda.
This module is currently under active development and not ready for general use.
npm install --save @opentelemetry/instrumentation-aws-lambda
Create a file to initialize the instrumentation, such as lambda-wrapper.js.
const { NodeTracerProvider } = require('@opentelemetry/node');
const { AwsLambdaInstrumentation } = require('@opentelemetry/instrumentation-aws-lambda');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');
const provider = new NodeTracerProvider();
provider.register();
registerInstrumentations({
instrumentations: [
new AwsLambdaInstrumentation({
// see under for available configuration
})
],
});
In your Lambda function configuration, add or update the NODE_OPTIONS environment variable to require the wrapper, e.g.,
NODE_OPTIONS=--require lambda-wrapper
| Options | Type | Description |
|---|---|---|
requestHook | RequestHook (function) | Hook for adding custom attributes before lambda starts handling the request. Receives params: span, { event, context } |
responseHook | ResponseHook (function) | Hook for adding custom attributes before lambda returns the response. Receives params: span, { err?, res? } |
const { AwsLambdaInstrumentation } = require('@opentelemetry/instrumentation-aws-lambda');
new AwsLambdaInstrumentation({
requestHook: (span, { event, context }) => {
span.setAttributes('faas.name', context.functionName);
},
responseHook: (span, { err, res }) => {
if (err instanceof Error) span.setAttributes('faas.error', err.message);
if (res) span.setAttributes('faas.res', res);
}
})
Apache 2.0 - See LICENSE for more information.
0.20.0
opentelemetry-host-metrics, opentelemetry-id-generator-aws-xray, opentelemetry-test-utils
opentelemetry-test-utils
opentelemetry-host-metrics, opentelemetry-id-generator-aws-xray, opentelemetry-test-utils
FAQs
OpenTelemetry instrumentation for AWS Lambda function invocations
The npm package @opentelemetry/instrumentation-aws-lambda receives a total of 546,391 weekly downloads. As such, @opentelemetry/instrumentation-aws-lambda popularity was classified as popular.
We found that @opentelemetry/instrumentation-aws-lambda demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.