@rlanz/sentry
is a simple wrapper around the Sentry SDK to make it easier to use in a AdonisJS application.
node ace add @rlanz/sentry
The package will automatically register a middleware and configure the Sentry SDK.
import type { HttpContext } from '@adonisjs/core/http'
import { Sentry } from '@rlanz/sentry'
export default class HelloController {
greet({ params, response}: HttpContext) {
Sentry.captureMessage(`Hello, ${params.name}!`)
return response.ok({ message: `Hello, ${params.name}!` })
}
}
The SDK is automatically scoped to the current request.
import { inject } from '@adonisjs/core'
import { Sentry } from '@rlanz/sentry'
@inject()
export class GreetingService {
greet(name: string) {
Sentry.captureMessage(`Hello, ${name}!`)
return `Hello, ${name}!`
}
}
You can capture errors by calling the captureException
method on the SDK inside your exception handler.
import { Sentry } from '@rlanz/sentry'
export default class HttpExceptionHandler extends ExceptionHandler {
// ...
async report(error: unknown, ctx: HttpContext) {
if (this.shouldReport(error as any)) {
Sentry.captureException(error)
}
return super.report(error, ctx)
}
}
You can assign user context to the Sentry SDK by calling the setUser
method on the SDK once you are logged in.
import { Sentry } from '@rlanz/sentry'
export default class SilentAuthMiddleware {
async handle(ctx: HttpContext, next: NextFn) {
// We are authenticating the user
await ctx.auth.check()
// If the user is authenticated, we assign the user context to Sentry
if (ctx.auth.isAuthenticated) {
const user = ctx.auth.getUserOrFail()
Sentry.setUser({
id: user.id,
email: user.email,
username: user.username,
});
}
return await next();
}
}
Sentry provides multiple integrations to enhance the data captured by the SDK. You can add integrations by changing the integrations
array inside the configuration config/sentry.ts
.
For example, if you want to add profiling to your application, you can add the Profiler
integration.
npm install @sentry/profiling-node
// config/sentry.ts
import { nodeProfilingIntegration } from '@sentry/profiling-node';
export default defineConfig({
// ...
integrations: [nodeProfilingIntegration()],
profilesSampleRate: 0.2,
})