feat(node): Add tedious integration

dev-packages/node-integration-tests/package.json

@@ -60,6 +60,7 @@
  "redis-4": "npm:redis@^4.6.14",
  "reflect-metadata": "0.2.1",
  "rxjs": "^7.8.1",
+ "tedious": "^18.6.1",
  "yargs": "^16.2.0"
  },
  "devDependencies": {

dev-packages/node-integration-tests/suites/tracing/tedious/docker-compose.yml

@@ -0,0 +1,12 @@
+version: '3.9'
+
+services:
+ db:
+ image: mcr.microsoft.com/mssql/server:2022-latest
+ restart: always
+ container_name: integration-tests-tedious
+ ports:
+ - '1433:1433'
+ environment:
+ ACCEPT_EULA: 'Y'
+ MSSQL_SA_PASSWORD: 'TESTing123'

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

@@ -0,0 +1,65 @@
+const { loggingTransport } = require('@sentry-internal/node-integration-tests');
+const Sentry = require('@sentry/node');
+
+Sentry.init({
+ dsn: 'https://public@dsn.ingest.sentry.io/1337',
+ release: '1.0',
+ tracesSampleRate: 1.0,
+ transport: loggingTransport,
+});
+
+const { Connection, Request } = require('tedious');
+
+const config = {
+ server: '127.0.0.1',
+ authentication: {
+ type: 'default',
+ options: {
+ userName: 'sa',
+ password: 'TESTing123',
+ },
+ },
+ options: {
+ port: 1433,
+ encrypt: false,
+ },
+};
+
+const connection = new Connection(config);
+
+function executeAllStatements(span) {
+ executeStatement('SELECT 1 + 1 AS solution', () => {
+ executeStatement('SELECT GETDATE()', () => {
+ span.end();
+ connection.close();
+ });
+ });
+}
+
+function executeStatement(query, callback) {
+ const request = new Request(query, err => {
+ if (err) {
+ throw err;
+ }
+ callback();
+ });
+
+ connection.execSql(request);
+}
+
+connection.connect(err => {
+ if (err) {
+ throw err;
+ }
+
+ Sentry.startSpanManual(
+ {
+ op: 'transaction',
+ name: 'Test Transaction',
+ },
+ span => {
+ // span must be ended manually after all queries
+ executeAllStatements(span);
+ },
+ );
+});

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

@@ -0,0 +1,50 @@
+import { cleanupChildProcesses, createRunner } from '../../../utils/runner';
+
+jest.setTimeout(75000);
+
+describe('tedious auto instrumentation', () => {
+ afterAll(() => {
+ cleanupChildProcesses();
+ });
+
+ test('should auto-instrument `tedious` package', done => {
+ const EXPECTED_TRANSACTION = {
+ transaction: 'Test Transaction',
+ spans: expect.arrayContaining([
+ expect.objectContaining({
+ description: 'SELECT GETDATE()',
+ data: expect.objectContaining({
+ 'sentry.origin': 'auto.db.otel.tedious',
+ 'sentry.op': 'db',
+ 'db.name': 'master',
+ 'db.statement': 'SELECT GETDATE()',
+ 'db.system': 'mssql',
+ 'db.user': 'sa',
+ 'net.peer.name': '127.0.0.1',
+ 'net.peer.port': 1433,
+ }),
+ status: 'ok',
+ }),
+ expect.objectContaining({
+ description: 'SELECT 1 + 1 AS solution',
+ data: expect.objectContaining({
+ 'sentry.origin': 'auto.db.otel.tedious',
+ 'sentry.op': 'db',
+ 'db.name': 'master',
+ 'db.statement': 'SELECT 1 + 1 AS solution',
+ 'db.system': 'mssql',
+ 'db.user': 'sa',
+ 'net.peer.name': '127.0.0.1',
+ 'net.peer.port': 1433,
+ }),
+ status: 'ok',
+ }),
+ ]),
+ };
+
+ createRunner(__dirname, 'scenario.js')
+ .withDockerCompose({ workingDirectory: [__dirname], readyMatches: ['1433'] })
+ .expect({ transaction: EXPECTED_TRANSACTION })
+ .start(done);
+ });
+});

packages/astro/src/index.server.ts

@@ -117,6 +117,7 @@ export {
  startSession,
  startSpan,
  startSpanManual,
+ tediousIntegration,
  trpcMiddleware,
  withActiveSpan,
  withIsolationScope,

packages/aws-serverless/src/index.ts

@@ -93,6 +93,7 @@ export {
  mysqlIntegration,
  mysql2Integration,
  redisIntegration,
+ tediousIntegration,
  nestIntegration,
  setupNestErrorHandler,
  postgresIntegration,

packages/bun/src/index.ts

@@ -114,6 +114,7 @@ export {
  mysqlIntegration,
  mysql2Integration,
  redisIntegration,
+ tediousIntegration,
  nestIntegration,
  setupNestErrorHandler,
  postgresIntegration,

packages/google-cloud-serverless/src/index.ts

@@ -93,6 +93,7 @@ export {
  mysqlIntegration,
  mysql2Integration,
  redisIntegration,
+ tediousIntegration,
  nestIntegration,
  setupNestErrorHandler,
  postgresIntegration,

packages/node/package.json

@@ -85,6 +85,7 @@
  "@opentelemetry/instrumentation-nestjs-core": "0.39.0",
  "@opentelemetry/instrumentation-pg": "0.43.0",
  "@opentelemetry/instrumentation-redis-4": "0.41.0",
+ "@opentelemetry/instrumentation-tedious": "0.13.0",
  "@opentelemetry/resources": "^1.25.1",
  "@opentelemetry/sdk-trace-base": "^1.25.1",
  "@opentelemetry/semantic-conventions": "^1.25.1",

packages/node/src/index.ts

@@ -26,6 +26,7 @@ export { hapiIntegration, setupHapiErrorHandler } from './integrations/tracing/h
 export { koaIntegration, setupKoaErrorHandler } from './integrations/tracing/koa';
 export { connectIntegration, setupConnectErrorHandler } from './integrations/tracing/connect';
 export { spotlightIntegration } from './integrations/spotlight';
+export { tediousIntegration } from './integrations/tracing/tedious';
 
 export { SentryContextManager } from './otel/contextManager';
 export { generateInstrumentOnce } from './otel/instrument';

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

@@ -14,6 +14,7 @@ import { instrumentMysql2, mysql2Integration } from './mysql2';
 import { instrumentNest, nestIntegration } from './nest/nest';
 import { instrumentPostgres, postgresIntegration } from './postgres';
 import { instrumentRedis, redisIntegration } from './redis';
+import { instrumentTedious, tediousIntegration } from './tedious';
 
 /**
  * With OTEL, all performance integrations will be added, as OTEL only initializes them when the patched package is actually required.
@@ -37,6 +38,7 @@ export function getAutoPerformanceIntegrations(): Integration[] {
  hapiIntegration(),
  koaIntegration(),
  connectIntegration(),
+ tediousIntegration(),
  ];
 }
 
@@ -61,5 +63,6 @@ export function getOpenTelemetryInstrumentationToPreload(): (((options?: any) =>
  instrumentHapi,
  instrumentGraphql,
  instrumentRedis,
+ instrumentTedious,
  ];
 }

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

@@ -0,0 +1,38 @@
+import { TediousInstrumentation } from '@opentelemetry/instrumentation-tedious';
+import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
+import type { IntegrationFn } from '@sentry/types';
+import { generateInstrumentOnce } from '../../otel/instrument';
+
+const INTEGRATION_NAME = 'Tedious';
+
+export const instrumentTedious = generateInstrumentOnce(INTEGRATION_NAME, () => new TediousInstrumentation({}));
+
+const _tediousIntegration = (() => {
+ return {
+ name: INTEGRATION_NAME,
+ setupOnce() {
+ instrumentTedious();
+ },
+
+ setup(client) {
+ client.on('spanStart', span => {
+ const spanJSON = spanToJSON(span);
+
+ const spanMethods = ['callProcedure', 'execSql', 'execSqlBatch', 'execBulkLoad', 'prepare', 'execute'];
+
+ const spanDescription = spanJSON?.description;
+
+ if (spanMethods.some(method => spanDescription?.startsWith(method))) {
+ span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.tedious');
+ }
+ });
+ },
+ };
+}) satisfies IntegrationFn;
+
+/**
+ * Tedious integration
+ *
+ * Capture tracing data for tedious.
+ */
+export const tediousIntegration = defineIntegration(_tediousIntegration);

packages/remix/src/index.server.ts

@@ -119,6 +119,7 @@ export {
  startSession,
  startSpan,
  startSpanManual,
+ tediousIntegration,
  trpcMiddleware,
  withActiveSpan,
  withIsolationScope,

packages/solidstart/src/server/index.ts

@@ -110,6 +110,7 @@ export {
  startSession,
  startSpan,
  startSpanManual,
+ tediousIntegration,
  trpcMiddleware,
  withActiveSpan,
  withIsolationScope,

packages/sveltekit/src/server/index.ts

@@ -112,6 +112,7 @@ export {
  startSession,
  startSpan,
  startSpanManual,
+ tediousIntegration,
  trpcMiddleware,
  withActiveSpan,
  withIsolationScope,