NPM Package

In this guide you will learn how to set up the @sentry/aws-serverless SDK for AWS Lambda functions using NPM. We recommend starting the SDK automatically via environment variables so that you only have to make minimal code changes to your lambda function. If you need more control over the SDK setup, you can also initialize the SDK in code.

However, you need to modify your code and deploy the Sentry dependencies alongside your function code. If you're looking for the most simple way to set up Sentry, use the Lambda Layer instead.

1. Prerequisites

Before you begin, make sure you have the following:

• You have a Lambda function deployed in AWS.
• You're able to deploy dependencies (i.e. node_modules) alongside your function code to AWS Lambda.

2. Install

In addition to capturing errors, you can monitor interactions between multiple services or applications by enabling tracing. You can also collect and analyze performance profiles from real users with profiling.

Select which Sentry features you'd like to install in addition to Error Monitoring to get the corresponding installation and configuration instructions below.

Install the @sentry/aws-serverless SDK using a package manager of your choice:

npm install @sentry/aws-serverless

npm install @sentry/aws-serverless @sentry/profiling-node

3. Setup Options

Choose your setup method based on your Lambda function type:

Option A: Automatic Setup

CommonJS functions support fully automatic setup using environment variables - both SDK initialization and handler wrapping are handled automatically.

ESM functions support automatic SDK initialization via environment variables, but require manual handler wrapping.

Set the following environment variables in your Lambda function configuration:

NODE_OPTIONS="--require @sentry/aws-serverless/awslambda-auto"
SENTRY_DSN="https://examplePublicKey@o0.ingest.sentry.io/0"
#  performance
SENTRY_TRACES_SAMPLE_RATE="1.0"
#  performance

To set environment variables, navigate to your Lambda function, select Configuration, then Environment variables:

import * as Sentry from "@sentry/aws-serverless";

export const handler = Sentry.wrapHandler(async (event, context) => {
  // Your handler code
});

That's it - make sure to re-deploy your function and you're all set!

Option B: Manual Setup

To further customize the SDK setup, you can also manually initialize the SDK in your lambda function. The benefit of this installation method is that you can fully customize your Sentry SDK setup in a Sentry.init call.

For CommonJS Lambda Functions

You can initialize the SDK directly in your main handler file:

const Sentry = require("@sentry/aws-serverless");
//  profiling
const { nodeProfilingIntegration } = require("@sentry/profiling-node");

//  profiling
Sentry.init({
  dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",

  // Adds request headers and IP for users, for more info visit:
  // https://docs.sentry.io/platforms/javascript/guides/aws-lambda/configuration/options/#sendDefaultPii
  sendDefaultPii: true,
  //  profiling
  integrations: [nodeProfilingIntegration()],

  //  profiling
  //  performance
  // Add Tracing by setting tracesSampleRate and adding integration
  // Set tracesSampleRate to 1.0 to capture 100% of transactions
  // We recommend adjusting this value in production
  // Learn more at
  // https://docs.sentry.io/platforms/javascript/configuration/options/#traces-sample-rate
  tracesSampleRate: 1.0,
  //  performance
  //  profiling

  // Set sampling rate for profiling - this is relative to tracesSampleRate
  profilesSampleRate: 1.0,
  //  profiling
});

// Your package imports

exports.handler = Sentry.wrapHandler(async (event, context) => {
  // Your handler code
});

It's important to add both, the Sentry.init call outside the handler function and the Sentry.wrapHandler wrapper around your function to automatically catch errors and performance data. Make sure that the Sentry.init call and the import statement are at the very top of your file before any other imports.

For ESM Lambda Functions

First, wrap your handler:

import * as Sentry from "@sentry/aws-serverless";

export const handler = Sentry.wrapHandler(async (event, context) => {
  // Your handler code
});

Due to ESM limitations, you need to initialize the SDK in a separate file and load it before your function starts.

Create a new file, for example instrument.mjs to initialize the SDK:

import * as Sentry from "@sentry/aws-serverless";
//  profiling
import { nodeProfilingIntegration } from "@sentry/profiling-node";
//  profiling

Sentry.init({
  dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",

  // Adds request headers and IP for users, for more info visit:
  // https://docs.sentry.io/platforms/javascript/guides/aws-lambda/configuration/options/#sendDefaultPii
  sendDefaultPii: true,
  //  profiling
  integrations: [nodeProfilingIntegration()],
  //  profiling
  //  performance

  // Add Tracing by setting tracesSampleRate and adding integration
  // Set tracesSampleRate to 1.0 to capture 100% of transactions
  // We recommend adjusting this value in production
  // Learn more at
  // https://docs.sentry.io/platforms/javascript/configuration/options/#traces-sample-rate
  tracesSampleRate: 1.0,
  //  performance
  //  profiling

  // Set sampling rate for profiling - this is relative to tracesSampleRate
  profilesSampleRate: 1.0,
  //  profiling
});

Load the SDK

To load the SDK before your function starts, you need to set the NODE_OPTIONS environment variable:

NODE_OPTIONS="--import ./instrument.mjs"

To set environment variables, navigate to your Lambda function, select Configuration, then Environment variables.

That's it - make sure to re-deploy your function and you're all set!

Using the v7 SDK

The instructions above are written for the latest SDK version.

For CommonJS functions: In SDK versions prior to version 8, the @sentry/aws-serverless package was called @sentry/serverless. If you are using an older version, you can follow this guide but replace the package with @sentry/serverless.

For ESM functions: The v7 @sentry/serverless SDK does not work correctly with ESM-based Lambda functions. Please upgrade to the latest SDK and follow the instructions above.