@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:

• Enabeling 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.35.0

Beta release of the official Nuxt Sentry SDK

This release marks the beta release of the @sentry/nuxt Sentry SDK. For details on how to use it, check out the Sentry Nuxt SDK README. Please reach out on GitHub if you have any feedback or concerns.

• feat(nuxt): Make dynamic import() wrapping default (#13958) (BREAKING)
• feat(nuxt): Add Rollup plugin to wrap server entry with import() (#13945)

It is no longer required to add a Node --import flag. Please update your start command to avoid initializing Sentry twice (BREAKING CHANGE). The SDK will now apply modifications during the build of your application to allow for patching of libraries during runtime. If run into issues with this change, you can disable this behavior in your nuxt.config.ts and use the --import flag instead:

sentry: {
  dynamicImportForServerEntry: false;
}

• feat(nuxt): Respect user-provided source map generation settings (#14020)

We now require you to explicitly enable sourcemaps for the clientside so that Sentry can un-minify your errors. We made this change so source maps aren't accidentally leaked to the public. Enable source maps on the client as follows:

export default defineNuxtConfig({
  sourcemap: {
    client: true,
  },
});

• feat(nuxt): Log server instrumentation might not work in dev (#14021)
• feat(nuxt): Add Http responseHook with waitUntil (#13986)

Important Changes

• feat(vue): Add Pinia plugin (#13841)

Support for Pinia is added in this release for @sentry/vue. To capture Pinia state data, add createSentryPiniaPlugin() to your Pinia store:

import { createPinia } from 'pinia';
import { createSentryPiniaPlugin } from '@sentry/vue';

const pinia = createPinia();

pinia.use(createSentryPiniaPlugin());

• feat(node): Implement Sentry-specific http instrumentation (#13763)

This change introduces a new SentryHttpInstrumentation to handle non-span related HTTP instrumentation, allowing it to run side-by-side with OTel's HttpInstrumentation. This improves support for custom OTel setups and avoids conflicts with Sentry's instrumentation. Additionally, the spans: false option is reintroduced for httpIntegration to disable span emission while still allowing custom HttpInstrumentation instances (httpIntegration({ spans: false })).

• feat(core): Make stream instrumentation opt-in (#13951)

This change adds a new option trackFetchStreamPerformance to the browser tracing integration. Only when set to true, Sentry will instrument streams via fetch.

Other Changes

• feat(node): Expose suppressTracing API (#13875)
• feat(replay): Do not log "timeout while trying to read resp body" as exception (#13965)
• chore(node): Bump @opentelemetry/instrumentation-express to 0.43.0 (#13948)
• chore(node): Bump @opentelemetry/instrumentation-fastify to 0.40.0 (#13983)
• fix: Ensure type for init is correct in meta frameworks (#13938)
• fix(core): .set the sentry-trace header instead of .appending in fetch instrumentation (#13907)
• fix(module): keep version for node ESM package (#13922)
• fix(node): Ensure ignoreOutgoingRequests of httpIntegration applies to breadcrumbs (#13970)
• fix(replay): Fix onError sampling when loading an expired buffered session (#13962)
• fix(replay): Ignore older performance entries when starting manually (#13969)
• perf(node): Truncate breadcrumb messages created by console integration (#14006)

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