Add Support for Prisma ORM

[JonathanCallewaert]

Package + Version

• [ x ] @sentry/integrations - ^5.27.3
• [ x ] @sentry/node - ^5.27.3
• [ x ] @sentry/tracing - ^5.29.2

Description

I want to use the Postgres Tracing Integrations mentioned in these docs: https://docs.sentry.io/platforms/node/performance/database/
But for some reason, it does not work.
I'm using Prisma to do my Postgres queries: https://github.com/prisma/prisma
Underlying, Prisma is using the pg client package: https://github.com/prisma/prisma/blob/master/src/packages/client/src/utils/setupPostgres.ts

My code looks like this:

 Sentry.init({
 dsn: '***',
 environment: env,
 integrations: [
 new ExtraErrorData({ depth: 20 }),
 app && new Sentry.Integrations.Http({ tracing: true }),
 app && new Tracing.Integrations.Express({ app }),
 // Only works with pg client. Wait on support for Prisma
 app && new Tracing.Integrations.Postgres(),
 ].filter(Boolean),
 tracesSampleRate: 1.0,
 normalizeDepth: 21,
 });

[jonahsnider]

That function is only used in test scripts internally. Regular Prisma users have the Prisma engines connect to the database. The Node.js app never connects directly to the database.

[Jolg42]

@pizzafox is correct here.

[kamilogorek]

Thanks for the info. I allowed myself to change the title of this issue then.

[viperfx]

Hope this gets more attention. How are people working around this? Has anyone managed to configure it for better stack traces?

[stnwk]

I took a look at how this is implemented for the pg integration: https://github.com/getsentry/sentry-javascript/blob/master/packages/tracing/src/integrations/postgres.ts and applied prisma's middleware concept to it: https://www.prisma.io/docs/concepts/components/prisma-client/middleware

Here's what worked for me:

 import { PrismaClient } from "@prisma/client";
 import { getCurrentHub, Severity } from "@sentry/nextjs"; // whatever package you're using

 prisma.$use(async (params, next) => {
 const { model, action, runInTransaction, args } = params;
 const description = [model, action].filter(Boolean).join(".");
 const data = {
 model,
 action,
 runInTransaction,
 args,
 };

 const scope = getCurrentHub().getScope();
 const parentSpan = scope?.getSpan();
 const span = parentSpan?.startChild({
 op: "db",
 description,
 data,
 });

 // optional but nice
 scope?.addBreadcrumb({
 category: "db",
 message: description,
 data,
 });

 const result = await next(params);
 span?.finish();

 return result;
 });

[github-actions]

This issue has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you label it Status: Backlog or Status: In Progress, I will leave it alone ... forever!

---

"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀