chore(instrumentation-mysql): update semconv usage to ATTR_ exports (#3052)

Refs: #2377

Author: trentm

package-lock.json

@@ -66,7 +66,6 @@
   },
   "dependencies": {
     "@opentelemetry/instrumentation": "^0.205.0",
-    "@opentelemetry/semantic-conventions": "^1.27.0",
     "@types/mysql": "2.15.27"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-mysql#readme"

packages/instrumentation-mysql/package.json

@@ -28,10 +28,10 @@ import {
   isWrapped,
 } from '@opentelemetry/instrumentation';
 import {
-  DBSYSTEMVALUES_MYSQL,
-  SEMATTRS_DB_STATEMENT,
-  SEMATTRS_DB_SYSTEM,
-} from '@opentelemetry/semantic-conventions';
+  DB_SYSTEM_VALUE_MYSQL,
+  ATTR_DB_STATEMENT,
+  ATTR_DB_SYSTEM,
+} from './semconv';
 import type * as mysqlTypes from 'mysql';
 import { AttributeNames } from './AttributeNames';
 import { MySQLInstrumentationConfig } from './types';
@@ -53,7 +53,7 @@ type getConnectionCallbackType = (
 
 export class MySQLInstrumentation extends InstrumentationBase<MySQLInstrumentationConfig> {
   static readonly COMMON_ATTRIBUTES = {
-    [SEMATTRS_DB_SYSTEM]: DBSYSTEMVALUES_MYSQL,
+    [ATTR_DB_SYSTEM]: DB_SYSTEM_VALUE_MYSQL,
   };
   private declare _connectionsUsage: UpDownCounter;
 
@@ -310,7 +310,7 @@ export class MySQLInstrumentation extends InstrumentationBase<MySQLInstrumentati
           },
         });
 
-        span.setAttribute(SEMATTRS_DB_STATEMENT, getDbStatement(query));
+        span.setAttribute(ATTR_DB_STATEMENT, getDbStatement(query));
 
         if (thisPlugin.getConfig().enhancedDatabaseReporting) {
           let values;

packages/instrumentation-mysql/src/instrumentation.ts

@@ -0,0 +1,108 @@
+/*
+ * 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;
+
+/**
+ * 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 "mysql" for attribute {@link ATTR_DB_SYSTEM}.
+ *
+ * MySQL
+ *
+ * @experimental This enum value is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ */
+export const DB_SYSTEM_VALUE_MYSQL = 'mysql' as const;

packages/instrumentation-mysql/src/semconv.ts

@@ -16,12 +16,12 @@
 
 import { Attributes } from '@opentelemetry/api';
 import {
-  SEMATTRS_DB_CONNECTION_STRING,
-  SEMATTRS_DB_NAME,
-  SEMATTRS_DB_USER,
-  SEMATTRS_NET_PEER_NAME,
-  SEMATTRS_NET_PEER_PORT,
-} from '@opentelemetry/semantic-conventions';
+  ATTR_DB_CONNECTION_STRING,
+  ATTR_DB_NAME,
+  ATTR_DB_USER,
+  ATTR_NET_PEER_NAME,
+  ATTR_NET_PEER_PORT,
+} from './semconv';
 import type {
   ConnectionConfig,
   PoolActualConfig,
@@ -42,18 +42,18 @@ export function getConnectionAttributes(
   const portNumber = parseInt(port, 10);
   if (!isNaN(portNumber)) {
     return {
-      [SEMATTRS_NET_PEER_NAME]: host,
-      [SEMATTRS_NET_PEER_PORT]: portNumber,
-      [SEMATTRS_DB_CONNECTION_STRING]: getJDBCString(host, port, database),
-      [SEMATTRS_DB_NAME]: database,
-      [SEMATTRS_DB_USER]: user,
+      [ATTR_NET_PEER_NAME]: host,
+      [ATTR_NET_PEER_PORT]: portNumber,
+      [ATTR_DB_CONNECTION_STRING]: getJDBCString(host, port, database),
+      [ATTR_DB_NAME]: database,
+      [ATTR_DB_USER]: user,
     };
   }
   return {
-    [SEMATTRS_NET_PEER_NAME]: host,
-    [SEMATTRS_DB_CONNECTION_STRING]: getJDBCString(host, port, database),
-    [SEMATTRS_DB_NAME]: database,
-    [SEMATTRS_DB_USER]: user,
+    [ATTR_NET_PEER_NAME]: host,
+    [ATTR_DB_CONNECTION_STRING]: getJDBCString(host, port, database),
+    [ATTR_DB_NAME]: database,
+    [ATTR_DB_USER]: user,
   };
 }
 

packages/instrumentation-mysql/src/utils.ts

@@ -17,14 +17,14 @@
 import { context, Context, trace, SpanStatusCode } from '@opentelemetry/api';
 import { AsyncLocalStorageContextManager } from '@opentelemetry/context-async-hooks';
 import {
-  DBSYSTEMVALUES_MYSQL,
-  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_MYSQL,
+  ATTR_DB_NAME,
+  ATTR_DB_STATEMENT,
+  ATTR_DB_SYSTEM,
+  ATTR_DB_USER,
+  ATTR_NET_PEER_NAME,
+  ATTR_NET_PEER_PORT,
+} from '../src/semconv';
 import {
   BasicTracerProvider,
   InMemorySpanExporter,
@@ -860,12 +860,12 @@ function assertSpan(
   values?: any,
   errorMessage?: string
 ) {
-  assert.strictEqual(span.attributes[SEMATTRS_DB_SYSTEM], DBSYSTEMVALUES_MYSQL);
-  assert.strictEqual(span.attributes[SEMATTRS_DB_NAME], database);
-  assert.strictEqual(span.attributes[SEMATTRS_NET_PEER_PORT], port);
-  assert.strictEqual(span.attributes[SEMATTRS_NET_PEER_NAME], host);
-  assert.strictEqual(span.attributes[SEMATTRS_DB_USER], user);
-  assert.strictEqual(span.attributes[SEMATTRS_DB_STATEMENT], sql);
+  assert.strictEqual(span.attributes[ATTR_DB_SYSTEM], DB_SYSTEM_VALUE_MYSQL);
+  assert.strictEqual(span.attributes[ATTR_DB_NAME], database);
+  assert.strictEqual(span.attributes[ATTR_NET_PEER_PORT], port);
+  assert.strictEqual(span.attributes[ATTR_NET_PEER_NAME], host);
+  assert.strictEqual(span.attributes[ATTR_DB_USER], user);
+  assert.strictEqual(span.attributes[ATTR_DB_STATEMENT], sql);
   if (errorMessage) {
     assert.strictEqual(span.status.message, errorMessage);
     assert.strictEqual(span.status.code, SpanStatusCode.ERROR);