Skip to content

fix(node): Ensure prisma integration creates valid DB spans #11908

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 2 commits into from
May 6, 2024
Merged

fix(node): Ensure prisma integration creates valid DB spans #11908

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5c9d815
fix(node): Ensure prisma integration creates valid DB spans
mydea May 6, 2024
ddee52f
fix test
mydea May 6, 2024
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
7 changes: 3 additions & 4 deletions dev-packages/node-integration-tests/suites/tracing/prisma-orm/scenario.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
const { randomBytes } = require('crypto');
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
const { PrismaClient } = require('@prisma/client');
const Sentry = require('@sentry/node');
const { loggingTransport } = require('@sentry-internal/node-integration-tests');

Expand All @@ -12,6 +9,9 @@ Sentry.init({
integrations: [Sentry.prismaIntegration()],
});

const { randomBytes } = require('crypto');
const { PrismaClient } = require('@prisma/client');

// Stop the process from exiting before the transaction is sent
setInterval(() => {}, 1000);

Expand Down Expand Up @@ -49,5 +49,4 @@ async function run() {
);
}

// eslint-disable-next-line @typescript-eslint/no-floating-promises
run();
72 changes: 38 additions & 34 deletions dev-packages/node-integration-tests/suites/tracing/prisma-orm/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,100 +7,104 @@ conditionalTest({ min: 16 })('Prisma ORM Tests', () => {
transaction: 'Test Transaction',
spans: expect.arrayContaining([
expect.objectContaining({
data: expect.objectContaining({
data: {
method: 'create',
model: 'User',
name: 'User.create',
'otel.kind': 'INTERNAL',
'sentry.origin': 'manual',
}),
'sentry.origin': 'auto.db.otel.prisma',
},
description: 'prisma:client:operation',
status: 'ok',
}),
expect.objectContaining({
data: expect.objectContaining({
data: {
'otel.kind': 'INTERNAL',
'sentry.origin': 'manual',
}),
'sentry.origin': 'auto.db.otel.prisma',
},
description: 'prisma:client:serialize',
status: 'ok',
}),
expect.objectContaining({
data: expect.objectContaining({
data: {
'otel.kind': 'INTERNAL',
'sentry.origin': 'manual',
}),
'sentry.origin': 'auto.db.otel.prisma',
},
description: 'prisma:client:connect',
status: 'ok',
}),
expect.objectContaining({
data: expect.objectContaining({
data: {
'otel.kind': 'INTERNAL',
'sentry.origin': 'manual',
}),
'sentry.origin': 'auto.db.otel.prisma',
},
description: 'prisma:engine',
status: 'ok',
}),
expect.objectContaining({
data: expect.objectContaining({
data: {
'db.type': 'postgres',
'otel.kind': 'INTERNAL',
'sentry.origin': 'manual',
}),
'sentry.origin': 'auto.db.otel.prisma',
},
description: 'prisma:engine:connection',
status: 'ok',
}),
expect.objectContaining({
data: expect.objectContaining({
data: {
'db.statement': expect.stringContaining(
'INSERT INTO "public"."User" ("createdAt","email","name") VALUES ($1,$2,$3) RETURNING "public"."User"."id", "public"."User"."createdAt", "public"."User"."email", "public"."User"."name" /* traceparent',
),
'otel.kind': 'INTERNAL',
'sentry.origin': 'manual',
}),
description: 'prisma:engine:db_query',
'sentry.origin': 'auto.db.otel.prisma',
'db.system': 'prisma',
'sentry.op': 'db',
},
description: expect.stringContaining(
'INSERT INTO "public"."User" ("createdAt","email","name") VALUES ($1,$2,$3) RETURNING "public"."User"."id", "public"."User"."createdAt", "public"."User"."email", "public"."User"."name" /* traceparent',
),
status: 'ok',
}),
expect.objectContaining({
data: expect.objectContaining({
data: {
'otel.kind': 'INTERNAL',
'sentry.origin': 'manual',
}),
'sentry.origin': 'auto.db.otel.prisma',
},
description: 'prisma:engine:serialize',
status: 'ok',
}),
expect.objectContaining({
data: expect.objectContaining({
data: {
'otel.kind': 'INTERNAL',
'sentry.origin': 'manual',
}),
'sentry.origin': 'auto.db.otel.prisma',
},
description: 'prisma:engine:response_json_serialization',
status: 'ok',
}),
expect.objectContaining({
data: expect.objectContaining({
data: {
method: 'findMany',
model: 'User',
name: 'User.findMany',
'otel.kind': 'INTERNAL',
'sentry.origin': 'manual',
}),
'sentry.origin': 'auto.db.otel.prisma',
},
description: 'prisma:client:operation',
status: 'ok',
}),
expect.objectContaining({
data: expect.objectContaining({
data: {
'otel.kind': 'INTERNAL',
'sentry.origin': 'manual',
}),
'sentry.origin': 'auto.db.otel.prisma',
},
description: 'prisma:client:serialize',
status: 'ok',
}),
expect.objectContaining({
data: expect.objectContaining({
data: {
'otel.kind': 'INTERNAL',
'sentry.origin': 'manual',
}),
'sentry.origin': 'auto.db.otel.prisma',
},
description: 'prisma:engine',
status: 'ok',
}),
Expand Down
15 changes: 14 additions & 1 deletion packages/node/src/integrations/tracing/prisma.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// When importing CJS modules into an ESM module, we cannot import the named exports directly.
import * as prismaInstrumentation from '@prisma/instrumentation';
import { defineIntegration } from '@sentry/core';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
import { addOpenTelemetryInstrumentation } from '@sentry/opentelemetry';
import type { IntegrationFn } from '@sentry/types';

Expand All @@ -13,6 +13,19 @@ const _prismaIntegration = (() => {
new prismaInstrumentation.PrismaInstrumentation({}),
);
},

setup(client) {
client.on('spanStart', span => {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sadly we have no hook in the integration for this, but I think this is OK - as this integration is opt-in anyhow (as of now, at least), there is no overhead if not using this.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Possible improvement for this: We could PR this upstream to have a proper hook for this...

const spanJSON = spanToJSON(span);
if (spanJSON.description?.startsWith('prisma:')) {
span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.prisma');
}

if (spanJSON.description === 'prisma:engine:db_query') {
span.setAttribute('db.system', 'prisma');
}
});
},
};
}) satisfies IntegrationFn;

Expand Down