doc(astro): Update middleware documentation (#9502)

getsentry · Nov 9, 2023 · db5ce41 · db5ce41
1 parent ea02ee5
commit db5ce41
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/packages/astro/README.md b/packages/astro/README.md
@@ -64,8 +64,8 @@ import { sequence } from "astro:middleware";
 import * as Sentry from "@sentry/astro";
 
 export const onRequest = sequence(
-  Sentry.sentryMiddleware(),
-  // Add your other handlers after sentryMiddleware
+  Sentry.handleRequest(),
+  // Add your other handlers after Sentry.handleRequest()
 );
 ```
 

diff --git a/packages/astro/src/server/middleware.ts b/packages/astro/src/server/middleware.ts
@@ -5,16 +5,20 @@ import type { APIContext, MiddlewareResponseHandler } from 'astro';
 type MiddlewareOptions = {
   /**
    * If true, the client IP will be attached to the event by calling `setUser`.
-   * Only set this to `true` if you're fine with collecting potentially personally identifiable information (PII).
    *
-   * This will only work if your app is configured for SSR
+   * Important: Only enable this option if your Astro app is configured for (hybrid) SSR
+   * via the `output: 'server' | 'hybrid'` option in your `astro.config.mjs` file.
+   * Otherwise, Astro will throw an error when starting the server.
+   *
+   * Only set this to `true` if you're fine with collecting potentially personally identifiable information (PII).
    *
    * @default false (recommended)
    */
   trackClientIp?: boolean;
 
   /**
    * If true, the headers from the request will be attached to the event by calling `setExtra`.
+   *
    * Only set this to `true` if you're fine with collecting potentially personally identifiable information (PII).
    *
    * @default false (recommended)