Astro

Sentry's Astro SDK enables automatic reporting of errors and performance data.

Compatibility

The minimum supported Astro version is 3.0.0. This SDK currently only works on Node runtimes. Non-Node runtimes, like Vercel's Edge runtime or Cloudflare Pages, are currently not supported.

We recommend installing the SDK by using the astro CLI:

npx astro add @sentry/astro

The astro CLI installs the SDK package and adds the Sentry integration to your astro.config.mjs file.

To finish the setup, configure the Sentry integration.

Get started by adding your

import { defineConfig } from "astro/config";
import sentry from "@sentry/astro";

export default defineConfig({
  integrations: [
    sentry({
      dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
      sourceMapsUploadOptions: {
        project: "example-project",
        authToken: process.env.SENTRY_AUTH_TOKEN,
      },
    }),
  ],
});

Once you've added your dsn, the SDK will automatically capture and send errors and performance events to Sentry.

Add Readable Stack Traces to Errors

To get readable stack traces in your production builds, add the SENTRY_AUTH_TOKEN environment variable to your environment, like in a .env file or in your CI setup.

SENTRY_AUTH_TOKEN=sntrys_YOUR_TOKEN_HERE

This, in combination with your sourceMapsUploadOptions configuration, will upload source maps to Sentry every time you make a production build.

Trigger a test error somewhere in your Astro app, for example in one of your pages:

<button onclick="throw new Error('This is a test error')">
  Throw test error
</button>