chore(instrumentation-ioredis): update semconv usage to ATTR_ exports (#3059)

trentm · web-flow · commit a914e34372f5 · 2025-09-17T11:37:43.000Z
Refs: #2377
diff --git a/packages/instrumentation-ioredis/package.json b/packages/instrumentation-ioredis/package.json
@@ -58,6 +58,7 @@
     "@opentelemetry/contrib-test-utils": "^0.51.0",
     "@opentelemetry/sdk-trace-base": "^2.0.0",
     "@opentelemetry/sdk-trace-node": "^2.0.0",
+    "@opentelemetry/semantic-conventions": "^1.27.0",
     "@types/ioredis4": "npm:@types/ioredis@4.28.10",
     "@types/mocha": "10.0.10",
     "@types/node": "18.18.14",
@@ -72,8 +73,7 @@
   },
   "dependencies": {
     "@opentelemetry/instrumentation": "^0.205.0",
-    "@opentelemetry/redis-common": "^0.38.0",
-    "@opentelemetry/semantic-conventions": "^1.27.0"
+    "@opentelemetry/redis-common": "^0.38.0"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-ioredis#readme"
 }
diff --git a/packages/instrumentation-ioredis/src/instrumentation.ts b/packages/instrumentation-ioredis/src/instrumentation.ts
@@ -23,13 +23,13 @@ import {
 import { IORedisInstrumentationConfig } from './types';
 import { IORedisCommand, RedisInterface } from './internal-types';
 import {
-  DBSYSTEMVALUES_REDIS,
-  SEMATTRS_DB_CONNECTION_STRING,
-  SEMATTRS_DB_STATEMENT,
-  SEMATTRS_DB_SYSTEM,
-  SEMATTRS_NET_PEER_NAME,
-  SEMATTRS_NET_PEER_PORT,
-} from '@opentelemetry/semantic-conventions';
+  DB_SYSTEM_VALUE_REDIS,
+  ATTR_DB_CONNECTION_STRING,
+  ATTR_DB_STATEMENT,
+  ATTR_DB_SYSTEM,
+  ATTR_NET_PEER_NAME,
+  ATTR_NET_PEER_PORT,
+} from './semconv';
 import { safeExecuteInTheMiddle } from '@opentelemetry/instrumentation';
 import { endSpan } from './utils';
 import { defaultDbStatementSerializer } from '@opentelemetry/redis-common';
@@ -123,8 +123,8 @@ export class IORedisInstrumentation extends InstrumentationBase<IORedisInstrumen
       const span = instrumentation.tracer.startSpan(cmd.name, {
         kind: SpanKind.CLIENT,
         attributes: {
-          [SEMATTRS_DB_SYSTEM]: DBSYSTEMVALUES_REDIS,
-          [SEMATTRS_DB_STATEMENT]: dbStatementSerializer(cmd.name, cmd.args),
+          [ATTR_DB_SYSTEM]: DB_SYSTEM_VALUE_REDIS,
+          [ATTR_DB_STATEMENT]: dbStatementSerializer(cmd.name, cmd.args),
         },
       });
 
@@ -149,9 +149,9 @@ export class IORedisInstrumentation extends InstrumentationBase<IORedisInstrumen
       const { host, port } = this.options;
 
       span.setAttributes({
-        [SEMATTRS_NET_PEER_NAME]: host,
-        [SEMATTRS_NET_PEER_PORT]: port,
-        [SEMATTRS_DB_CONNECTION_STRING]: `redis://${host}:${port}`,
+        [ATTR_NET_PEER_NAME]: host,
+        [ATTR_NET_PEER_PORT]: port,
+        [ATTR_DB_CONNECTION_STRING]: `redis://${host}:${port}`,
       });
 
       try {
@@ -202,16 +202,16 @@ export class IORedisInstrumentation extends InstrumentationBase<IORedisInstrumen
       const span = instrumentation.tracer.startSpan('connect', {
         kind: SpanKind.CLIENT,
         attributes: {
-          [SEMATTRS_DB_SYSTEM]: DBSYSTEMVALUES_REDIS,
-          [SEMATTRS_DB_STATEMENT]: 'connect',
+          [ATTR_DB_SYSTEM]: DB_SYSTEM_VALUE_REDIS,
+          [ATTR_DB_STATEMENT]: 'connect',
         },
       });
       const { host, port } = this.options;
 
       span.setAttributes({
-        [SEMATTRS_NET_PEER_NAME]: host,
-        [SEMATTRS_NET_PEER_PORT]: port,
-        [SEMATTRS_DB_CONNECTION_STRING]: `redis://${host}:${port}`,
+        [ATTR_NET_PEER_NAME]: host,
+        [ATTR_NET_PEER_PORT]: port,
+        [ATTR_DB_CONNECTION_STRING]: `redis://${host}:${port}`,
       });
       try {
         const client = original.apply(this, arguments);
diff --git a/packages/instrumentation-ioredis/src/semconv.ts b/packages/instrumentation-ioredis/src/semconv.ts
@@ -0,0 +1,84 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/*
+ * This file contains a copy of unstable semantic convention definitions
+ * used by this package.
+ * @see https://github.com/open-telemetry/opentelemetry-js/tree/main/semantic-conventions#unstable-semconv
+ */
+
+/**
+ * Deprecated, use `server.address`, `server.port` attributes instead.
+ *
+ * @example "Server=(localdb)\\v11.0;Integrated Security=true;"
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ *
+ * @deprecated Replaced by `server.address` and `server.port`.
+ */
+export const ATTR_DB_CONNECTION_STRING = 'db.connection_string' as const;
+
+/**
+ * The database statement being executed.
+ *
+ * @example SELECT * FROM wuser_table
+ * @example SET mykey "WuValue"
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ *
+ * @deprecated Replaced by `db.query.text`.
+ */
+export const ATTR_DB_STATEMENT = 'db.statement' as const;
+
+/**
+ * Deprecated, use `db.system.name` instead.
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ *
+ * @deprecated Replaced by `db.system.name`.
+ */
+export const ATTR_DB_SYSTEM = 'db.system' as const;
+
+/**
+ * Deprecated, use `server.address` on client spans and `client.address` on server spans.
+ *
+ * @example example.com
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ *
+ * @deprecated Replaced by `server.address` on client spans and `client.address` on server spans.
+ */
+export const ATTR_NET_PEER_NAME = 'net.peer.name' as const;
+
+/**
+ * Deprecated, use `server.port` on client spans and `client.port` on server spans.
+ *
+ * @example 8080
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ *
+ * @deprecated Replaced by `server.port` on client spans and `client.port` on server spans.
+ */
+export const ATTR_NET_PEER_PORT = 'net.peer.port' as const;
+
+/**
+ * Enum value "redis" for attribute {@link ATTR_DB_SYSTEM}.
+ *
+ * Redis
+ *
+ * @experimental This enum value is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ */
+export const DB_SYSTEM_VALUE_REDIS = 'redis' as const;
diff --git a/packages/instrumentation-ioredis/test/ioredis.test.ts b/packages/instrumentation-ioredis/test/ioredis.test.ts
@@ -40,16 +40,18 @@ import {
   IORedisRequestHookInformation,
 } from '../src/types';
 import {
-  DBSYSTEMVALUES_REDIS,
-  SEMATTRS_DB_CONNECTION_STRING,
-  SEMATTRS_DB_STATEMENT,
-  SEMATTRS_DB_SYSTEM,
-  SEMATTRS_EXCEPTION_MESSAGE,
-  SEMATTRS_EXCEPTION_STACKTRACE,
-  SEMATTRS_EXCEPTION_TYPE,
-  SEMATTRS_NET_PEER_NAME,
-  SEMATTRS_NET_PEER_PORT,
+  ATTR_EXCEPTION_MESSAGE,
+  ATTR_EXCEPTION_STACKTRACE,
+  ATTR_EXCEPTION_TYPE,
 } from '@opentelemetry/semantic-conventions';
+import {
+  DB_SYSTEM_VALUE_REDIS,
+  ATTR_DB_CONNECTION_STRING,
+  ATTR_DB_STATEMENT,
+  ATTR_DB_SYSTEM,
+  ATTR_NET_PEER_NAME,
+  ATTR_NET_PEER_PORT,
+} from '../src/semconv';
 
 const memoryExporter = new InMemorySpanExporter();
 
@@ -61,10 +63,10 @@ const CONFIG = {
 const REDIS_URL = `redis://${CONFIG.host}:${CONFIG.port}`;
 
 const DEFAULT_ATTRIBUTES = {
-  [SEMATTRS_DB_SYSTEM]: DBSYSTEMVALUES_REDIS,
-  [SEMATTRS_NET_PEER_NAME]: CONFIG.host,
-  [SEMATTRS_NET_PEER_PORT]: CONFIG.port,
-  [SEMATTRS_DB_CONNECTION_STRING]: REDIS_URL,
+  [ATTR_DB_SYSTEM]: DB_SYSTEM_VALUE_REDIS,
+  [ATTR_NET_PEER_NAME]: CONFIG.host,
+  [ATTR_NET_PEER_PORT]: CONFIG.port,
+  [ATTR_DB_CONNECTION_STRING]: REDIS_URL,
 };
 
 const unsetStatus: SpanStatus = {
@@ -76,8 +78,8 @@ const predictableStackTrace =
 const sanitizeEventForAssertion = (span: ReadableSpan) => {
   span.events.forEach(e => {
     // stack trace includes data such as /user/{userName}/repos/{projectName}
-    if (e.attributes?.[SEMATTRS_EXCEPTION_STACKTRACE]) {
-      e.attributes[SEMATTRS_EXCEPTION_STACKTRACE] = predictableStackTrace;
+    if (e.attributes?.[ATTR_EXCEPTION_STACKTRACE]) {
+      e.attributes[ATTR_EXCEPTION_STACKTRACE] = predictableStackTrace;
     }
 
     // since time will change on each test invocation, it is being replaced to predicable value
@@ -130,7 +132,7 @@ describe('ioredis', () => {
       let client: ioredisTypes.Redis;
       const attributes = {
         ...DEFAULT_ATTRIBUTES,
-        [SEMATTRS_DB_STATEMENT]: 'connect',
+        [ATTR_DB_STATEMENT]: 'connect',
       };
       const readyHandler = () => {
         const endedSpans = memoryExporter.getFinishedSpans();
@@ -240,7 +242,7 @@ describe('ioredis', () => {
         it(`should create a child span for cb style ${command.description}`, done => {
           const attributes = {
             ...DEFAULT_ATTRIBUTES,
-            [SEMATTRS_DB_STATEMENT]: `${command.name} ${command.expectedDbStatement}`,
+            [ATTR_DB_STATEMENT]: `${command.name} ${command.expectedDbStatement}`,
           };
           const span = provider
             .getTracer('ioredis-test')
@@ -270,7 +272,7 @@ describe('ioredis', () => {
       it('should create a child span for hset promise', async () => {
         const attributes = {
           ...DEFAULT_ATTRIBUTES,
-          [SEMATTRS_DB_STATEMENT]: `hset ${hashKeyName} random [1 other arguments]`,
+          [ATTR_DB_STATEMENT]: `hset ${hashKeyName} random [1 other arguments]`,
         };
         const span = provider.getTracer('ioredis-test').startSpan('test span');
         await context.with(trace.setSpan(context.active(), span), async () => {
@@ -312,15 +314,15 @@ describe('ioredis', () => {
             const exceptionEvent = ioredisSpan.events[0];
             assert.strictEqual(exceptionEvent.name, 'exception');
             assert.strictEqual(
-              exceptionEvent.attributes?.[SEMATTRS_EXCEPTION_MESSAGE],
+              exceptionEvent.attributes?.[ATTR_EXCEPTION_MESSAGE],
               ex.message
             );
             assert.strictEqual(
-              exceptionEvent.attributes?.[SEMATTRS_EXCEPTION_STACKTRACE],
+              exceptionEvent.attributes?.[ATTR_EXCEPTION_STACKTRACE],
               ex.stack
             );
             assert.strictEqual(
-              exceptionEvent.attributes?.[SEMATTRS_EXCEPTION_TYPE],
+              exceptionEvent.attributes?.[ATTR_EXCEPTION_TYPE],
               ex.name
             );
           }
@@ -330,7 +332,7 @@ describe('ioredis', () => {
       it('should create a child span for streamify scanning', done => {
         const attributes = {
           ...DEFAULT_ATTRIBUTES,
-          [SEMATTRS_DB_STATEMENT]: 'scan 0 MATCH test-* COUNT 1000',
+          [ATTR_DB_STATEMENT]: 'scan 0 MATCH test-* COUNT 1000',
         };
         const span = provider.getTracer('ioredis-test').startSpan('test span');
         context.with(trace.setSpan(context.active(), span), () => {
@@ -406,7 +408,7 @@ describe('ioredis', () => {
 
             const attributes = {
               ...DEFAULT_ATTRIBUTES,
-              [SEMATTRS_DB_STATEMENT]: 'subscribe news music',
+              [ATTR_DB_STATEMENT]: 'subscribe news music',
             };
             testUtils.assertSpan(
               endedSpans[4],
@@ -425,7 +427,7 @@ describe('ioredis', () => {
       it('should create a child span for multi/transaction', done => {
         const attributes = {
           ...DEFAULT_ATTRIBUTES,
-          [SEMATTRS_DB_STATEMENT]: 'multi',
+          [ATTR_DB_STATEMENT]: 'multi',
         };
 
         const span = provider.getTracer('ioredis-test').startSpan('test span');
@@ -461,7 +463,7 @@ describe('ioredis', () => {
       it('should create a child span for pipeline', done => {
         const attributes = {
           ...DEFAULT_ATTRIBUTES,
-          [SEMATTRS_DB_STATEMENT]: 'set foo [1 other arguments]',
+          [ATTR_DB_STATEMENT]: 'set foo [1 other arguments]',
         };
 
         const span = provider.getTracer('ioredis-test').startSpan('test span');
@@ -495,7 +497,7 @@ describe('ioredis', () => {
       it('should create a child span for get promise', async () => {
         const attributes = {
           ...DEFAULT_ATTRIBUTES,
-          [SEMATTRS_DB_STATEMENT]: `get ${testKeyName}`,
+          [ATTR_DB_STATEMENT]: `get ${testKeyName}`,
         };
         const span = provider.getTracer('ioredis-test').startSpan('test span');
         await context.with(trace.setSpan(context.active(), span), async () => {
@@ -524,7 +526,7 @@ describe('ioredis', () => {
       it('should create a child span for del', async () => {
         const attributes = {
           ...DEFAULT_ATTRIBUTES,
-          [SEMATTRS_DB_STATEMENT]: `del ${testKeyName}`,
+          [ATTR_DB_STATEMENT]: `del ${testKeyName}`,
         };
         const span = provider.getTracer('ioredis-test').startSpan('test span');
         await context.with(trace.setSpan(context.active(), span), async () => {
@@ -558,7 +560,7 @@ describe('ioredis', () => {
 
         const attributes = {
           ...DEFAULT_ATTRIBUTES,
-          [SEMATTRS_DB_STATEMENT]: `evalsha bfbf458525d6a0b19200bfd6db3af481156b367b 1 ${testKeyName}`,
+          [ATTR_DB_STATEMENT]: `evalsha bfbf458525d6a0b19200bfd6db3af481156b367b 1 ${testKeyName}`,
         };
 
         const span = provider.getTracer('ioredis-test').startSpan('test span');
@@ -591,10 +593,10 @@ describe('ioredis', () => {
                 [
                   {
                     attributes: {
-                      [SEMATTRS_EXCEPTION_MESSAGE]:
+                      [ATTR_EXCEPTION_MESSAGE]:
                         'NOSCRIPT No matching script. Please use EVAL.',
-                      [SEMATTRS_EXCEPTION_STACKTRACE]: predictableStackTrace,
-                      [SEMATTRS_EXCEPTION_TYPE]: 'ReplyError',
+                      [ATTR_EXCEPTION_STACKTRACE]: predictableStackTrace,
+                      [ATTR_EXCEPTION_TYPE]: 'ReplyError',
                     },
                     name: 'exception',
                     time: [0, 0],
@@ -665,7 +667,7 @@ describe('ioredis', () => {
           SpanKind.CLIENT,
           {
             ...DEFAULT_ATTRIBUTES,
-            [SEMATTRS_DB_STATEMENT]: `set ${testKeyName} [1 other arguments]`,
+            [ATTR_DB_STATEMENT]: `set ${testKeyName} [1 other arguments]`,
           },
           [],
           unsetStatus
@@ -691,7 +693,7 @@ describe('ioredis', () => {
           SpanKind.CLIENT,
           {
             ...DEFAULT_ATTRIBUTES,
-            [SEMATTRS_DB_STATEMENT]: 'connect',
+            [ATTR_DB_STATEMENT]: 'connect',
           },
           [],
           unsetStatus
@@ -740,7 +742,7 @@ describe('ioredis', () => {
         it(`should tag the span with a custom db.statement for cb style ${command.description}`, done => {
           const attributes = {
             ...DEFAULT_ATTRIBUTES,
-            [SEMATTRS_DB_STATEMENT]: dbStatementSerializer(
+            [ATTR_DB_STATEMENT]: dbStatementSerializer(
               command.name,
               command.args
             ),
@@ -983,7 +985,7 @@ describe('ioredis', () => {
                 operation.args
               );
               assert.strictEqual(
-                endedSpans[0].attributes[SEMATTRS_DB_STATEMENT],
+                endedSpans[0].attributes[ATTR_DB_STATEMENT],
                 expectedStatement
               );
               done();
