chore(instrumentation-cassandra-driver): update semconv usage to ATTR_ exports (#3058)

trentm · web-flow · commit 8e2f6b45796c · 2025-09-17T09:22:38.000Z
Refs: #2377
diff --git a/packages/instrumentation-cassandra-driver/package.json b/packages/instrumentation-cassandra-driver/package.json
@@ -57,6 +57,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/mocha": "10.0.10",
     "@types/node": "18.18.14",
     "@types/semver": "7.5.8",
@@ -69,8 +70,7 @@
     "typescript": "5.0.4"
   },
   "dependencies": {
-    "@opentelemetry/instrumentation": "^0.205.0",
-    "@opentelemetry/semantic-conventions": "^1.27.0"
+    "@opentelemetry/instrumentation": "^0.205.0"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-cassandra-driver#readme"
 }
diff --git a/packages/instrumentation-cassandra-driver/src/instrumentation.ts b/packages/instrumentation-cassandra-driver/src/instrumentation.ts
@@ -31,14 +31,14 @@ import {
 } from '@opentelemetry/instrumentation';
 import { CassandraDriverInstrumentationConfig, ResultSet } from './types';
 import {
-  DBSYSTEMVALUES_CASSANDRA,
-  SEMATTRS_DB_NAME,
-  SEMATTRS_DB_STATEMENT,
-  SEMATTRS_DB_SYSTEM,
-  SEMATTRS_DB_USER,
-  SEMATTRS_NET_PEER_NAME,
-  SEMATTRS_NET_PEER_PORT,
-} from '@opentelemetry/semantic-conventions';
+  DB_SYSTEM_VALUE_CASSANDRA,
+  ATTR_DB_NAME,
+  ATTR_DB_STATEMENT,
+  ATTR_DB_SYSTEM,
+  ATTR_DB_USER,
+  ATTR_NET_PEER_NAME,
+  ATTR_NET_PEER_PORT,
+} from './semconv';
 /** @knipignore */
 import { PACKAGE_NAME, PACKAGE_VERSION } from './version';
 import { EventEmitter } from 'events';
@@ -174,10 +174,10 @@ export class CassandraDriverInstrumentation extends InstrumentationBase<Cassandr
         if (span !== undefined && conn !== undefined) {
           const port = parseInt(conn.port, 10);
 
-          span.setAttribute(SEMATTRS_NET_PEER_NAME, conn.address);
+          span.setAttribute(ATTR_NET_PEER_NAME, conn.address);
 
           if (!isNaN(port)) {
-            span.setAttribute(SEMATTRS_NET_PEER_PORT, port);
+            span.setAttribute(ATTR_NET_PEER_PORT, port);
           }
         }
 
@@ -305,23 +305,23 @@ export class CassandraDriverInstrumentation extends InstrumentationBase<Cassandr
     client: CassandraDriver.Client
   ): Span {
     const attributes: Attributes = {
-      [SEMATTRS_DB_SYSTEM]: DBSYSTEMVALUES_CASSANDRA,
+      [ATTR_DB_SYSTEM]: DB_SYSTEM_VALUE_CASSANDRA,
     };
 
     if (this._shouldIncludeDbStatement() && query !== undefined) {
       const statement = truncateQuery(query, this._getMaxQueryLength());
-      attributes[SEMATTRS_DB_STATEMENT] = statement;
+      attributes[ATTR_DB_STATEMENT] = statement;
     }
 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const user = (client as any).options?.credentials?.username;
 
     if (user) {
-      attributes[SEMATTRS_DB_USER] = user;
+      attributes[ATTR_DB_USER] = user;
     }
 
     if (client.keyspace) {
-      attributes[SEMATTRS_DB_NAME] = client.keyspace;
+      attributes[ATTR_DB_NAME] = client.keyspace;
     }
 
     return this.tracer.startSpan(`cassandra-driver.${op}`, {
diff --git a/packages/instrumentation-cassandra-driver/src/semconv.ts b/packages/instrumentation-cassandra-driver/src/semconv.ts
@@ -0,0 +1,97 @@
+/*
+ * 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 `db.namespace` instead.
+ *
+ * @example customers
+ * @example main
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ *
+ * @deprecated Replaced by `db.namespace`.
+ */
+export const ATTR_DB_NAME = 'db.name' 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, no replacement at this time.
+ *
+ * @example readonly_user
+ * @example reporting_user
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ *
+ * @deprecated Removed, no replacement at this time.
+ */
+export const ATTR_DB_USER = 'db.user' 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 "cassandra" for attribute {@link ATTR_DB_SYSTEM}.
+ *
+ * Apache Cassandra
+ *
+ * @experimental This enum value is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ */
+export const DB_SYSTEM_VALUE_CASSANDRA = 'cassandra' as const;
diff --git a/packages/instrumentation-cassandra-driver/test/cassandra-driver.test.ts b/packages/instrumentation-cassandra-driver/test/cassandra-driver.test.ts
@@ -30,16 +30,18 @@ import {
 import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
 import { AsyncLocalStorageContextManager } from '@opentelemetry/context-async-hooks';
 import {
-  DBSYSTEMVALUES_CASSANDRA,
-  SEMATTRS_DB_STATEMENT,
-  SEMATTRS_DB_SYSTEM,
-  SEMATTRS_DB_USER,
-  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_CASSANDRA,
+  ATTR_DB_STATEMENT,
+  ATTR_DB_SYSTEM,
+  ATTR_DB_USER,
+  ATTR_NET_PEER_NAME,
+  ATTR_NET_PEER_PORT,
+} from '../src/semconv';
 import * as assert from 'assert';
 import * as testUtils from '@opentelemetry/contrib-test-utils';
 import type * as CassandraDriver from 'cassandra-driver';
@@ -69,13 +71,13 @@ function assertSpan(
   customAttributes?: Attributes
 ) {
   const attributes: Attributes = {
-    [SEMATTRS_DB_SYSTEM]: DBSYSTEMVALUES_CASSANDRA,
-    [SEMATTRS_DB_USER]: 'cassandra',
+    [ATTR_DB_SYSTEM]: DB_SYSTEM_VALUE_CASSANDRA,
+    [ATTR_DB_USER]: 'cassandra',
     ...customAttributes,
   };
 
   if (query !== undefined) {
-    attributes[SEMATTRS_DB_STATEMENT] = query;
+    attributes[ATTR_DB_STATEMENT] = query;
   }
 
   const spanStatus =
@@ -113,23 +115,23 @@ function assertErrorSpan(
   const [span] = spans;
 
   const attributes: Attributes = {
-    [SEMATTRS_DB_SYSTEM]: DBSYSTEMVALUES_CASSANDRA,
-    [SEMATTRS_DB_USER]: 'cassandra',
+    [ATTR_DB_SYSTEM]: DB_SYSTEM_VALUE_CASSANDRA,
+    [ATTR_DB_USER]: 'cassandra',
     ...customAttributes,
   };
 
   if (query !== undefined) {
-    attributes[SEMATTRS_DB_STATEMENT] = query;
+    attributes[ATTR_DB_STATEMENT] = query;
   }
 
   const events = [
     {
       name: 'exception',
       droppedAttributesCount: 0,
       attributes: {
-        [SEMATTRS_EXCEPTION_STACKTRACE]: error.stack,
-        [SEMATTRS_EXCEPTION_MESSAGE]: error.message,
-        [SEMATTRS_EXCEPTION_TYPE]: String(error.code),
+        [ATTR_EXCEPTION_STACKTRACE]: error.stack,
+        [ATTR_EXCEPTION_MESSAGE]: error.message,
+        [ATTR_EXCEPTION_TYPE]: String(error.code),
       },
       time: span.events[0].time,
     },
@@ -193,16 +195,16 @@ describe('CassandraDriverInstrumentation', () => {
     it('creates a span for promise based execute', async () => {
       await client.execute('select * from ot.test');
       assertSingleSpan('cassandra-driver.execute', undefined, undefined, {
-        [SEMATTRS_NET_PEER_NAME]: cassandraContactPoint,
-        [SEMATTRS_NET_PEER_PORT]: 9042,
+        [ATTR_NET_PEER_NAME]: cassandraContactPoint,
+        [ATTR_NET_PEER_PORT]: 9042,
       });
     });
 
     it('creates a span for callback based execute', done => {
       client.execute('select * from ot.test', () => {
         assertSingleSpan('cassandra-driver.execute', undefined, undefined, {
-          [SEMATTRS_NET_PEER_NAME]: cassandraContactPoint,
-          [SEMATTRS_NET_PEER_PORT]: 9042,
+          [ATTR_NET_PEER_NAME]: cassandraContactPoint,
+          [ATTR_NET_PEER_PORT]: 9042,
         });
         done();
       });
@@ -213,8 +215,8 @@ describe('CassandraDriverInstrumentation', () => {
         await client.execute('selec * from');
       } catch (e: any) {
         assertErrorSpan('cassandra-driver.execute', e, undefined, {
-          [SEMATTRS_NET_PEER_NAME]: cassandraContactPoint,
-          [SEMATTRS_NET_PEER_PORT]: 9042,
+          [ATTR_NET_PEER_NAME]: cassandraContactPoint,
+          [ATTR_NET_PEER_PORT]: 9042,
         });
         return;
       }
@@ -243,17 +245,17 @@ describe('CassandraDriverInstrumentation', () => {
         const query = 'select * from ot.test';
         await client.execute(query);
         assertSingleSpan('cassandra-driver.execute', query, undefined, {
-          [SEMATTRS_NET_PEER_NAME]: cassandraContactPoint,
-          [SEMATTRS_NET_PEER_PORT]: 9042,
+          [ATTR_NET_PEER_NAME]: cassandraContactPoint,
+          [ATTR_NET_PEER_PORT]: 9042,
         });
       });
 
       it('truncates long queries', async () => {
         const query = 'select userid, count from ot.test';
         await client.execute(query);
         const customAttributes = {
-          [SEMATTRS_NET_PEER_NAME]: cassandraContactPoint,
-          [SEMATTRS_NET_PEER_PORT]: 9042,
+          [ATTR_NET_PEER_NAME]: cassandraContactPoint,
+          [ATTR_NET_PEER_PORT]: 9042,
         };
         assertSingleSpan(
           'cassandra-driver.execute',
@@ -299,8 +301,8 @@ describe('CassandraDriverInstrumentation', () => {
         assertAttributeInSingleSpan('cassandra-driver.execute', {
           [customAttributeName]: customAttributeValue,
           [responseAttributeName]: 2,
-          [SEMATTRS_NET_PEER_NAME]: cassandraContactPoint,
-          [SEMATTRS_NET_PEER_PORT]: 9042,
+          [ATTR_NET_PEER_NAME]: cassandraContactPoint,
+          [ATTR_NET_PEER_PORT]: 9042,
         });
       });
 
@@ -322,8 +324,8 @@ describe('CassandraDriverInstrumentation', () => {
 
         assertAttributeInSingleSpan('cassandra-driver.execute', {
           [hookAttributeName]: hookAttributeValue,
-          [SEMATTRS_NET_PEER_NAME]: cassandraContactPoint,
-          [SEMATTRS_NET_PEER_PORT]: 9042,
+          [ATTR_NET_PEER_NAME]: cassandraContactPoint,
+          [ATTR_NET_PEER_PORT]: 9042,
         });
       });
     });
@@ -346,8 +348,8 @@ describe('CassandraDriverInstrumentation', () => {
     it('creates a span for callback based batch', done => {
       client.batch([q1, q2], () => {
         assertSingleSpan('cassandra-driver.batch', undefined, undefined, {
-          [SEMATTRS_NET_PEER_NAME]: cassandraContactPoint,
-          [SEMATTRS_NET_PEER_PORT]: 9042,
+          [ATTR_NET_PEER_NAME]: cassandraContactPoint,
+          [ATTR_NET_PEER_PORT]: 9042,
         });
         done();
       });
@@ -399,8 +401,8 @@ describe('CassandraDriverInstrumentation', () => {
       // stream internally uses execute
       assert.strictEqual(spans.length, 2);
       assertSpan(spans[0], 'cassandra-driver.execute', undefined, undefined, {
-        [SEMATTRS_NET_PEER_NAME]: cassandraContactPoint,
-        [SEMATTRS_NET_PEER_PORT]: 9042,
+        [ATTR_NET_PEER_NAME]: cassandraContactPoint,
+        [ATTR_NET_PEER_PORT]: 9042,
       });
       assertSpan(spans[1], 'cassandra-driver.stream');
     }
