fix(node): Update integration to identify knex spans

Differentiate knex spans from other database spans.

Signed-off-by: Kaung Zin Hein <[email protected]>

Author: Zen-cronic

dev-packages/node-integration-tests/suites/tracing/knex/scenario.js

@@ -13,6 +13,17 @@ setInterval(() => {}, 1000);
 
 const knex = require('knex').default;
 
+const pgClient = knex({
+  client: 'pg',
+  connection: {
+    host: 'localhost',
+    port: 5445,
+    user: 'test',
+    password: 'test',
+    database: 'tests',
+  },
+});
+
 async function run() {
   await Sentry.startSpan(
     {
@@ -21,39 +32,17 @@ async function run() {
     },
     async () => {
       try {
-        const pgKnex = knex({
-          client: 'pg',
-          connection: {
-            host: 'localhost',
-            port: 5445,
-            user: 'test',
-            password: 'test',
-            database: 'tests',
-          },
-        });
-
-        await pgKnex.schema.createTable('User', table => {
+        await pgClient.schema.createTable('User', table => {
           table.increments('id').notNullable().primary({ constraintName: 'User_pkey' });
-          table.timestamp('createdAt', { precision: 3 }).notNullable().defaultTo(pgKnex.fn.now(3));
+          table.timestamp('createdAt', { precision: 3 }).notNullable().defaultTo(pgClient.fn.now(3));
           table.text('email').notNullable();
           table.text('name').notNullable();
         });
 
-        await pgKnex('User').insert({ name: 'bob', email: '[email protected]' });
-        await pgKnex('User').select('*');
-        // await client
-        //   .query(
-        //     'CREATE TABLE "User" ("id" SERIAL NOT NULL,"createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,"email" TEXT NOT NULL,"name" TEXT,CONSTRAINT "User_pkey" PRIMARY KEY ("id"));',
-        //   )
-        //   .catch(() => {
-        //     // if this is not a fresh database, the table might already exist
-        //   });
-
-        // await client.query('');
-        // await client.query('INSERT INTO "User" ("email", "name") VALUES ($1, $2)', ['tim', '[email protected]']);
-        // await client.query('SELECT * FROM "User"');
+        await pgClient('User').insert({ name: 'bob', email: '[email protected]' });
+        await pgClient('User').select('*');
       } finally {
-        // await client.end();
+        await pgClient.destroy();
       }
     },
   );

dev-packages/node-integration-tests/suites/tracing/knex/test.ts

@@ -7,19 +7,6 @@ describe('knex auto instrumentation', () => {
     const EXPECTED_TRANSACTION = {
       transaction: 'Test Transaction',
       spans: expect.arrayContaining([
-        expect.objectContaining({
-          data: expect.objectContaining({
-            'db.system': 'knex',
-            'db.name': 'tests',
-            'sentry.origin': 'auto.db.otel.knex',
-            'sentry.op': 'db',
-            'net.peer.name': 'localhost',
-            'net.peer.port': 5445,
-          }),
-          status: 'ok',
-          description: 'pg.connect',
-          origin: 'auto.db.otel.knex',
-        }),
         expect.objectContaining({
           data: expect.objectContaining({
             'db.system': 'knex',

packages/node/src/integrations/tracing/knex.ts

@@ -1,11 +1,14 @@
 import { KnexInstrumentation } from '@opentelemetry/instrumentation-knex';
-import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration } from '@sentry/core';
+import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
 import type { IntegrationFn } from '@sentry/types';
 import { generateInstrumentOnce } from '../../otel/instrument';
 
 const INTEGRATION_NAME = 'Knex';
 
-export const instrumentKnex = generateInstrumentOnce(INTEGRATION_NAME, () => new KnexInstrumentation({}));
+export const instrumentKnex = generateInstrumentOnce(
+  INTEGRATION_NAME,
+  () => new KnexInstrumentation({ requireParentSpan: true }),
+);
 
 const _knexIntegration = (() => {
   return {
@@ -16,8 +19,13 @@ const _knexIntegration = (() => {
 
     setup(client) {
       client.on('spanStart', span => {
-        span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.knex');
-        span.setAttribute('db.system', 'knex');
+        const spanJSON = spanToJSON(span);
+        const spanData = spanJSON.data;
+
+        if (spanData && 'knex.version' in spanData) {
+          span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.knex');
+          span.setAttribute('db.system', 'knex');
+        }
       });
     },
   };