feat(instrumentation-ioredis): add request hook

plugins/node/opentelemetry-instrumentation-ioredis/README.md

@@ -58,6 +58,7 @@ IORedis instrumentation has few options available to choose from. You can set th
 | `dbStatementSerializer` | `DbStatementSerializer` | IORedis instrumentation will serialize db.statement using the specified function. |
 | `responseHook` | `RedisResponseCustomAttributeFunction` | Function for adding custom attributes on db response |
 | `requireParentSpan` | `boolean` | Require parent to create ioredis span, default when unset is true |
+| `moduleVersionAttributeName` | `string` | If passed, a span attribute will be added to all spans with key of the provided "moduleVersionAttributeName" and value of the module version. |
 
 #### Custom db.statement Serializer
 The instrumentation serializes the whole command into a Span attribute called `db.statement`. The standard serialization format is `{cmdName} {cmdArgs.join(',')}`.

plugins/node/opentelemetry-instrumentation-ioredis/src/ioredis.ts

@@ -48,15 +48,15 @@ export class IORedisInstrumentation extends InstrumentationBase<
       new InstrumentationNodeModuleDefinition<typeof ioredisTypes>(
         'ioredis',
         this.supportedVersions,
-        moduleExports => {
+        (moduleExports, moduleVersion?: string | undefined) => {
           diag.debug('Applying patch for ioredis');
           if (isWrapped(moduleExports.prototype.sendCommand)) {
             this._unwrap(moduleExports.prototype, 'sendCommand');
           }
           this._wrap(
             moduleExports.prototype,
             'sendCommand',
-            this._patchSendCommand()
+            this._patchSendCommand(moduleVersion)
           );
           if (isWrapped(moduleExports.prototype.connect)) {
             this._unwrap(moduleExports.prototype, 'connect');
@@ -81,9 +81,14 @@ export class IORedisInstrumentation extends InstrumentationBase<
   /**
    * Patch send command internal to trace requests
    */
-  private _patchSendCommand() {
+  private _patchSendCommand(moduleVersion?: string | undefined) {
     return (original: Function) => {
-      return traceSendCommand(this.tracer, original, this._config);
+      return traceSendCommand(
+        this.tracer,
+        original,
+        this._config,
+        moduleVersion
+      );
     };
   }
 

plugins/node/opentelemetry-instrumentation-ioredis/src/types.ts

@@ -71,4 +71,10 @@ export interface IORedisInstrumentationConfig extends InstrumentationConfig {
 
   /** Require parent to create ioredis span, default when unset is true */
   requireParentSpan?: boolean;
+
+  /**
+   * If passed, a span attribute will be added to all spans with key of the provided "moduleVersionAttributeName"
+   * and value of the module version.
+   */
+  moduleVersionAttributeName?: string;
 }

plugins/node/opentelemetry-instrumentation-ioredis/src/utils.ts

@@ -85,7 +85,8 @@ const defaultDbStatementSerializer: DbStatementSerializer = (
 export const traceSendCommand = (
   tracer: Tracer,
   original: Function,
-  config?: IORedisInstrumentationConfig
+  config?: IORedisInstrumentationConfig,
+  moduleVersion?: string | undefined
 ) => {
   const dbStatementSerializer =
     config?.dbStatementSerializer || defaultDbStatementSerializer;
@@ -110,6 +111,10 @@ export const traceSendCommand = (
       },
     });
 
+    if (config?.moduleVersionAttributeName && moduleVersion) {
+      span.setAttribute(config?.moduleVersionAttributeName, moduleVersion);
+    }
+
     const { host, port } = this.options;
 
     span.setAttributes({

plugins/node/opentelemetry-instrumentation-ioredis/test/ioredis.test.ts

@@ -228,6 +228,13 @@ describe('ioredis', () => {
     });
 
     describe('Instrumenting query operations', () => {
+      before(() => {
+        instrumentation.disable();
+        instrumentation = new IORedisInstrumentation();
+        instrumentation.setTracerProvider(provider);
+        require('ioredis');
+      });
+
       IOREDIS_CALLBACK_OPERATIONS.forEach(command => {
         it(`should create a child span for cb style ${command.description}`, done => {
           const attributes = {
@@ -762,6 +769,28 @@ describe('ioredis', () => {
       });
     });
 
+    it('moduleVersionAttributeName should capture ioredis version', async () => {
+      const VERSION_ATTR = 'instrumentedmodule.version';
+      instrumentation.disable();
+      const config: IORedisInstrumentationConfig = {
+        moduleVersionAttributeName: VERSION_ATTR,
+      };
+      instrumentation = new IORedisInstrumentation(config);
+      instrumentation.setTracerProvider(provider);
+      require('ioredis');
+
+      const span = provider.getTracer('ioredis-test').startSpan('test span');
+      await context.with(setSpan(context.active(), span), async () => {
+        await client.set(testKeyName, 'data');
+        const endedSpans = memoryExporter.getFinishedSpans();
+        assert.strictEqual(endedSpans.length, 1);
+        assert.match(
+          endedSpans[0].attributes[VERSION_ATTR] as string,
+          /\d{1,4}\.\d{1,4}\.\d{1,5}.*/
+        );
+      });
+    });
+
     describe('Instrumenting with a custom responseHook', () => {
       it('should call responseHook when set in config', async () => {
         instrumentation.disable();