Astro

Learn how to manually set up Sentry in your Astro app and capture your first errors.

You need:

  • A Sentry account and project
  • Your application up and running
  • Astro 3.0.0 or above
  • If you're using Astro's Netlify adapter (@astrojs/netlify), you need version 5.0.0 or above

Choose the features you want to configure, and this guide will show you how:

Want to learn more about these features?
  • Issues (always enabled): Sentry's core error monitoring product that automatically reports errors, uncaught exceptions, and unhandled rejections. If you have something that looks like an exception, Sentry can capture it.
  • Tracing: Track software performance while seeing the impact of errors across multiple systems. For example, distributed tracing allows you to follow a request from the frontend to the backend and back.
  • Session Replay: Get to the root cause of an issue faster by viewing a video-like reproduction of what was happening in the user's browser before, during, and after the problem.
  • Profiling: Gain deeper insight than traditional tracing without custom instrumentation, letting you discover slow-to-execute or resource-intensive functions in your app.
  • Logs: Centralize and analyze your application logs to correlate them with errors and performance issues. Search, filter, and visualize log data to understand what's happening in your applications.

Install and add the Sentry integration using the astro CLI:

Copied
npx astro add @sentry/astro

Next, install the Profiling package using your preferred package manager:

Copied
npm install @sentry/profiling-node

Register the Sentry integration in your astro.config.mjs file:

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

export default defineConfig({
  integrations: [sentry()],
});

Create a sentry.client.config.(ts|js) file in the root of your project. In this file, import and initialize Sentry for the client:

sentry.client.config.(ts|js)
Copied
import * as Sentry from "@sentry/astro";

Sentry.init({
  dsn: "___PUBLIC_DSN___",

  // Adds request headers and IP for users, for more info visit:
  // https://docs.sentry.io/platforms/javascript/guides/astro/configuration/options/#sendDefaultPii
  sendDefaultPii: true,

    // ___PRODUCT_OPTION_START___ performance
    Sentry.browserTracingIntegration(),
    // ___PRODUCT_OPTION_END___ performance
    // ___PRODUCT_OPTION_START___ session-replay
    Sentry.replayIntegration(),
    // ___PRODUCT_OPTION_END___ session-replay
    // ___PRODUCT_OPTION_START___ user-feedback
    Sentry.feedbackIntegration({
      // Additional SDK configuration goes in here, for example:
      colorScheme: "system",
    }),
    // ___PRODUCT_OPTION_END___ user-feedback
  // ___PRODUCT_OPTION_START___ performance

  // Define how likely traces are sampled. Adjust this value in production,
  // or use tracesSampler for greater control.
  tracesSampleRate: 1.0,
  // ___PRODUCT_OPTION_END___ performance
  // ___PRODUCT_OPTION_START___ session-replay

  // This sets the sample rate to be 10%. You may want this to be 100% while
  // in development and sample at a lower rate in production
  replaysSessionSampleRate: 0.1,

  // If the entire session is not sampled, use the below sample rate to sample
  // sessions when an error occurs.
  replaysOnErrorSampleRate: 1.0,
  // ___PRODUCT_OPTION_END___ session-replay
  // ___PRODUCT_OPTION_START___ logs

  // Enable logs to be sent to Sentry
  enableLogs: true,
  // ___PRODUCT_OPTION_END___ logs
});
Want to change your Sentry config files location or name?

Sentry automatically detects configuration files named sentry.(client|server).config.(ts|js) in the root of your project. You can rename these files or move them to a custom folder within your project. To change their location or names, specify the paths in the Sentry Astro integration options in your astro.config.mjs:

astro.config.mjs
Copied
export default defineConfig({
  // Other Astro project options
  integrations: [
    sentry({
      clientInitPath: ".config/sentryClientInit.js",
      serverInitPath: ".config/sentryServerInit.js",
    }),
  ],
});

Create a sentry.server.config.(ts|js) file in the root of your project. In this file, import and initialize Sentry for the server:

sentry.server.config.(ts|js)
Copied
import * as Sentry from "@sentry/astro";
// ___PRODUCT_OPTION_START___ profiling
import { nodeProfilingIntegration } from "@sentry/profiling-node";
// ___PRODUCT_OPTION_END___ profiling

Sentry.init({
  dsn: "___PUBLIC_DSN___",

  // Adds request headers and IP for users, for more info visit:
  // https://docs.sentry.io/platforms/javascript/guides/astro/configuration/options/#sendDefaultPii
  sendDefaultPii: true,
  // ___PRODUCT_OPTION_START___ profiling

    // Add our Profiling integration
    nodeProfilingIntegration(),
  // ___PRODUCT_OPTION_END___ profiling
  // ___PRODUCT_OPTION_START___ performance

  // Define how likely traces are sampled. Adjust this value in production,
  // or use tracesSampler for greater control.
  tracesSampleRate: 1.0,
  // ___PRODUCT_OPTION_END___ performance
  // ___PRODUCT_OPTION_START___ profiling

  // Define how many user sessions have profiling enabled.
  profileSessionSampleRate: 1.0,
  // ___PRODUCT_OPTION_END___ profiling
  // ___PRODUCT_OPTION_START___ logs

  // Enable logs to be sent to Sentry
  enableLogs: true,
  // ___PRODUCT_OPTION_END___ logs
});

To upload source maps for clear error stack traces, add your Sentry auth token, organization, and project slugs in the sentry options inside astro.config.mjs:

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

export default defineConfig({
  integrations: [
    sentry({
      org: "___ORG_SLUG___",
      project: "___PROJECT_SLUG___",
      // store your auth token in an environment variable
      authToken: process.env.SENTRY_AUTH_TOKEN,
    }),
  ],
});

To keep your auth token secure, set the SENTRY_AUTH_TOKEN environment variable in your build environment:

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

You can prevent ad blockers from blocking Sentry events using tunneling. Use the tunnel option to add an API endpoint in your application that forwards Sentry events to Sentry servers.

To enable tunneling, update Sentry.init with the following option:

Copied
Sentry.init({
  dsn: "___PUBLIC_DSN___",

  tunnel: "/tunnel",

});

This will send all events to the tunnel endpoint. However, the events need to be parsed and redirected to Sentry, so you'll need to do additional configuration on the server. You can find a detailed explanation on how to do this on our Troubleshooting page.

Let's test your setup and confirm that Sentry is working correctly and sending data to your Sentry project.

To verify that Sentry captures errors and creates issues in your Sentry project, create a test page, for example, at src/pages/test.astro with two buttons:

test.astro
Copied
<script>
  const buttonOne = document.getElementById("one");
  const buttonTwo = document.getElementById("two");

  buttonOne.addEventListener("click", throwTestError);
  buttonTwo.addEventListener("click", throwApiError);

  function throwTestError() {
    throw new Error("Sentry Example Frontend Error");
  }

  async function throwApiError() {
    await fetch("/api/test-error");
  }
</script>

<button id="one" type="button">Throw a frontend error</button>
<button id="two" type="button">Throw an API error</button>

Then also create the route we're calling in our test page, like src/pages/api/test-error.(js|ts):

test-error.(js|ts)
Copied
export async function GET() {
  throw new Error("Sentry Example API Route Error");
}

Open the page in a browser and click the buttons to trigger a frontend error and an error in the API route.

To test tracing, create a custom span to measure the time it takes for the API request to complete:

test.astro
Copied
<script>
  import * as Sentry from "@sentry/astro";

  const button = document.getElementById("one");

  button.addEventListener("click", throwApiError);

  async function throwApiError() {
    await Sentry.startSpan(
      {
        name: "Example Frontend Span",
        op: "test",
      },
      async () => {
        await fetch("/api/test-error");
      },
    );
  }
</script>

<button id="one" type="button">Throw an API error with a trace</button>

Now, head over to your project on Sentry.io to view the collected data (it takes a couple of moments for the data to appear).

Need help locating the captured errors in your Sentry project?
  1. Open the Issues page and select an error from the issues list to view the full details and context of this error. For more details, see this interactive walkthrough.
  2. Open the Traces page and select a trace to reveal more information about each span, its duration, and any errors. For an interactive UI walkthrough, click here.
  3. Open the Replays page and select an entry from the list to get a detailed view where you can replay the interaction and get more information to help you troubleshoot.
  4. Open the Profiles page, select a transaction, and then a profile ID to view its flame graph. For more information, click here.
  5. Open the Logs page and filter by service, environment, or search keywords to view log entries from your application. For an interactive UI walkthrough, click here.

At this point, you should have integrated Sentry into your Astro application and should already be sending data to your Sentry project.

Now's a good time to customize your setup and look into more advanced topics. Our next recommended steps for you are:

Are you having problems setting up the SDK?
Previous
Welcome to Sentry
Next
Capturing Errors
Was this helpful?
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").