@benhepburn/adonis-sentry 1.0.1 → 1.0.4

package/README.md

@@ -35,6 +35,13 @@ SENTRY_DSN=https://<...>.sentry.io/<...>
 SENTRY_TRACES_SAMPLE_RATE=1.0 # Set this to a lower value in production
 ```
 
+To enable enhanced event data, you must enable useAsyncLocalStorage in config/app.ts 
+so the current request can be fetched ([see caveats here](https://docs.adonisjs.com/guides/async-local-storage#caveats)):
+
+```ts
+useAsyncLocalStorage: true,
+```
+
 ## Usage
 
 Import the service to use it:
@@ -43,13 +50,17 @@ Import the service to use it:
 import sentry from "@benhepburn/adonis-sentry/service"
 ```
 
-To capture all exceptions, add this line to app/exceptions/handler inside the handle function:
+To capture all exceptions, add the capture line to app/exceptions/handler.ts inside the report function:
 
 ```ts
-sentry.captureException(error);
+async report(error: unknown, ctx: HttpContext) {
+  sentry.captureException(error); // Add this line
+  ...
+  return super.report(error, ctx);
+}
 ```
 
-This can be used to capture exceptions manually as well:
+Exceptions can be captured manually as well:
 
 ```ts
 try {

package/build/providers/sentry_provider.js

@@ -1,4 +1,5 @@
 import * as Sentry from '@sentry/node';
+import { adonisEventProcessor } from '../src/adonis_event_processor.js';
 export default class SentryProvider {
     app;
     constructor(app) {
@@ -12,6 +13,7 @@ export default class SentryProvider {
             const config = await resolver.make('config');
             const sentryConfig = config.get('sentry');
             Sentry.init(sentryConfig);
+            Sentry.addEventProcessor(adonisEventProcessor);
             return Sentry;
         });
     }

package/build/src/adonis_event_processor.d.ts

@@ -0,0 +1,2 @@
+import { EventProcessor } from '@sentry/types/types/eventprocessor.js';
+export declare const adonisEventProcessor: EventProcessor;

package/build/src/adonis_event_processor.js

@@ -0,0 +1,21 @@
+import { HttpContext } from '@adonisjs/core/http';
+export const adonisEventProcessor = (event, _hint) => {
+    const ctx = HttpContext.get();
+    if (!ctx)
+        return event;
+    if (!event.contexts)
+        event.contexts = {};
+    // Add request data
+    event.request = {
+        method: ctx.request.method(),
+        url: ctx.request.url(true),
+    };
+    // Add response data
+    event.contexts.response = {
+        status_code: ctx.response.getStatus(),
+    };
+    // Add user
+    // @ts-ignore
+    event.user = ctx.auth?.user || null;
+    return event;
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@benhepburn/adonis-sentry",
   "description": "A Sentry integration for AdonisJS v6",
-  "version": "1.0.1",
+  "version": "1.0.4",
   "engines": {
     "node": ">=20.0.0"
   },