test(redis): add semconvStability tests and override setConfig

Author: adbista

packages/instrumentation-redis/src/types.ts

@@ -15,7 +15,10 @@
  */
 
 import { Span } from '@opentelemetry/api';
-import { InstrumentationConfig } from '@opentelemetry/instrumentation';
+import {
+  InstrumentationConfig,
+  SemconvStability,
+} from '@opentelemetry/instrumentation';
 
 /**
  * Function that can be used to serialize db.statement tag
@@ -56,4 +59,7 @@ export interface RedisInstrumentationConfig extends InstrumentationConfig {
 
   /** Require parent to create redis span, default when unset is false */
   requireParentSpan?: boolean;
+
+  /** Controls which semantic convention attributes are emitted on spans. */
+  semconvStability?: SemconvStability;
 }

packages/instrumentation-redis/src/v2-v3/instrumentation.ts

@@ -59,6 +59,16 @@ export class RedisInstrumentationV2_V3 extends InstrumentationBase<RedisInstrume
     );
   }
 
+  override setConfig(config: RedisInstrumentationConfig = {}) {
+    super.setConfig(config);
+    this._semconvStability = config.semconvStability
+      ? config.semconvStability
+      : semconvStabilityFromStr(
+          'database',
+          process.env.OTEL_SEMCONV_STABILITY_OPT_IN
+        );
+  }
+
   protected init() {
     return [
       new InstrumentationNodeModuleDefinition(

packages/instrumentation-redis/src/v4-v5/instrumentation.ts

@@ -67,6 +67,16 @@ export class RedisInstrumentationV4_V5 extends InstrumentationBase<RedisInstrume
     );
   }
 
+  override setConfig(config: RedisInstrumentationConfig = {}) {
+    super.setConfig(config);
+    this._semconvStability = config.semconvStability
+      ? config.semconvStability
+      : semconvStabilityFromStr(
+          'database',
+          process.env.OTEL_SEMCONV_STABILITY_OPT_IN
+        );
+  }
+
   protected init() {
     // @node-redis/client is a new package introduced and consumed by 'redis 4.0.x'
     // on [email protected] it was changed to @redis/client.

packages/instrumentation-redis/test/v2-v3/redis.test.ts

@@ -33,8 +33,14 @@ import {
   SEMATTRS_DB_SYSTEM,
   SEMATTRS_NET_PEER_NAME,
   SEMATTRS_NET_PEER_PORT,
+  ATTR_DB_SYSTEM_NAME,
+  ATTR_DB_OPERATION_NAME,
+  ATTR_DB_QUERY_TEXT,
+  ATTR_SERVER_ADDRESS,
+  ATTR_SERVER_PORT,
 } from '@opentelemetry/semantic-conventions';
 
+process.env.OTEL_SEMCONV_STABILITY_OPT_IN = 'database/dup';
 const instrumentation = testUtils.registerInstrumentationTesting(
   new RedisInstrumentation()
 );
@@ -50,6 +56,9 @@ const CONFIG = {
 const URL = `redis://${CONFIG.host}:${CONFIG.port}`;
 
 const DEFAULT_ATTRIBUTES = {
+  [ATTR_DB_SYSTEM_NAME]: 'redis',
+  [ATTR_SERVER_ADDRESS]: CONFIG.host,
+  [ATTR_SERVER_PORT]: CONFIG.port,
   [SEMATTRS_DB_SYSTEM]: DBSYSTEMVALUES_REDIS,
   [SEMATTRS_NET_PEER_NAME]: CONFIG.host,
   [SEMATTRS_NET_PEER_PORT]: CONFIG.port,
@@ -105,29 +114,33 @@ describe('redis v2-v3', () => {
       description: string;
       command: string;
       args: string[];
-      expectedDbStatement: string;
+      expectedDbStatementOld: string;
+      expectedDbStatementStable: string;
       method: (cb: Callback<unknown>) => unknown;
     }> = [
       {
         description: 'insert',
         command: 'hset',
         args: ['hash', 'random', 'random'],
-        expectedDbStatement: 'hash random [1 other arguments]',
+        expectedDbStatementOld: 'hash random [1 other arguments]',
+        expectedDbStatementStable: 'hset hash random [1 other arguments]',
         method: (cb: Callback<number>) =>
           client.hset('hash', 'random', 'random', cb),
       },
       {
         description: 'get',
         command: 'get',
         args: ['test'],
-        expectedDbStatement: 'test',
+        expectedDbStatementOld: 'test',
+        expectedDbStatementStable: 'get test',
         method: (cb: Callback<string | null>) => client.get('test', cb),
       },
       {
         description: 'delete',
         command: 'del',
         args: ['test'],
-        expectedDbStatement: 'test',
+        expectedDbStatementOld: 'test',
+        expectedDbStatementStable: 'del test',
         method: (cb: Callback<number>) => client.del('test', cb),
       },
     ];
@@ -163,7 +176,9 @@ describe('redis v2-v3', () => {
         it(`should create a child span for ${operation.description}`, done => {
           const attributes = {
             ...DEFAULT_ATTRIBUTES,
-            [SEMATTRS_DB_STATEMENT]: `${operation.command} ${operation.expectedDbStatement}`,
+            [ATTR_DB_OPERATION_NAME]: operation.command,
+            [ATTR_DB_QUERY_TEXT]: operation.expectedDbStatementStable,
+            [SEMATTRS_DB_STATEMENT]: `${operation.command} ${operation.expectedDbStatementOld}`,
           };
           const span = tracer.startSpan('test span');
           context.with(trace.setSpan(context.active(), span), () => {
@@ -177,6 +192,7 @@ describe('redis v2-v3', () => {
                 endedSpans[0].name,
                 `redis-${operation.command}`
               );
+
               testUtils.assertSpan(
                 endedSpans[0],
                 SpanKind.CLIENT,
@@ -233,6 +249,11 @@ describe('redis v2-v3', () => {
                 endedSpans[0].attributes[SEMATTRS_DB_STATEMENT],
                 expectedStatement
               );
+
+              assert.strictEqual(
+                endedSpans[0].attributes[ATTR_DB_QUERY_TEXT],
+                expectedStatement
+              );
               done();
             });
           });