chore(instrumentation-mongoose): update semconv usage to ATTR_ exports (#3062)

Refs: #2377

Author: trentm

packages/instrumentation-mongoose/package.json

@@ -69,8 +69,7 @@
   },
   "dependencies": {
     "@opentelemetry/core": "^2.0.0",
-    "@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-mongoose#readme"
 }

packages/instrumentation-mongoose/src/mongoose.ts

@@ -30,10 +30,10 @@ import {
 /** @knipignore */
 import { PACKAGE_NAME, PACKAGE_VERSION } from './version';
 import {
-  SEMATTRS_DB_OPERATION,
-  SEMATTRS_DB_STATEMENT,
-  SEMATTRS_DB_SYSTEM,
-} from '@opentelemetry/semantic-conventions';
+  ATTR_DB_OPERATION,
+  ATTR_DB_STATEMENT,
+  ATTR_DB_SYSTEM,
+} from './semconv';
 
 const contextCaptureFunctionsCommon = [
   'deleteOne',
@@ -210,13 +210,10 @@ export class MongooseInstrumentation extends InstrumentationBase<MongooseInstrum
         const attributes: Attributes = {};
         const { dbStatementSerializer } = self.getConfig();
         if (dbStatementSerializer) {
-          attributes[SEMATTRS_DB_STATEMENT] = dbStatementSerializer(
-            'aggregate',
-            {
-              options: this.options,
-              aggregatePipeline: this._pipeline,
-            }
-          );
+          attributes[ATTR_DB_STATEMENT] = dbStatementSerializer('aggregate', {
+            options: this.options,
+            aggregatePipeline: this._pipeline,
+          });
         }
 
         const span = self._startSpan(
@@ -254,7 +251,7 @@ export class MongooseInstrumentation extends InstrumentationBase<MongooseInstrum
         const attributes: Attributes = {};
         const { dbStatementSerializer } = self.getConfig();
         if (dbStatementSerializer) {
-          attributes[SEMATTRS_DB_STATEMENT] = dbStatementSerializer(this.op, {
+          attributes[ATTR_DB_STATEMENT] = dbStatementSerializer(this.op, {
             condition: this._conditions,
             updates: this._update,
             options: this.options,
@@ -299,7 +296,7 @@ export class MongooseInstrumentation extends InstrumentationBase<MongooseInstrum
         const attributes: Attributes = {};
         const { dbStatementSerializer } = self.getConfig();
         if (dbStatementSerializer) {
-          attributes[SEMATTRS_DB_STATEMENT] = dbStatementSerializer(
+          attributes[ATTR_DB_STATEMENT] = dbStatementSerializer(
             op,
             serializePayload
           );
@@ -367,7 +364,7 @@ export class MongooseInstrumentation extends InstrumentationBase<MongooseInstrum
         const attributes: Attributes = {};
         const { dbStatementSerializer } = self.getConfig();
         if (dbStatementSerializer) {
-          attributes[SEMATTRS_DB_STATEMENT] = dbStatementSerializer(
+          attributes[ATTR_DB_STATEMENT] = dbStatementSerializer(
             op,
             serializePayload
           );
@@ -436,8 +433,8 @@ export class MongooseInstrumentation extends InstrumentationBase<MongooseInstrum
         attributes: {
           ...attributes,
           ...getAttributesFromCollection(collection),
-          [SEMATTRS_DB_OPERATION]: operation,
-          [SEMATTRS_DB_SYSTEM]: 'mongoose',
+          [ATTR_DB_OPERATION]: operation,
+          [ATTR_DB_SYSTEM]: 'mongoose',
         },
       },
       parentSpan ? trace.setSpan(context.active(), parentSpan) : undefined

packages/instrumentation-mongoose/src/semconv.ts

@@ -0,0 +1,112 @@
+/*
+ * 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.collection.name` instead.
+ *
+ * @example "mytable"
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ *
+ * @deprecated Replaced by `db.collection.name`.
+ */
+export const ATTR_DB_MONGODB_COLLECTION = 'db.mongodb.collection' 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;
+
+/**
+ * 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, 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;

packages/instrumentation-mongoose/src/utils.ts

@@ -18,22 +18,22 @@ import type { Collection } from 'mongoose';
 import { MongooseResponseCustomAttributesFunction } from './types';
 import { safeExecuteInTheMiddle } from '@opentelemetry/instrumentation';
 import {
-  SEMATTRS_DB_MONGODB_COLLECTION,
-  SEMATTRS_DB_NAME,
-  SEMATTRS_DB_USER,
-  SEMATTRS_NET_PEER_NAME,
-  SEMATTRS_NET_PEER_PORT,
-} from '@opentelemetry/semantic-conventions';
+  ATTR_DB_MONGODB_COLLECTION,
+  ATTR_DB_NAME,
+  ATTR_DB_USER,
+  ATTR_NET_PEER_NAME,
+  ATTR_NET_PEER_PORT,
+} from './semconv';
 
 export function getAttributesFromCollection(
   collection: Collection
 ): Attributes {
   return {
-    [SEMATTRS_DB_MONGODB_COLLECTION]: collection.name,
-    [SEMATTRS_DB_NAME]: collection.conn.name,
-    [SEMATTRS_DB_USER]: collection.conn.user,
-    [SEMATTRS_NET_PEER_NAME]: collection.conn.host,
-    [SEMATTRS_NET_PEER_PORT]: collection.conn.port,
+    [ATTR_DB_MONGODB_COLLECTION]: collection.name,
+    [ATTR_DB_NAME]: collection.conn.name,
+    [ATTR_DB_USER]: collection.conn.user,
+    [ATTR_NET_PEER_NAME]: collection.conn.host,
+    [ATTR_NET_PEER_PORT]: collection.conn.port,
   };
 }
 

packages/instrumentation-mongoose/test/asserts.ts

@@ -16,28 +16,28 @@
 import { expect } from 'expect';
 import { ReadableSpan } from '@opentelemetry/sdk-trace-base';
 import {
-  SEMATTRS_DB_MONGODB_COLLECTION,
-  SEMATTRS_DB_NAME,
-  SEMATTRS_DB_STATEMENT,
-  SEMATTRS_DB_SYSTEM,
-  SEMATTRS_NET_PEER_NAME,
-  SEMATTRS_NET_PEER_PORT,
-} from '@opentelemetry/semantic-conventions';
+  ATTR_DB_MONGODB_COLLECTION,
+  ATTR_DB_NAME,
+  ATTR_DB_STATEMENT,
+  ATTR_DB_SYSTEM,
+  ATTR_NET_PEER_NAME,
+  ATTR_NET_PEER_PORT,
+} from '../src/semconv';
 import { SpanStatusCode } from '@opentelemetry/api';
 import { SerializerPayload } from '../src';
 import { DB_NAME, MONGO_HOST, MONGO_PORT } from './config';
 import User from './user';
 
 export const assertSpan = (span: ReadableSpan) => {
   expect(span.status.code).toBe(SpanStatusCode.UNSET);
-  expect(span.attributes[SEMATTRS_DB_SYSTEM]).toEqual('mongoose');
-  expect(span.attributes[SEMATTRS_DB_MONGODB_COLLECTION]).toEqual(
+  expect(span.attributes[ATTR_DB_SYSTEM]).toEqual('mongoose');
+  expect(span.attributes[ATTR_DB_MONGODB_COLLECTION]).toEqual(
     User.collection.name
   );
-  expect(span.attributes[SEMATTRS_DB_NAME]).toEqual(DB_NAME);
-  expect(span.attributes[SEMATTRS_NET_PEER_NAME]).toEqual(MONGO_HOST);
-  expect(span.attributes[SEMATTRS_NET_PEER_PORT]).toEqual(MONGO_PORT);
+  expect(span.attributes[ATTR_DB_NAME]).toEqual(DB_NAME);
+  expect(span.attributes[ATTR_NET_PEER_NAME]).toEqual(MONGO_HOST);
+  expect(span.attributes[ATTR_NET_PEER_PORT]).toEqual(MONGO_PORT);
 };
 
 export const getStatement = (span: ReadableSpan): SerializerPayload =>
-  JSON.parse(span.attributes[SEMATTRS_DB_STATEMENT] as string);
+  JSON.parse(span.attributes[ATTR_DB_STATEMENT] as string);