refactor: Migrated redis 4+ instrumentation to subscribe to events emitted (#3773)

Co-authored-by: Bob Evans <robert.evans25@gmail.com>

Author: amychisholm03

lib/instrumentation/@node-redis/client.js

@@ -14,6 +14,7 @@ const {
 module.exports = function initialize(_agent, redis, _moduleName, shim) {
   const proto = redis?.RedisClient?.prototype
   if (!proto) {
+    // This will happen when redis >= 4.0.0
     shim.logger.warn('Skipping redis instrumentation due to unrecognized module shape')
     return false
   }

lib/instrumentation/@redis/client.js

@@ -14,9 +14,7 @@ module.exports = function instrumentations() {
     '@grpc/grpc-js': { module: './instrumentation/grpc-js' },
     '@hapi/hapi': { type: InstrumentationDescriptor.TYPE_WEB_FRAMEWORK },
     '@hapi/vision': { type: InstrumentationDescriptor.TYPE_WEB_FRAMEWORK },
-    '@node-redis/client': { type: InstrumentationDescriptor.TYPE_DATASTORE },
     '@prisma/client': { type: InstrumentationDescriptor.TYPE_DATASTORE },
-    '@redis/client': { type: InstrumentationDescriptor.TYPE_DATASTORE },
     'aws-sdk': { module: './instrumentation/aws-sdk' },
     bluebird: { type: InstrumentationDescriptor.TYPE_PROMISE },
     connect: { type: InstrumentationDescriptor.TYPE_WEB_FRAMEWORK },

lib/instrumentation/redis.js

@@ -23,9 +23,11 @@ const subscribers = {
   ...require('./subscribers/mysql/config'),
   ...require('./subscribers/mysql2/config'),
   ...require('./subscribers/nestjs/config'),
+  ...require('./subscribers/node-redis-client/config'),
   ...require('./subscribers/openai/config'),
   ...require('./subscribers/pino/config'),
   ...require('./subscribers/pg/config'),
+  ...require('./subscribers/redis-client/config'),
   ...require('./subscribers/undici/config')
 }
 

lib/instrumentations.js

@@ -0,0 +1,13 @@
+/*
+ * Copyright 2026 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+const BaseCmdQueueAddCmdSubsriber = require('../redis-client/add-command')
+
+module.exports = class CmdQueueAddCmdSubscriber extends BaseCmdQueueAddCmdSubsriber {
+  constructor({ agent, logger }) {
+    super({ agent, logger, packageName: '@node-redis/client' })
+  }
+}

lib/subscriber-configs.js

@@ -0,0 +1,63 @@
+/*
+ * Copyright 2026 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const addCommand = {
+  path: './node-redis-client/add-command',
+  instrumentations: [{
+    channelName: 'nr_addCommand',
+    module: { name: '@node-redis/client', versionRange: '>=1', filePath: 'dist/lib/client/commands-queue.js' },
+    functionQuery: {
+      className: 'RedisCommandsQueue',
+      methodName: 'addCommand',
+      kind: 'Async'
+    }
+  }]
+}
+
+const sendCommand = {
+  path: './node-redis-client/send-command',
+  instrumentations: [
+    {
+      channelName: 'nr_sendCommand',
+      module: { name: '@node-redis/client', versionRange: '>=1.1.0', filePath: 'dist/lib/client/index.js' },
+      functionQuery: {
+        className: 'RedisClient',
+        methodName: 'sendCommand',
+        kind: 'Async'
+      }
+    },
+    {
+      channelName: 'nr_sendCommand',
+      module: { name: '@node-redis/client', versionRange: '>=1.0.0 <1.1.0', filePath: 'dist/lib/client/index.js' },
+      functionQuery: {
+        expressionName: '_RedisClient_sendCommand',
+        kind: 'Sync'
+      }
+    }
+  ]
+}
+
+const clientMulti = {
+  path: './node-redis-client/multi',
+  instrumentations: [
+    {
+      channelName: 'nr_multi',
+      module: { name: '@node-redis/client', versionRange: '>=1', filePath: 'dist/lib/client/index.js' },
+      functionQuery: {
+        className: 'RedisClient',
+        methodName: 'multi',
+        kind: 'Sync'
+      }
+    }
+  ]
+}
+
+module.exports = {
+  '@node-redis/client': [
+    addCommand,
+    sendCommand,
+    clientMulti,
+  ]
+}

lib/subscribers/node-redis-client/add-command.js

@@ -0,0 +1,13 @@
+/*
+ * Copyright 2026 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+const BaseMultiSubscriber = require('../redis-client/multi')
+
+module.exports = class ClientMultiSubscriber extends BaseMultiSubscriber {
+  constructor({ agent, logger }) {
+    super({ agent, logger, packageName: '@node-redis/client' })
+  }
+}

lib/subscribers/node-redis-client/config.js

@@ -0,0 +1,12 @@
+/*
+ * Copyright 2026 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const BaseSendCommandSubscriber = require('../redis-client/send-command')
+
+module.exports = class ClientSendCommandSubscriber extends BaseSendCommandSubscriber {
+  constructor({ agent, logger }) {
+    super({ agent, logger, packageName: '@node-redis/client' })
+  }
+}

lib/subscribers/node-redis-client/multi.js

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2026 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+const DbOperationSubscriber = require('../db-operation')
+const { redisClientOpts } = require('../../symbols')
+
+/**
+ * Listens to events on `RedisCommandQueue.addCommand` to create
+ * the segment with necessary datastore parameters for a given Redis
+ * operation.
+ *
+ * Relies on `ctx[redisClientOpts]` being set for the `host`, `port_path_or_id`,
+ * and `database` parameters.
+ */
+module.exports = class CmdQueueAddCmdSubscriber extends DbOperationSubscriber {
+  constructor({ agent, logger, packageName = '@redis/client' }) {
+    super({ agent, logger, packageName, channelName: 'nr_addCommand', system: 'Redis' })
+    this.events = ['asyncEnd']
+  }
+
+  handler(data, ctx) {
+    const { arguments: args } = data
+    const [cmd, key, value] = args[0]
+    this.setParameters({ ctx, key, value })
+    this.operation = cmd?.toLowerCase() || 'other'
+    return super.handler(data, ctx)
+  }
+
+  setParameters({ ctx, key, value }) {
+    const clientParams = ctx[redisClientOpts] ?? {}
+    this.parameters = Object.assign({}, clientParams)
+    this.parameters.product = this.system
+
+    if (this.agent.config.attributes.enabled) {
+      if (key) {
+        this.parameters.key = JSON.stringify(key)
+      }
+      if (value) {
+        this.parameters.value = JSON.stringify(value)
+      }
+    }
+  }
+}