@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.37.0

Important Changes

• feat(nuxt): Add piniaIntegration (#14138)

The Nuxt SDK now allows you to track Pinia state for captured errors. To enable the Pinia plugin, add the piniaIntegration to your client config:

// sentry.client.config.ts
import { usePinia } from '#imports';

Sentry.init({
  integrations: [
    Sentry.piniaIntegration(usePinia(), {
      /* optional Pinia plugin options */
    }),
  ],
});

• feat: Deprecate metrics API (#14157)

The Sentry Metrics beta has ended in favour of revisiting metrics in another form at a later date.

This new approach will include different APIs, making the current metrics API unnecessary. This release deprecates the metrics API with the plan to remove in the next SDK major version. If you currently use the metrics API in your code, you can safely continue to do so but sent data will no longer be processed by Sentry.

Learn more about the end of the Metrics beta.

Other Changes

• feat(browser): Add http.response_delivery_type attribute to resource spans (#14056)
• feat(browser): Add skipBrowserExtensionCheck escape hatch option (#14147)
• feat(deps): Bump @opentelemetry/instrumentation from 0.53.0 to 0.54.0 (#14174)
• feat(deps): Bump @opentelemetry/instrumentation-fastify from 0.40.0 to 0.41.0 (#14175)
• feat(deps): Bump @opentelemetry/instrumentation-graphql from 0.43.0 to 0.44.0 (#14173)
• feat(deps): Bump @opentelemetry/instrumentation-mongodb from 0.47.0 to 0.48.0 (#14171)
• feat(deps): Bump @opentelemetry/propagator-aws-xray from 1.25.1 to 1.26.0 (#14172)
• feat(nuxt): Add asyncFunctionReExports to define re-exported server functions (#14104)
• feat(nuxt): Add piniaIntegration (#14138)
• fix(browser): Avoid recording long task spans starting before their parent span (#14183)
• fix(core): Ensure errors thrown in async cron jobs bubble up (#14182)
• fix(core): Silently fail maybeInstrument (#14140)
• fix(nextjs): Resolve path for dynamic webpack import (#13751)
• fix(node): Make sure modulesIntegration does not crash esm apps (#14169)

Work in this release was contributed by @rexxars. Thank you for your contribution!