esbuild

You can use the Sentry esbuild plugin to automatically create releases and upload source maps to Sentry when bundling your app.

Automatic Setup

The easiest way to configure uploading source maps with esbuild is by using the Sentry Wizard:

Copied
npx @sentry/wizard@latest -i sourcemaps

The wizard will guide you through the following steps:

  • Logging into Sentry and selecting a
    projectRepresents your service in Sentry and allows you to scope events to a distinct application.
  • Installing the necessary Sentry packages
  • Configuring your build tool to generate and upload source maps
  • Configuring your CI to upload source maps

If you want to configure source maps upload with esbuild manually, follow the steps below.

Manual Setup

Install the Sentry esbuild plugin:

Copied
npm install @sentry/esbuild-plugin --save-dev

Configure

To upload source maps you have to configure an auth

tokenIn search, a key-value pair or raw search term. Also, a value used for authorization.
. Auth tokens can be passed to the plugin explicitly with the authToken option, with a SENTRY_AUTH_TOKEN environment variable, or with an .env.sentry-build-plugin file in the working directory when building your
projectRepresents your service in Sentry and allows you to scope events to a distinct application.
. We recommend you add the auth token to your CI/CD environment as an environment variable.

Learn more about configuring the plugin in our Sentry esbuild Plugin documentation.

.env.sentry-build-plugin
Copied
SENTRY_AUTH_TOKEN=sntrys_YOUR_TOKEN_HERE

Example:

esbuild.config.js
Copied
const { sentryEsbuildPlugin } = require("@sentry/esbuild-plugin");

require("esbuild").build({
  sourcemap: true, // Source map generation must be turned on
  plugins: [
    // Put the Sentry esbuild plugin after all other plugins
    sentryEsbuildPlugin({
      org: "example-org",
      project: "example-project",
      authToken: process.env.SENTRY_AUTH_TOKEN,
    }),
  ],
});
Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").