instrument the iovalkey package (#5555)

* feat: monitor io-valkey

* rename redis.command to valkey.command

* Apply suggestions from code review

Co-authored-by: Ruben Bridgewater <ruben@bridgewater.de>

* Update packages/datadog-instrumentations/src/iovalkey.js

Co-authored-by: Ruben Bridgewater <ruben@bridgewater.de>

* Update packages/datadog-instrumentations/src/helpers/hooks.js

* Apply suggestions from code review BridgeAR

Co-authored-by: Ruben Bridgewater <ruben@bridgewater.de>

* add span type to class / subclass

* seems that our agent.use stuff is broken

* break apart redis, ioredis, valkey jobs

* refactor tests

* try using redis server 6.2

* promise to async

---------

Co-authored-by: Nicolas Hansse <nicolas.hansse@royalcanin.com>
Co-authored-by: Ruben Bridgewater <ruben@bridgewater.de>

Author: 3 people

.github/workflows/plugins.yml

@@ -1023,16 +1023,44 @@ jobs:
     runs-on: ubuntu-latest
     services:
       redis:
-        image: redis:4.0-alpine
+        image: redis:6.2-alpine
         ports:
           - 6379:6379
     env:
-      PLUGINS: redis|ioredis # TODO: move ioredis to its own job
+      PLUGINS: redis
       SERVICES: redis
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - uses: ./.github/actions/plugins/test
 
+  ioredis:
+    runs-on: ubuntu-latest
+    services:
+      redis:
+        image: redis:6.2-alpine
+        ports:
+          - 6379:6379
+    env:
+      PLUGINS: ioredis
+      SERVICES: ioredis
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: ./.github/actions/plugins/test
+
+  valkey:
+    runs-on: ubuntu-latest
+    services:
+      valkey:
+        image: valkey/valkey:8.1-alpine
+        ports:
+          - 6379:6379
+    env:
+      PLUGINS: iovalkey
+      SERVICES: valkey
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: ./.github/actions/plugins/test
+
   restify:
     runs-on: ubuntu-latest
     env:

docs/API.md

@@ -57,6 +57,9 @@ tracer.use('pg', {
 <h5 id="ioredis"></h5>
 <h5 id="ioredis-tags"></h5>
 <h5 id="ioredis-config"></h5>
+<h5 id="iovalkey"></h5>
+<h5 id="iovalkey-tags"></h5>
+<h5 id="iovalkey-config"></h5>
 <h5 id="jest"></h5>
 <h5 id="kafkajs"></h5>
 <h5 id="koa"></h5>
@@ -128,6 +131,7 @@ tracer.use('pg', {
 * [http](./interfaces/export_.plugins.http.html)
 * [http2](./interfaces/export_.plugins.http2.html)
 * [ioredis](./interfaces/export_.plugins.ioredis.html)
+* [iovalkey](./interfaces/export_.plugins.iovalkey.html)
 * [jest](./interfaces/export_.plugins.jest.html)
 * [kafkajs](./interfaces/export_.plugins.kafkajs.html)
 * [knex](./interfaces/export_.plugins.knex.html)

docs/add-redirects.sh

@@ -36,6 +36,7 @@ declare -a plugins=(
   "http"
   "http2"
   "ioredis"
+  "iovalkey"
   "jest"
   "kafkajs"
   "knex"

docs/test.ts

@@ -348,6 +348,9 @@ tracer.use('http2', {
 tracer.use('ioredis');
 tracer.use('ioredis', redisOptions);
 tracer.use('ioredis', { splitByInstance: true });
+tracer.use('iovalkey');
+tracer.use('iovalkey', redisOptions);
+tracer.use('iovalkey', { splitByInstance: true });
 tracer.use('jest');
 tracer.use('jest', { service: 'jest-service' });
 tracer.use('kafkajs');

index.d.ts

@@ -189,6 +189,7 @@ interface Plugins {
   "http": tracer.plugins.http;
   "http2": tracer.plugins.http2;
   "ioredis": tracer.plugins.ioredis;
+  "iovalkey": tracer.plugins.iovalkey;
   "jest": tracer.plugins.jest;
   "kafkajs": tracer.plugins.kafkajs
   "knex": tracer.plugins.knex;
@@ -1666,6 +1667,53 @@ declare namespace tracer {
       splitByInstance?: boolean;
     }
 
+    /**
+     * This plugin automatically instruments the
+     * [iovalkey](https://github.com/valkey-io/iovalkey) module.
+     */
+    interface iovalkey extends Instrumentation {
+      /**
+       * List of commands that should be instrumented. Commands must be in
+       * lowercase for example 'xread'.
+       *
+       * @default /^.*$/
+       */
+      allowlist?: string | RegExp | ((command: string) => boolean) | (string | RegExp | ((command: string) => boolean))[];
+
+      /**
+       * Deprecated in favor of `allowlist`.
+       *
+       * @deprecated
+       * @hidden
+       */
+      whitelist?: string | RegExp | ((command: string) => boolean) | (string | RegExp | ((command: string) => boolean))[];
+
+      /**
+       * List of commands that should not be instrumented. Takes precedence over
+       * allowlist if a command matches an entry in both. Commands must be in
+       * lowercase for example 'xread'.
+       *
+       * @default []
+       */
+      blocklist?: string | RegExp | ((command: string) => boolean) | (string | RegExp | ((command: string) => boolean))[];
+
+      /**
+       * Deprecated in favor of `blocklist`.
+       *
+       * @deprecated
+       * @hidden
+       */
+      blacklist?: string | RegExp | ((command: string) => boolean) | (string | RegExp | ((command: string) => boolean))[];
+
+      /**
+       * Whether to use a different service name for each Redis instance based
+       * on the configured connection name of the client.
+       *
+       * @default false
+       */
+      splitByInstance?: boolean;
+    }
+
     /**
      * This plugin automatically instruments the
      * [jest](https://github.com/jestjs/jest) module.

packages/datadog-instrumentations/src/helpers/hooks.js

@@ -61,6 +61,7 @@ module.exports = {
   http2: () => require('../http2'),
   https: () => require('../http'),
   ioredis: () => require('../ioredis'),
+  iovalkey: () => require('../iovalkey'),
   'jest-circus': () => require('../jest'),
   'jest-config': () => require('../jest'),
   'jest-environment-node': () => require('../jest'),

packages/datadog-instrumentations/src/iovalkey.js

@@ -0,0 +1,51 @@
+'use strict'
+
+const {
+  channel,
+  addHook,
+  AsyncResource
+} = require('./helpers/instrument')
+const shimmer = require('../../datadog-shimmer')
+
+const startCh = channel('apm:iovalkey:command:start')
+const finishCh = channel('apm:iovalkey:command:finish')
+const errorCh = channel('apm:iovalkey:command:error')
+
+addHook({ name: 'iovalkey', versions: ['>=0.0.1'] }, Valkey => {
+  shimmer.wrap(Valkey.prototype, 'sendCommand', sendCommand => function (command, stream) {
+    if (!startCh.hasSubscribers) return sendCommand.apply(this, arguments)
+
+    if (!command?.promise) return sendCommand.apply(this, arguments)
+
+    const options = this.options || {}
+    const connectionName = options.connectionName
+    const db = options.db
+    const connectionOptions = { host: options.host, port: options.port }
+
+    const asyncResource = new AsyncResource('bound-anonymous-fn')
+    return asyncResource.runInAsyncScope(() => {
+      startCh.publish({ db, command: command.name, args: command.args, connectionOptions, connectionName })
+
+      const onResolve = asyncResource.bind(() => finishCh.publish())
+      const onReject = asyncResource.bind(err => finish(finishCh, errorCh, err))
+
+      command.promise.then(onResolve, onReject)
+
+      try {
+        return sendCommand.apply(this, arguments)
+      } catch (err) {
+        errorCh.publish(err)
+
+        throw err
+      }
+    })
+  })
+  return Valkey
+})
+
+function finish (finishCh, errorCh, error) {
+  if (error) {
+    errorCh.publish(error)
+  }
+  finishCh.publish()
+}

packages/datadog-plugin-ioredis/test/index.spec.js

@@ -25,26 +25,25 @@ describe('Plugin', () => {
       })
 
       describe('without configuration', () => {
-        before(() => agent.load(['ioredis']))
+        beforeEach(() => agent.load(['ioredis']))
 
-        after(() => agent.close({ ritmReset: false }))
+        afterEach(() => agent.close({ ritmReset: false }))
 
         it('should do automatic instrumentation when using callbacks', done => {
           agent.use(() => {}) // wait for initial info command
-          agent
-            .use(traces => {
-              expect(traces[0][0]).to.have.property('name', expectedSchema.outbound.opName)
-              expect(traces[0][0]).to.have.property('service', expectedSchema.outbound.serviceName)
-              expect(traces[0][0]).to.have.property('resource', 'get')
-              expect(traces[0][0]).to.have.property('type', 'redis')
-              expect(traces[0][0].meta).to.have.property('component', 'ioredis')
-              expect(traces[0][0].meta).to.have.property('db.name', '0')
-              expect(traces[0][0].meta).to.have.property('db.type', 'redis')
-              expect(traces[0][0].meta).to.have.property('span.kind', 'client')
-              expect(traces[0][0].meta).to.have.property('out.host', 'localhost')
-              expect(traces[0][0].meta).to.have.property('redis.raw_command', 'GET foo')
-              expect(traces[0][0].metrics).to.have.property('network.destination.port', 6379)
-            })
+          agent.use(traces => {
+            expect(traces[0][0]).to.have.property('name', expectedSchema.outbound.opName)
+            expect(traces[0][0]).to.have.property('service', expectedSchema.outbound.serviceName)
+            expect(traces[0][0]).to.have.property('resource', 'get')
+            expect(traces[0][0]).to.have.property('type', 'redis')
+            expect(traces[0][0].meta).to.have.property('component', 'ioredis')
+            expect(traces[0][0].meta).to.have.property('db.name', '0')
+            expect(traces[0][0].meta).to.have.property('db.type', 'redis')
+            expect(traces[0][0].meta).to.have.property('span.kind', 'client')
+            expect(traces[0][0].meta).to.have.property('out.host', 'localhost')
+            expect(traces[0][0].meta).to.have.property('redis.raw_command', 'GET foo')
+            expect(traces[0][0].metrics).to.have.property('network.destination.port', 6379)
+          })
             .then(done)
             .catch(done)
 
@@ -54,11 +53,9 @@ describe('Plugin', () => {
         it('should run the callback in the parent context', () => {
           const span = {}
 
-          return tracer.scope().activate(span, () => {
-            return redis.get('foo')
-              .then(() => {
-                expect(tracer.scope().active()).to.equal(span)
-              })
+          return tracer.scope().activate(span, async () => {
+            await redis.get('foo')
+            expect(tracer.scope().active()).to.equal(span)
           })
         })
 

packages/datadog-plugin-iovalkey/src/index.js

@@ -0,0 +1,18 @@
+'use strict'
+
+const RedisPlugin = require('../../datadog-plugin-redis/src')
+
+class IOValkeyPlugin extends RedisPlugin {
+  static get id () {
+    return 'iovalkey'
+  }
+
+  static get system () { return 'valkey' }
+
+  constructor (...args) {
+    super(...args)
+    this._spanType = 'valkey'
+  }
+}
+
+module.exports = IOValkeyPlugin