feat(tracing): Add db.system span data to DB spans (#7952)

AbhiPrasad · mydea · web-flow · commit c0e55048d680 · 2023-04-25T13:12:45.000Z
Co-authored-by: Francesco Novy &lt;francesco.novy@sentry.io&gt;
diff --git a/packages/node-integration-tests/suites/tracing-new/auto-instrument/mongodb/test.ts b/packages/node-integration-tests/suites/tracing-new/auto-instrument/mongodb/test.ts
@@ -34,6 +34,7 @@ conditionalTest({ min: 12 })('MongoDB Test', () => {
             dbName: 'admin',
             namespace: 'admin.movies',
             doc: '{"title":"Rick and Morty"}',
+            'db.system': 'mongodb',
           },
           description: 'insertOne',
           op: 'db',
@@ -44,6 +45,7 @@ conditionalTest({ min: 12 })('MongoDB Test', () => {
             dbName: 'admin',
             namespace: 'admin.movies',
             query: '{"title":"Back to the Future"}',
+            'db.system': 'mongodb',
           },
           description: 'findOne',
           op: 'db',
@@ -55,6 +57,7 @@ conditionalTest({ min: 12 })('MongoDB Test', () => {
             namespace: 'admin.movies',
             filter: '{"title":"Back to the Future"}',
             update: '{"$set":{"title":"South Park"}}',
+            'db.system': 'mongodb',
           },
           description: 'updateOne',
           op: 'db',
@@ -65,6 +68,7 @@ conditionalTest({ min: 12 })('MongoDB Test', () => {
             dbName: 'admin',
             namespace: 'admin.movies',
             query: '{"title":"South Park"}',
+            'db.system': 'mongodb',
           },
           description: 'findOne',
           op: 'db',
@@ -75,6 +79,7 @@ conditionalTest({ min: 12 })('MongoDB Test', () => {
             dbName: 'admin',
             namespace: 'admin.movies',
             query: '{"title":"South Park"}',
+            'db.system': 'mongodb',
           },
           description: 'find',
           op: 'db',
diff --git a/packages/node-integration-tests/suites/tracing-new/auto-instrument/mysql/test.ts b/packages/node-integration-tests/suites/tracing-new/auto-instrument/mysql/test.ts
@@ -12,11 +12,17 @@ test('should auto-instrument `mysql` package.', async () => {
       {
         description: 'SELECT 1 + 1 AS solution',
         op: 'db',
+        data: {
+          'db.system': 'mysql',
+        },
       },
 
       {
         description: 'SELECT NOW()',
         op: 'db',
+        data: {
+          'db.system': 'mysql',
+        },
       },
     ],
   });
diff --git a/packages/node-integration-tests/suites/tracing-new/auto-instrument/pg/test.ts b/packages/node-integration-tests/suites/tracing-new/auto-instrument/pg/test.ts
@@ -40,14 +40,23 @@ test('should auto-instrument `pg` package.', async () => {
       {
         description: 'SELECT * FROM foo where bar ilike "baz%"',
         op: 'db',
+        data: {
+          'db.system': 'postgresql',
+        },
       },
       {
         description: 'SELECT * FROM bazz',
         op: 'db',
+        data: {
+          'db.system': 'postgresql',
+        },
       },
       {
         description: 'SELECT NOW()',
         op: 'db',
+        data: {
+          'db.system': 'postgresql',
+        },
       },
     ],
   });
diff --git a/packages/node-integration-tests/suites/tracing-new/prisma-orm/test.ts b/packages/node-integration-tests/suites/tracing-new/prisma-orm/test.ts
@@ -8,9 +8,9 @@ conditionalTest({ min: 12 })('Prisma ORM Integration', () => {
     assertSentryTransaction(envelope[2], {
       transaction: 'Test Transaction',
       spans: [
-        { description: 'User create', op: 'db.sql.prisma' },
-        { description: 'User findMany', op: 'db.sql.prisma' },
-        { description: 'User deleteMany', op: 'db.sql.prisma' },
+        { description: 'User create', op: 'db.sql.prisma', data: { 'db.system': 'prisma' } },
+        { description: 'User findMany', op: 'db.sql.prisma', data: { 'db.system': 'prisma' } },
+        { description: 'User deleteMany', op: 'db.sql.prisma', data: { 'db.system': 'prisma' } },
       ],
     });
   });
diff --git a/packages/node-integration-tests/suites/tracing/auto-instrument/mongodb/test.ts b/packages/node-integration-tests/suites/tracing/auto-instrument/mongodb/test.ts
@@ -34,6 +34,7 @@ conditionalTest({ min: 12 })('MongoDB Test', () => {
             dbName: 'admin',
             namespace: 'admin.movies',
             doc: '{"title":"Rick and Morty"}',
+            'db.system': 'mongodb',
           },
           description: 'insertOne',
           op: 'db',
@@ -44,6 +45,7 @@ conditionalTest({ min: 12 })('MongoDB Test', () => {
             dbName: 'admin',
             namespace: 'admin.movies',
             query: '{"title":"Back to the Future"}',
+            'db.system': 'mongodb',
           },
           description: 'findOne',
           op: 'db',
@@ -55,6 +57,7 @@ conditionalTest({ min: 12 })('MongoDB Test', () => {
             namespace: 'admin.movies',
             filter: '{"title":"Back to the Future"}',
             update: '{"$set":{"title":"South Park"}}',
+            'db.system': 'mongodb',
           },
           description: 'updateOne',
           op: 'db',
@@ -65,6 +68,7 @@ conditionalTest({ min: 12 })('MongoDB Test', () => {
             dbName: 'admin',
             namespace: 'admin.movies',
             query: '{"title":"South Park"}',
+            'db.system': 'mongodb',
           },
           description: 'findOne',
           op: 'db',
@@ -75,6 +79,7 @@ conditionalTest({ min: 12 })('MongoDB Test', () => {
             dbName: 'admin',
             namespace: 'admin.movies',
             query: '{"title":"South Park"}',
+            'db.system': 'mongodb',
           },
           description: 'find',
           op: 'db',
diff --git a/packages/node-integration-tests/suites/tracing/auto-instrument/mysql/test.ts b/packages/node-integration-tests/suites/tracing/auto-instrument/mysql/test.ts
@@ -12,11 +12,17 @@ test('should auto-instrument `mysql` package.', async () => {
       {
         description: 'SELECT 1 + 1 AS solution',
         op: 'db',
+        data: {
+          'db.system': 'mysql',
+        },
       },
 
       {
         description: 'SELECT NOW()',
         op: 'db',
+        data: {
+          'db.system': 'mysql',
+        },
       },
     ],
   });
diff --git a/packages/node-integration-tests/suites/tracing/auto-instrument/pg/test.ts b/packages/node-integration-tests/suites/tracing/auto-instrument/pg/test.ts
@@ -40,14 +40,23 @@ test('should auto-instrument `pg` package.', async () => {
       {
         description: 'SELECT * FROM foo where bar ilike "baz%"',
         op: 'db',
+        data: {
+          'db.system': 'postgresql',
+        },
       },
       {
         description: 'SELECT * FROM bazz',
         op: 'db',
+        data: {
+          'db.system': 'postgresql',
+        },
       },
       {
         description: 'SELECT NOW()',
         op: 'db',
+        data: {
+          'db.system': 'postgresql',
+        },
       },
     ],
   });
diff --git a/packages/node-integration-tests/suites/tracing/prisma-orm/test.ts b/packages/node-integration-tests/suites/tracing/prisma-orm/test.ts
@@ -8,9 +8,9 @@ conditionalTest({ min: 12 })('Prisma ORM Integration', () => {
     assertSentryTransaction(envelope[2], {
       transaction: 'Test Transaction',
       spans: [
-        { description: 'User create', op: 'db.sql.prisma' },
-        { description: 'User findMany', op: 'db.sql.prisma' },
-        { description: 'User deleteMany', op: 'db.sql.prisma' },
+        { description: 'User create', op: 'db.sql.prisma', data: { 'db.system': 'prisma' } },
+        { description: 'User findMany', op: 'db.sql.prisma', data: { 'db.system': 'prisma' } },
+        { description: 'User deleteMany', op: 'db.sql.prisma', data: { 'db.system': 'prisma' } },
       ],
     });
   });
diff --git a/packages/tracing-internal/src/extensions.ts b/packages/tracing-internal/src/extensions.ts
@@ -22,7 +22,7 @@ function _autoloadDatabaseIntegrations(): void {
       const integration = dynamicRequire(module, './node/integrations/mongo') as {
         Mongo: IntegrationClass<Integration>;
       };
-      return new integration.Mongo({ mongoose: true });
+      return new integration.Mongo();
     },
     mysql() {
       const integration = dynamicRequire(module, './node/integrations/mysql') as {
diff --git a/packages/tracing-internal/src/node/integrations/mongo.ts b/packages/tracing-internal/src/node/integrations/mongo.ts
@@ -231,6 +231,7 @@ export class Mongo implements LazyLoadedIntegration<MongoModule> {
       collectionName: collection.collectionName,
       dbName: collection.dbName,
       namespace: collection.namespace,
+      'db.system': 'mongodb',
     };
     const spanContext: SpanContext = {
       op: 'db',
diff --git a/packages/tracing-internal/src/node/integrations/mysql.ts b/packages/tracing-internal/src/node/integrations/mysql.ts
@@ -55,6 +55,9 @@ export class Mysql implements LazyLoadedIntegration<MysqlConnection> {
         const span = parentSpan?.startChild({
           description: typeof options === 'string' ? options : (options as { sql: string }).sql,
           op: 'db',
+          data: {
+            'db.system': 'mysql',
+          },
         });
 
         if (typeof callback === 'function') {
diff --git a/packages/tracing-internal/src/node/integrations/postgres.ts b/packages/tracing-internal/src/node/integrations/postgres.ts
@@ -79,6 +79,9 @@ export class Postgres implements LazyLoadedIntegration<PGModule> {
         const span = parentSpan?.startChild({
           description: typeof config === 'string' ? config : (config as { text: string }).text,
           op: 'db',
+          data: {
+            'db.system': 'postgresql',
+          },
         });
 
         if (typeof callback === 'function') {
diff --git a/packages/tracing-internal/src/node/integrations/prisma.ts b/packages/tracing-internal/src/node/integrations/prisma.ts
@@ -91,7 +91,10 @@ export class Prisma implements Integration {
     this._client.$use((params, next: (params: PrismaMiddlewareParams) => Promise<unknown>) => {
       const action = params.action;
       const model = params.model;
-      return trace({ name: model ? `${model} ${action}` : action, op: 'db.sql.prisma' }, () => next(params));
+      return trace(
+        { name: model ? `${model} ${action}` : action, op: 'db.sql.prisma', data: { 'db.system': 'prisma' } },
+        () => next(params),
+      );
     });
   }
 }
diff --git a/packages/tracing/test/integrations/node/mongo.test.ts b/packages/tracing/test/integrations/node/mongo.test.ts
@@ -78,6 +78,7 @@ describe('patchOperation()', () => {
           dbName: 'mockedDbName',
           doc: JSON.stringify(doc),
           namespace: 'mockedNamespace',
+          'db.system': 'mongodb',
         },
         op: 'db',
         description: 'insertOne',
@@ -96,6 +97,7 @@ describe('patchOperation()', () => {
         dbName: 'mockedDbName',
         doc: JSON.stringify(doc),
         namespace: 'mockedNamespace',
+        'db.system': 'mongodb',
       },
       op: 'db',
       description: 'insertOne',
@@ -111,6 +113,7 @@ describe('patchOperation()', () => {
         collectionName: 'mockedCollectionName',
         dbName: 'mockedDbName',
         namespace: 'mockedNamespace',
+        'db.system': 'mongodb',
       },
       op: 'db',
       description: 'initializeOrderedBulkOp',
diff --git a/packages/tracing/test/integrations/node/postgres.test.ts b/packages/tracing/test/integrations/node/postgres.test.ts
@@ -72,6 +72,9 @@ describe('setupOnce', () => {
         expect(parentSpan.startChild).toBeCalledWith({
           description: 'SELECT NOW()',
           op: 'db',
+          data: {
+            'db.system': 'postgresql',
+          },
         });
         expect(childSpan.finish).toBeCalled();
         done();
@@ -84,6 +87,9 @@ describe('setupOnce', () => {
         expect(parentSpan.startChild).toBeCalledWith({
           description: 'SELECT NOW()',
           op: 'db',
+          data: {
+            'db.system': 'postgresql',
+          },
         });
         expect(childSpan.finish).toBeCalled();
         done();
@@ -96,6 +102,9 @@ describe('setupOnce', () => {
       expect(parentSpan.startChild).toBeCalledWith({
         description: 'SELECT NOW()',
         op: 'db',
+        data: {
+          'db.system': 'postgresql',
+        },
       });
       expect(childSpan.finish).toBeCalled();
     });
diff --git a/packages/tracing/test/integrations/node/prisma.test.ts b/packages/tracing/test/integrations/node/prisma.test.ts
@@ -54,7 +54,10 @@ describe('setupOnce', function () {
   it('should add middleware with $use method correctly', done => {
     void Client.user.create()?.then(() => {
       expect(mockTrace).toHaveBeenCalledTimes(1);
-      expect(mockTrace).toHaveBeenLastCalledWith({ name: 'user create', op: 'db.sql.prisma' }, expect.any(Function));
+      expect(mockTrace).toHaveBeenLastCalledWith(
+        { name: 'user create', op: 'db.sql.prisma', data: { 'db.system': 'prisma' } },
+        expect.any(Function),
+      );
       done();
     });
   });

Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,10 @@ export class Prisma implements Integration {`
`91`	`91`	`this._client.$use((params, next: (params: PrismaMiddlewareParams) => Promise<unknown>) => {`
`92`	`92`	`const action = params.action;`
`93`	`93`	`const model = params.model;`
`94`		- return trace({ name: model ? `${model} ${action}` : action, op: 'db.sql.prisma' }, () => next(params));
	`94`	`+ return trace(`
	`95`	+ { name: model ? `${model} ${action}` : action, op: 'db.sql.prisma', data: { 'db.system': 'prisma' } },
	`96`	`+ () => next(params),`
	`97`	`+ );`
`95`	`98`	`});`
`96`	`99`	`}`
`97`	`100`	`}`