Add Support for Drizzle ORM

[smeubank]

Problem Statement

Add an integration to support Drizzle ORM

Solution Brainstorm

creates a db.prisma span for each query and reports to Sentry with relevant details inside description if available.

Similar to what was delivered to Prisma ORM

https://npmtrends.com/drizzle-orm-vs-prisma

[arthurfiorette]

Any updates??

[AbhiPrasad]

Hey @arthurfiorette, thanks for your interest! We rely on the community upvoting issues to determine priority, so this is still in our backlog for now, but if more interest is given we will bump the priority.

[nikolovlazar]

I'm manually instrumenting my Drizzle ORM queries like so:

// Define drizzle query, but don't invoke .get() right away
const updateQuery = db
  .update(likes)
  .set({ likes: (entry.likes ?? 0) + 1 })
  .where(eq(likes.slug, slug))
  .returning();

const updated = Sentry.startSpan(
  {
    // the span operation must be a valid one
    op: "db.query", 

    // invoke the .toSQL().sql on the query to get the raw SQL string and set it as the span name
    name: updateQuery.toSQL().sql,

    // also make sure to add the db.system data property!
    data: { "db.system": "sqlite" },

    // these properties are important if you want to utilize Queries Performance
    // read more: https://docs.sentry.io/product/performance/queries/#span-eligibility
  },
  () => updateQuery.get(), // invoke the .get()
);

Queries Performance works as expected:

[smeubank]

@mydea Do we get any added value in support for Drizzle with v8 and OTel?

drizzle-team/drizzle-orm#371

cc @jas-kas

[mydea]

It seems from that issue that drizzle should be supported via the existing otel auto instrumentation (pg/mysql)?

[jamesbvaughan]

I've added my upvote here and wanted to share a more up-to-date screenshot of the npm trends comparison. In the year since this discussion started, the trend has begun to make a more compelling case for this.

[mydea]

You could give 8.0.0-beta.4 a try, there we auto-instrument pg which according to drizzle-team/drizzle-orm#371 should also instrument drizzle!

[AbhiPrasad]

Hey folks! If you upgrade to 8.0 of the Node.js SDK (or Remix/Next.js/SvelteKit etc.) you should get spans for postgres from OTEL automatically!

https://docs.sentry.io/platforms/javascript/guides/node/migration/v7-to-v8/

https://docs.sentry.io/platforms/javascript/guides/node/

[pry0rity]

bumping this - a dedicated drizzle-orm instrumentation would be amazing. It's rapidly gaining popularity

[AbhiPrasad]

@pry0rity we should always be instrumenting the underlying database that drizzle-orm is using, which should mean we get database instrumentation.

Is there something particular you're looking for?