feat(node): Add socket.io integration

Add otel integration and e2e tests.

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

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

@@ -62,6 +62,8 @@
     "redis-4": "npm:redis@^4.6.14",
     "reflect-metadata": "0.2.1",
     "rxjs": "^7.8.1",
+    "socket.io": "^4.7.5",
+    "socket.io-client": "^4.7.5",
     "yargs": "^16.2.0"
   },
   "devDependencies": {

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

@@ -0,0 +1,54 @@
+const { loggingTransport, sendPortToRunner } = require('@sentry-internal/node-integration-tests');
+const Sentry = require('@sentry/node');
+
+Sentry.init({
+  dsn: 'https://[email protected]/1337',
+  release: '1.0',
+  tracesSampleRate: 1.0,
+  transport: loggingTransport,
+});
+
+// Stop the process from exiting before the transaction is sent
+setInterval(() => {}, 1000);
+
+const http = require('http');
+const express = require('express');
+const cors = require('cors');
+const { Server } = require('socket.io');
+const ioc = require('socket.io-client');
+
+const PORT = 3005;
+
+const run = async () => {
+  const app = express();
+  app.use(cors());
+
+  const expressServer = http.createServer(app);
+
+  const io = new Server(expressServer);
+
+  app.get('/', (_req, res) => {
+    io.emit('test', 'TEST MESSAGE');
+    res.send('123');
+  });
+
+  expressServer.listen(PORT, () => {
+    io.on('connection', client => {
+      client.on('test_reply', _data => {
+        client.disconnect();
+        io.close();
+      });
+    });
+
+    const clientSocket = ioc(`http://localhost:${PORT}`);
+
+    clientSocket.on('test', _msg => {
+      clientSocket.emit('test_reply', { test_key: 'test_value' });
+    });
+  });
+
+  sendPortToRunner(PORT);
+};
+
+// eslint-disable-next-line @typescript-eslint/no-floating-promises
+run();

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

@@ -0,0 +1,59 @@
+import { cleanupChildProcesses, createRunner } from '../../../utils/runner';
+
+describe('socket.io auto instrumentation', () => {
+  afterAll(() => {
+    cleanupChildProcesses();
+  });
+
+  test('should auto-instrument `socket.io` package', done => {
+    const SERVER_TRANSACTION = {
+      transaction: 'GET /',
+      spans: expect.arrayContaining([
+        expect.objectContaining({
+          origin: 'auto.socket.otel.socket_io',
+          data: {
+            'sentry.origin': 'auto.socket.otel.socket_io',
+            'messaging.destination': '/',
+            'messaging.destination_kind': 'topic',
+            'messaging.socket.io.event_name': 'test',
+            'messaging.socket.io.namespace': '/',
+            'messaging.system': 'socket.io',
+            'otel.kind': 'PRODUCER',
+            'sentry.op': 'message',
+          },
+          description: '/ send',
+          op: 'message',
+          status: 'ok',
+        }),
+      ]),
+    };
+
+    const CLIENT_TRANSACTION = {
+      transaction: 'test_reply receive',
+      contexts: {
+        trace: expect.objectContaining({
+          span_id: expect.any(String),
+          trace_id: expect.any(String),
+          data: expect.objectContaining({
+            'sentry.op': 'message',
+            'sentry.origin': 'auto.socket.otel.socket_io',
+            'otel.kind': 'CONSUMER',
+            'messaging.system': 'socket.io',
+            'messaging.destination': '/',
+            'messaging.operation': 'receive',
+            'messaging.socket.io.event_name': 'test_reply',
+          }),
+          origin: 'auto.socket.otel.socket_io',
+          op: 'message',
+          status: 'ok',
+        }),
+      },
+    };
+
+    createRunner(__dirname, 'scenario.js')
+      .expect({ transaction: SERVER_TRANSACTION })
+      .expect({ transaction: CLIENT_TRANSACTION })
+      .start(done)
+      .makeRequest('get', '/');
+  });
+});

packages/astro/src/index.server.ts

@@ -110,6 +110,7 @@ export {
   setupKoaErrorHandler,
   setupNestErrorHandler,
   setUser,
+  socketIoIntegration,
   spanToBaggageHeader,
   spanToJSON,
   spanToTraceHeader,

packages/aws-serverless/src/index.ts

@@ -101,6 +101,7 @@ export {
   prismaIntegration,
   hapiIntegration,
   setupHapiErrorHandler,
+  socketIoIntegration,
   spotlightIntegration,
   initOpenTelemetry,
   spanToJSON,

packages/bun/src/index.ts

@@ -122,6 +122,7 @@ export {
   prismaIntegration,
   hapiIntegration,
   setupHapiErrorHandler,
+  socketIoIntegration,
   spotlightIntegration,
   initOpenTelemetry,
   spanToJSON,

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

@@ -101,6 +101,7 @@ export {
   prismaIntegration,
   hapiIntegration,
   setupHapiErrorHandler,
+  socketIoIntegration,
   spotlightIntegration,
   initOpenTelemetry,
   spanToJSON,

packages/node/package.json

@@ -87,6 +87,7 @@
     "@opentelemetry/instrumentation-nestjs-core": "0.40.0",
     "@opentelemetry/instrumentation-pg": "0.44.0",
     "@opentelemetry/instrumentation-redis-4": "0.42.0",
+    "@opentelemetry/instrumentation-socket.io": "0.42.0",
     "@opentelemetry/instrumentation-undici": "0.6.0",
     "@opentelemetry/resources": "^1.26.0",
     "@opentelemetry/sdk-trace-base": "^1.26.0",

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

@@ -16,6 +16,7 @@ import { instrumentMysql2, mysql2Integration } from './mysql2';
 import { instrumentNest, nestIntegration } from './nest/nest';
 import { instrumentPostgres, postgresIntegration } from './postgres';
 import { instrumentRedis, redisIntegration } from './redis';
+import { instrumentSocketIo, socketIoIntegration } from './socket.io';
 
 /**
  * With OTEL, all performance integrations will be added, as OTEL only initializes them when the patched package is actually required.
@@ -41,6 +42,7 @@ export function getAutoPerformanceIntegrations(): Integration[] {
     connectIntegration(),
     genericPoolIntegration(),
     kafkaIntegration(),
+    socketIoIntegration(),
   ];
 }
 
@@ -67,5 +69,6 @@ export function getOpenTelemetryInstrumentationToPreload(): (((options?: any) =>
     instrumentGraphql,
     instrumentRedis,
     instrumentGenericPool,
+    instrumentSocketIo,
   ];
 }

packages/node/src/integrations/tracing/socket.io.ts

@@ -0,0 +1,37 @@
+import { SocketIoInstrumentation } from '@opentelemetry/instrumentation-socket.io';
+import { defineIntegration } from '@sentry/core';
+import type { IntegrationFn } from '@sentry/types';
+import { generateInstrumentOnce } from '../../otel/instrument';
+import { addOriginToSpan } from '../../utils/addOriginToSpan';
+
+const INTEGRATION_NAME = 'Socket.io';
+
+export const instrumentSocketIo = generateInstrumentOnce(
+  INTEGRATION_NAME,
+  () =>
+    new SocketIoInstrumentation({
+      emitHook(span) {
+        addOriginToSpan(span, 'auto.socket.otel.socket_io');
+      },
+      onHook(span) {
+        addOriginToSpan(span, 'auto.socket.otel.socket_io');
+      },
+      traceReserved: true,
+    }),
+);
+
+const _socketIoIntegration = (() => {
+  return {
+    name: INTEGRATION_NAME,
+    setupOnce() {
+      instrumentSocketIo();
+    },
+  };
+}) satisfies IntegrationFn;
+
+/**
+ * Socket.io integration
+ *
+ * Capture tracing data for Socket.io
+ */
+export const socketIoIntegration = defineIntegration(_socketIoIntegration);

packages/remix/src/index.server.ts

@@ -112,6 +112,7 @@ export {
   setupKoaErrorHandler,
   setupNestErrorHandler,
   setUser,
+  socketIoIntegration,
   spanToBaggageHeader,
   spanToJSON,
   spanToTraceHeader,

packages/solidstart/src/server/index.ts

@@ -103,6 +103,7 @@ export {
   setupKoaErrorHandler,
   setupNestErrorHandler,
   setUser,
+  socketIoIntegration,
   spanToBaggageHeader,
   spanToJSON,
   spanToTraceHeader,

packages/sveltekit/src/server/index.ts

@@ -105,6 +105,7 @@ export {
   setupKoaErrorHandler,
   setupNestErrorHandler,
   setUser,
+  socketIoIntegration,
   spanToBaggageHeader,
   spanToJSON,
   spanToTraceHeader,