feat(ioredis): Add integration for ioredis (#11856)

Integration for Node
`integrations: [Sentry.experimental_redisIntegration()]`

---------

Co-authored-by: Francesco Novy <[email protected]>

Author: s1gr1d

MIGRATION.md

@@ -351,6 +351,7 @@ We now support the following integrations out of the box without extra configura
 - `mongooseIntegration`: Automatically instruments Mongoose
 - `mysqlIntegration`: Automatically instruments MySQL
 - `mysql2Integration`: Automatically instruments MySQL2
+- `redisIntegration`: Automatically instruments Redis (supported clients: ioredis)
 - `nestIntegration`: Automatically instruments Nest.js
 - `postgresIntegration`: Automatically instruments PostgreSQL
 - `prismaIntegration`: Automatically instruments Prisma

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

@@ -44,6 +44,7 @@
     "express": "^4.17.3",
     "graphql": "^16.3.0",
     "http-terminator": "^3.2.0",
+    "ioredis": "^5.4.1",
     "mongodb": "^3.7.3",
     "mongodb-memory-server-global": "^7.6.3",
     "mongoose": "^5.13.22",

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

@@ -0,0 +1,9 @@
+version: '3.9'
+
+services:
+  db:
+    image: redis:latest
+    restart: always
+    container_name: integration-tests-redis
+    ports:
+      - '6379:6379'

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

@@ -0,0 +1,37 @@
+const { loggingTransport } = 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 Redis = require('ioredis');
+
+const redis = new Redis({ port: 6379 });
+
+async function run() {
+  await Sentry.startSpan(
+    {
+      name: 'Test Transaction',
+      op: 'transaction',
+    },
+    async () => {
+      try {
+        await redis.set('test-key', 'test-value');
+
+        await redis.get('test-key');
+      } finally {
+        await redis.disconnect();
+      }
+    },
+  );
+}
+
+// eslint-disable-next-line @typescript-eslint/no-floating-promises
+run();

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

@@ -0,0 +1,40 @@
+import { cleanupChildProcesses, createRunner } from '../../../utils/runner';
+
+describe('redis auto instrumentation', () => {
+  afterAll(() => {
+    cleanupChildProcesses();
+  });
+
+  test('should auto-instrument `ioredis` package when using redis.set() and redis.get()', done => {
+    const EXPECTED_TRANSACTION = {
+      transaction: 'Test Transaction',
+      spans: expect.arrayContaining([
+        expect.objectContaining({
+          description: 'set test-key [1 other arguments]',
+          op: 'db',
+          data: expect.objectContaining({
+            'db.system': 'redis',
+            'net.peer.name': 'localhost',
+            'net.peer.port': 6379,
+            'db.statement': 'set test-key [1 other arguments]',
+          }),
+        }),
+        expect.objectContaining({
+          description: 'get test-key',
+          op: 'db',
+          data: expect.objectContaining({
+            'db.system': 'redis',
+            'net.peer.name': 'localhost',
+            'net.peer.port': 6379,
+            'db.statement': 'get test-key',
+          }),
+        }),
+      ]),
+    };
+
+    createRunner(__dirname, 'scenario-ioredis.js')
+      .withDockerCompose({ workingDirectory: [__dirname], readyMatches: ['port=6379'] })
+      .expect({ transaction: EXPECTED_TRANSACTION })
+      .start(done);
+  });
+});

packages/astro/src/index.server.ts

@@ -80,6 +80,7 @@ export {
   mongooseIntegration,
   mysqlIntegration,
   mysql2Integration,
+  redisIntegration,
   nestIntegration,
   setupNestErrorHandler,
   postgresIntegration,

packages/aws-serverless/src/index.ts

@@ -85,6 +85,7 @@ export {
   mongooseIntegration,
   mysqlIntegration,
   mysql2Integration,
+  redisIntegration,
   nestIntegration,
   setupNestErrorHandler,
   postgresIntegration,

packages/bun/src/index.ts

@@ -106,6 +106,7 @@ export {
   mongooseIntegration,
   mysqlIntegration,
   mysql2Integration,
+  redisIntegration,
   nestIntegration,
   setupNestErrorHandler,
   postgresIntegration,

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

@@ -85,6 +85,7 @@ export {
   mongooseIntegration,
   mysqlIntegration,
   mysql2Integration,
+  redisIntegration,
   nestIntegration,
   setupNestErrorHandler,
   postgresIntegration,

packages/node/package.json

@@ -63,6 +63,7 @@
     "@opentelemetry/instrumentation-graphql": "0.39.0",
     "@opentelemetry/instrumentation-hapi": "0.36.0",
     "@opentelemetry/instrumentation-http": "0.48.0",
+    "@opentelemetry/instrumentation-ioredis":  "0.40.0",
     "@opentelemetry/instrumentation-koa": "0.39.0",
     "@opentelemetry/instrumentation-mongodb": "0.39.0",
     "@opentelemetry/instrumentation-mongoose": "0.37.0",