Skip to content

prisma.mdx

Latest commit

 

History

History
91 lines (69 loc) · 2.57 KB

prisma.mdx

File metadata and controls

91 lines (69 loc) · 2.57 KB
title Prisma
description Adds instrumentation for Prisma.
supported
javascript.node
javascript.aws-lambda
javascript.azure-functions
javascript.connect
javascript.express
javascript.fastify
javascript.gcp-functions
javascript.hapi
javascript.hono
javascript.koa
javascript.nestjs
javascript.nextjs
javascript.nuxt
javascript.solidstart
javascript.sveltekit
javascript.remix
javascript.react-router
javascript.astro
javascript.bun
javascript.tanstackstart-react

This integration only works in the Node.js and Bun runtimes.

Import name: Sentry.prismaIntegration

Sentry supports tracing Prisma ORM queries with the Prisma integration.

The Prisma Integrations creates a spans for each query and reports to Sentry with relevant details inside thedescription 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. If you'd like to learn how to modify your default integrations, visit the docs on Modifying Default Integrations.

Prisma Version >=6

To use the integration with Prisma version >=6, add the prismaIntegration to your Sentry initialization as follows:

Sentry.init({
  tracesSampleRate: 1.0,
  integrations: [Sentry.prismaIntegration()],
});

Prisma Version 5

To configure the integration for Prisma version 5, first add the tracing feature flag to the generator block of your Prisma schema:

generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["tracing"]
}

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:

import { PrismaInstrumentation } from "@prisma/instrumentation";

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

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