Add Support for Sentry Tracing

Problem

Sentry.io has a new feature called “Tracing” which is essentially an APM. They have a postgres integration, however this does not work with Prisma

Suggested solution

Either make a PR to fix the postgres integration to support prisma or create a separate prisma integration

Alternatives

N/A

Additional context

See: https://github.com/getsentry/sentry-javascript/issues/3143

[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;
  });

Maybe a good starting point?

[stnwk]

Thanks for sharing the awesome script. On a side node, it was smart of you to post the script on the related Github issue for Sentry’s javascript package.

You’re welcome & thanks 😃

Have you seen any performance issues when tracking every query via middleware?

So far, the impact has been nothing to worry about for us