Skip to content

docs(astro): Point README to SDK documentation #24626

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nicohrubec merged 2 commits into from
Sep 23, 2026
Merged

docs(astro): Point README to SDK documentation #24626

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
faadffa
docs(astro): Point README to SDK documentation
nicohrubec Sep 23, 2026
5216223
docs: Preserve SDK alpha and beta notices
nicohrubec Sep 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 7 additions & 127 deletions packages/astro/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,137 +10,17 @@
[![npm dm](https://img.shields.io/npm/dm/@sentry/astro.svg)](https://www.npmjs.com/package/@sentry/astro)
[![npm dt](https://img.shields.io/npm/dt/@sentry/astro.svg)](https://www.npmjs.com/package/@sentry/astro)

## Links

- [Official SDK Docs](https://docs.sentry.io/platforms/javascript/guides/astro/)

## SDK Status
The official Sentry SDK for monitoring Astro applications.

This SDK is in Beta and not yet fully stable. If you have feedback or encounter any bugs, feel free to
[open an issue](https://github.com/getsentry/sentry-javascript/issues/new/choose).

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

```bash
npx astro add @sentry/astro
```

### Build-time Configuration

Register the Sentry integration in your `astro.config.mjs`. This is where you configure build-time options such as
source maps upload (`org`, `project`, `authToken`). Runtime SDK options (`dsn`, `environment`, `tracesSampleRate`, Replay
sample rates, and so on) belong in dedicated init files, not on `sentry()`.

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

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

Follow [this guide](https://docs.sentry.io/product/accounts/auth-tokens/#organization-auth-tokens) to create an auth
token and add it to your environment variables:

```bash
SENTRY_AUTH_TOKEN="your-token"
```

### Runtime SDK Configuration

If you do not add `sentry.client.config.ts` or `sentry.server.config.ts`, Sentry still initializes with default options
and reads the DSN from `PUBLIC_SENTRY_DSN`. Add those files at the project root when you want to customize client or
server options, and pass them to `Sentry.init()`.

Set `PUBLIC_SENTRY_DSN` in your environment (for example in `.env`):

```bash
PUBLIC_SENTRY_DSN="__DSN__"
```

```javascript
// sentry.client.config.ts
import * as Sentry from '@sentry/astro';

Sentry.init({
dsn: '__DSN__',
tracesSampleRate: 1.0,
integrations: [Sentry.replayIntegration()],
replaysSessionSampleRate: 0.1,
replaysOnErrorSampleRate: 1.0,
});
```

```javascript
// sentry.server.config.ts
import * as Sentry from '@sentry/astro';

Sentry.init({
dsn: '__DSN__',
tracesSampleRate: 1.0,
});
```

### 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.

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:

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

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

If you opt out but still want the middleware, add it manually to your `src/middleware.js` file:

```javascript
// 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()
);
```
## Documentation

## Configuration
- [Getting started](https://docs.sentry.io/platforms/javascript/guides/astro/)
- [Configuration](https://docs.sentry.io/platforms/javascript/guides/astro/configuration/)

Check out our docs for configuring your SDK setup:
## Support

- [Getting Started](https://docs.sentry.io/platforms/javascript/guides/astro/)
- [Manual Setup and Configuration](https://docs.sentry.io/platforms/javascript/guides/astro/manual-setup/)
- [Source Maps Upload](https://docs.sentry.io/platforms/javascript/guides/astro/sourcemaps/)
- [Report a bug](https://github.com/getsentry/sentry-javascript/issues/new/choose)
- [Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md)
Loading