Skip to content

feat(js): Update docs for prisma integration #14876

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
merged 1 commit into from
Sep 11, 2025
Merged

feat(js): Update docs for prisma integration #14876

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 7 additions & 22 deletions docs/platforms/javascript/common/configuration/integrations/prisma.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Prisma
description: "Adds instrumentation for Prisma."
description: "Adds instrumentation for Prisma. (default)"
supported:
- javascript.node
- javascript.aws-lambda
Expand Down Expand Up @@ -36,13 +36,13 @@ Sentry supports tracing [Prisma ORM](https://www.prisma.io/) queries with the Pr

The Prisma Integrations creates a spans for each query and reports to Sentry with relevant details inside the`description` if available.

This integration is enabled by default when using Prisma version 6 or higher.
When using Prisma version 5 this integration requires additional setup, which you can read about below.
This integration is enabled by default and supports Prisma versions 5 & 6. In Prisma v5, you need to follow the instructions below to enable tracing.

If you'd like to learn how to modify your default integrations, visit the docs on <PlatformLink to="/configuration/integrations/#modifying-default-integrations">Modifying Default Integrations</PlatformLink>.

## Prisma Version >=6

To use the integration with Prisma version >=6, add the `prismaIntegration` to your Sentry initialization as follows:
To use the integration with Prisma version >=6, no configuration is required - tracing in Prisma v6 is enabled by default.

```javascript {3}
Sentry.init({
Expand All @@ -62,30 +62,15 @@ generator client {
}
```

For Prisma version 5 compatibility you must pass a specific version of the Prisma instrumentation to the Sentry Prisma integration. Add the `prismaIntegration` to your Sentry initialization as follows:

```javascript {1,6-9}
import { PrismaInstrumentation } from "@prisma/instrumentation";
Then, the `prismaIntegration` will automatically capture spans for Prisma queries.

```javascript {3}
Sentry.init({
tracesSampleRate: 1.0,
integrations: [
Sentry.prismaIntegration({
// Override the default instrumentation that Sentry uses
prismaInstrumentation: new PrismaInstrumentation(),
}),
],
integrations: [Sentry.prismaIntegration()],
});
```

## Options

### `prismaInstrumentation`

_Type: `Instrumentation`_ (An OpenTelemetry type)

Overrides the instrumentation used by the Sentry SDK with the passed in instrumentation instance.

## Supported Versions

- `prisma`: `>=5`
Loading