@sentry/astro

Official Sentry SDK for Astro

Links

• Official SDK Docs

SDK Status

This SDK is in Beta and not yet fully stable. If you have feedback or encounter any bugs, feel free to open an issue.

General

This package is a wrapper around @sentry/node for the server and @sentry/browser for the client side.

Installation and Setup

Install the Sentry Astro SDK with the astro CLI:

npx astro add @sentry/astro

Add your DSN and source maps upload configuration:

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

export default defineConfig({
  integrations: [
    sentry({
      dsn: '__DSN__',
      sourceMapsUploadOptions: {
        project: 'your-sentry-project-slug',
        authToken: process.env.SENTRY_AUTH_TOKEN,
      },
    }),
  ],
});

Follow this guide to create an auth token and add it to your environment variables:

SENTRY_AUTH_TOKEN="your-token"

Server Instrumentation

For Astro apps configured for (hybrid) Server Side Rendering (SSR), the Sentry integration will automatically add middleware to your server to instrument incoming requests if you're using Astro 3.5.2 or newer.

If you're using Astro <3.5.2, complete the setup by adding the Sentry middleware to your src/middleware.js file:

// src/middleware.js
import { sequence } from 'astro:middleware';
import * as Sentry from '@sentry/astro';

export const onRequest = sequence(
  Sentry.handleRequest(),
  // Add your other handlers after Sentry.handleRequest()
);

The Sentry middleware enhances the data collected by Sentry on the server side by:

• Enabling distributed tracing between client and server
• Collecting performance spans for incoming requests
• Enhancing captured errors with additional information

Disable Automatic Server Instrumentation

You can opt out of using the automatic sentry server instrumentation in your astro.config.mjs file:

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

export default defineConfig({
  integrations: [
    sentry({
      dsn: '__DSN__',
      autoInstrumentation: {
        requestHandler: false,
      },
    }),
  ],
});

Configuration

Check out our docs for configuring your SDK setup:

• Getting Started
• Manual Setup and Configuration
• Source Maps Upload

Changelog

8.45.0

• feat(core): Add handled option to captureConsoleIntegration (#14664)
• feat(browser): Attach virtual stack traces to HttpClient events (#14515)
• feat(replay): Upgrade rrweb packages to 2.31.0 (#14689)
• fix(aws-serverless): Remove v8 layer as it overwrites the current layer for docs (#14679)
• fix(browser): Mark stack trace from captureMessage with attachStacktrace: true as synthetic (#14668)
• fix(core): Mark stack trace from captureMessage with attatchStackTrace: true as synthetic (#14670)
• fix(core): Set level in server runtime captureException (#10587)
• fix(profiling-node): Guard invocation of native profiling methods (#14676)
• fix(nuxt): Inline nitro-utils function (#14680)
• fix(profiling-node): Ensure profileId is added to transaction event (#14681)
• fix(react): Add React Router Descendant Routes support (#14304)
• fix: Disable ANR and Local Variables if debugger is enabled via CLI args (#14643)

Work in this release was contributed by @anonrig and @Zih0. Thank you for your contributions!