chore(instrumentation-memcached): update semconv usage to ATTR_ exports (#3050)

Refs: #2377

Author: trentm

package-lock.json

@@ -55,6 +55,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",
     "cross-env": "7.0.3",
@@ -65,7 +66,6 @@
   },
   "dependencies": {
     "@opentelemetry/instrumentation": "^0.205.0",
-    "@opentelemetry/semantic-conventions": "^1.27.0",
     "@types/memcached": "^2.2.6"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-memcached#readme"

packages/instrumentation-memcached/package.json

@@ -22,11 +22,11 @@ import {
 } from '@opentelemetry/instrumentation';
 import type * as Memcached from 'memcached';
 import {
-  DBSYSTEMVALUES_MEMCACHED,
-  SEMATTRS_DB_OPERATION,
-  SEMATTRS_DB_STATEMENT,
-  SEMATTRS_DB_SYSTEM,
-} from '@opentelemetry/semantic-conventions';
+  DB_SYSTEM_VALUE_MEMCACHED,
+  ATTR_DB_OPERATION,
+  ATTR_DB_STATEMENT,
+  ATTR_DB_SYSTEM,
+} from './semconv';
 import * as utils from './utils';
 import { InstrumentationConfig } from './types';
 /** @knipignore */
@@ -35,7 +35,7 @@ import { PACKAGE_NAME, PACKAGE_VERSION } from './version';
 export class MemcachedInstrumentation extends InstrumentationBase<InstrumentationConfig> {
   static readonly COMPONENT = 'memcached';
   static readonly COMMON_ATTRIBUTES = {
-    [SEMATTRS_DB_SYSTEM]: DBSYSTEMVALUES_MEMCACHED,
+    [ATTR_DB_SYSTEM]: DB_SYSTEM_VALUE_MEMCACHED,
   };
   static readonly DEFAULT_CONFIG: InstrumentationConfig = {
     enhancedDatabaseReporting: false,
@@ -137,8 +137,8 @@ export class MemcachedInstrumentation extends InstrumentationBase<Instrumentatio
       span.setAttributes({
         'db.memcached.key': query.key,
         'db.memcached.lifetime': query.lifetime,
-        [SEMATTRS_DB_OPERATION]: query.type,
-        [SEMATTRS_DB_STATEMENT]: instrumentation.getConfig()
+        [ATTR_DB_OPERATION]: query.type,
+        [ATTR_DB_STATEMENT]: instrumentation.getConfig()
           .enhancedDatabaseReporting
           ? query.command
           : undefined,

packages/instrumentation-memcached/src/instrumentation.ts

@@ -0,0 +1,86 @@
+/*
+ * 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.operation.name` instead.
+ *
+ * @example findAndModify
+ * @example HMSET
+ * @example SELECT
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ *
+ * @deprecated Replaced by `db.operation.name`.
+ */
+export const ATTR_DB_OPERATION = 'db.operation' 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 "memcached" for attribute {@link ATTR_DB_SYSTEM}.
+ *
+ * Memcached
+ *
+ * @experimental This enum value is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ */
+export const DB_SYSTEM_VALUE_MEMCACHED = 'memcached' as const;

packages/instrumentation-memcached/src/semconv.ts

@@ -15,10 +15,7 @@
  */
 
 import type * as Memcached from 'memcached';
-import {
-  SEMATTRS_NET_PEER_NAME,
-  SEMATTRS_NET_PEER_PORT,
-} from '@opentelemetry/semantic-conventions';
+import { ATTR_NET_PEER_NAME, ATTR_NET_PEER_PORT } from './semconv';
 
 export const getPeerAttributes = (
   client: any /* Memcached, but the type definitions are lacking */,
@@ -52,12 +49,12 @@ export const getPeerAttributes = (
       const portNumber = parseInt(port, 10);
       if (!isNaN(portNumber)) {
         return {
-          [SEMATTRS_NET_PEER_NAME]: host,
-          [SEMATTRS_NET_PEER_PORT]: portNumber,
+          [ATTR_NET_PEER_NAME]: host,
+          [ATTR_NET_PEER_PORT]: portNumber,
         };
       }
       return {
-        [SEMATTRS_NET_PEER_NAME]: host,
+        [ATTR_NET_PEER_NAME]: host,
       };
     }
   }

packages/instrumentation-memcached/src/utils.ts

@@ -30,13 +30,13 @@ import {
 import type * as Memcached from 'memcached';
 import * as assert from 'assert';
 import { MemcachedInstrumentation } from '../src';
+import { ATTR_EXCEPTION_MESSAGE } from '@opentelemetry/semantic-conventions';
 import {
-  DBSYSTEMVALUES_MEMCACHED,
-  SEMATTRS_DB_SYSTEM,
-  SEMATTRS_EXCEPTION_MESSAGE,
-  SEMATTRS_NET_PEER_NAME,
-  SEMATTRS_NET_PEER_PORT,
-} from '@opentelemetry/semantic-conventions';
+  DB_SYSTEM_VALUE_MEMCACHED,
+  ATTR_DB_SYSTEM,
+  ATTR_NET_PEER_NAME,
+  ATTR_NET_PEER_PORT,
+} from '../src/semconv';
 import * as util from 'util';
 
 const instrumentation = new MemcachedInstrumentation();
@@ -50,9 +50,9 @@ const CONFIG = {
 };
 
 const DEFAULT_ATTRIBUTES: Attributes = {
-  [SEMATTRS_DB_SYSTEM]: DBSYSTEMVALUES_MEMCACHED,
-  [SEMATTRS_NET_PEER_NAME]: CONFIG.host,
-  [SEMATTRS_NET_PEER_PORT]: CONFIG.port,
+  [ATTR_DB_SYSTEM]: DB_SYSTEM_VALUE_MEMCACHED,
+  [ATTR_NET_PEER_NAME]: CONFIG.host,
+  [ATTR_NET_PEER_PORT]: CONFIG.port,
 };
 
 interface ExtendedMemcached extends Memcached {
@@ -170,7 +170,7 @@ describe('[email protected]', () => {
 
           assertMatch(
             instrumentationSpans?.[0]?.events[0]?.attributes?.[
-              SEMATTRS_EXCEPTION_MESSAGE
+              ATTR_EXCEPTION_MESSAGE
             ] as 'string',
             /not stored/
           );