Merge branch 'main' into trentm-semconv-up-instr-socket.io

Author: maryliag

package-lock.json

@@ -75,8 +75,7 @@
   "dependencies": {
     "@opentelemetry/core": "^2.0.0",
     "@opentelemetry/instrumentation": "^0.205.0",
-    "@opentelemetry/sdk-trace-web": "^2.0.0",
-    "@opentelemetry/semantic-conventions": "^1.27.0"
+    "@opentelemetry/sdk-trace-web": "^2.0.0"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-document-load#readme"
 }

packages/instrumentation-document-load/package.json

@@ -41,10 +41,7 @@ import {
 import { AttributeNames } from './enums/AttributeNames';
 /** @knipignore */
 import { PACKAGE_NAME, PACKAGE_VERSION } from './version';
-import {
-  SEMATTRS_HTTP_URL,
-  SEMATTRS_HTTP_USER_AGENT,
-} from '@opentelemetry/semantic-conventions';
+import { ATTR_HTTP_URL, ATTR_HTTP_USER_AGENT } from './semconv';
 import {
   addSpanPerformancePaintEvents,
   getPerformanceNavigationEntries,
@@ -115,7 +112,7 @@ export class DocumentLoadInstrumentation extends InstrumentationBase<DocumentLoa
           entries
         );
         if (fetchSpan) {
-          fetchSpan.setAttribute(SEMATTRS_HTTP_URL, location.href);
+          fetchSpan.setAttribute(ATTR_HTTP_URL, location.href);
           context.with(trace.setSpan(context.active(), fetchSpan), () => {
             addSpanNetworkEvents(
               fetchSpan,
@@ -131,8 +128,8 @@ export class DocumentLoadInstrumentation extends InstrumentationBase<DocumentLoa
         }
       });
 
-      rootSpan.setAttribute(SEMATTRS_HTTP_URL, location.href);
-      rootSpan.setAttribute(SEMATTRS_HTTP_USER_AGENT, navigator.userAgent);
+      rootSpan.setAttribute(ATTR_HTTP_URL, location.href);
+      rootSpan.setAttribute(ATTR_HTTP_USER_AGENT, navigator.userAgent);
 
       this._addResourcesSpans(rootSpan);
 
@@ -206,7 +203,7 @@ export class DocumentLoadInstrumentation extends InstrumentationBase<DocumentLoa
       parentSpan
     );
     if (span) {
-      span.setAttribute(SEMATTRS_HTTP_URL, resource.name);
+      span.setAttribute(ATTR_HTTP_URL, resource.name);
       addSpanNetworkEvents(
         span,
         resource,

packages/instrumentation-document-load/src/instrumentation.ts

@@ -0,0 +1,56 @@
+/*
+ * 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 `http.response.header.content-length` instead.
+ *
+ * @example 3495
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ *
+ * @deprecated Replaced by `http.response.header.content-length`.
+ */
+export const ATTR_HTTP_RESPONSE_CONTENT_LENGTH =
+  'http.response_content_length' as const;
+
+/**
+ * Deprecated, use `url.full` instead.
+ *
+ * @example https://www.foo.bar/search?q=OpenTelemetry#SemConv
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ *
+ * @deprecated Replaced by `url.full`.
+ */
+export const ATTR_HTTP_URL = 'http.url' as const;
+
+/**
+ * Deprecated, use `user_agent.original` instead.
+ *
+ * @example CERN-LineMode/2.15 libwww/2.17b3
+ * @example Mozilla/5.0 (iPhone; CPU iPhone OS 14_7_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Mobile/15E148 Safari/604.1
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ *
+ * @deprecated Replaced by `user_agent.original`.
+ */
+export const ATTR_HTTP_USER_AGENT = 'http.user_agent' as const;

packages/instrumentation-document-load/src/semconv.ts

@@ -41,9 +41,9 @@ import chai from 'chai/chai.js';
 import * as sinon from 'sinon';
 import { DocumentLoadInstrumentation } from '../src';
 import {
-  SEMATTRS_HTTP_RESPONSE_CONTENT_LENGTH,
-  SEMATTRS_HTTP_URL,
-} from '@opentelemetry/semantic-conventions';
+  ATTR_HTTP_RESPONSE_CONTENT_LENGTH,
+  ATTR_HTTP_URL,
+} from '../src/semconv';
 import { EventNames } from '../src/enums/EventNames';
 
 const assert = chai.assert;
@@ -357,9 +357,7 @@ describe('DocumentLoad Instrumentation', () => {
 
         assert.strictEqual(rootSpan.name, 'documentFetch');
         assert.ok(
-          (rootSpan.attributes[
-            SEMATTRS_HTTP_RESPONSE_CONTENT_LENGTH
-          ] as number) > 0
+          (rootSpan.attributes[ATTR_HTTP_RESPONSE_CONTENT_LENGTH] as number) > 0
         );
         assert.strictEqual(fetchSpan.name, 'documentLoad');
         ensureNetworkEventsExists(rsEvents);
@@ -459,11 +457,11 @@ describe('DocumentLoad Instrumentation', () => {
         const srEvents2 = spanResource2.events;
 
         assert.strictEqual(
-          spanResource1.attributes[SEMATTRS_HTTP_URL],
+          spanResource1.attributes[ATTR_HTTP_URL],
           'http://localhost:8090/bundle.js'
         );
         assert.strictEqual(
-          spanResource2.attributes[SEMATTRS_HTTP_URL],
+          spanResource2.attributes[ATTR_HTTP_URL],
           'http://localhost:8090/sockjs-node/info?t=1572620894466'
         );
 
@@ -495,7 +493,7 @@ describe('DocumentLoad Instrumentation', () => {
         const srEvents1 = spanResource1.events;
 
         assert.strictEqual(
-          spanResource1.attributes[SEMATTRS_HTTP_URL],
+          spanResource1.attributes[ATTR_HTTP_URL],
           'http://localhost:8090/bundle.js'
         );
 
@@ -847,7 +845,7 @@ describe('DocumentLoad Instrumentation', () => {
         ) as ReadableSpan;
         assert.isOk(resourceSpan, 'resourceFetch span should exist');
         assert.exists(
-          resourceSpan.attributes[SEMATTRS_HTTP_RESPONSE_CONTENT_LENGTH],
+          resourceSpan.attributes[ATTR_HTTP_RESPONSE_CONTENT_LENGTH],
           'http.response_content_length attribute should exist'
         );
         done();

packages/instrumentation-document-load/test/documentLoad.test.ts

@@ -36,16 +36,18 @@ import {
   ATTR_DB_SYSTEM_NAME,
   ATTR_SERVER_ADDRESS,
   ATTR_SERVER_PORT,
-  SEMATTRS_DB_NAME,
-  SEMATTRS_DB_OPERATION,
-  SEMATTRS_DB_SQL_TABLE,
-  SEMATTRS_DB_STATEMENT,
-  SEMATTRS_DB_SYSTEM,
-  SEMATTRS_DB_USER,
-  SEMATTRS_NET_PEER_NAME,
-  SEMATTRS_NET_PEER_PORT,
-  SEMATTRS_NET_TRANSPORT,
 } from '@opentelemetry/semantic-conventions';
+import {
+  ATTR_DB_NAME,
+  ATTR_DB_OPERATION,
+  ATTR_DB_SQL_TABLE,
+  ATTR_DB_STATEMENT,
+  ATTR_DB_SYSTEM,
+  ATTR_DB_USER,
+  ATTR_NET_PEER_NAME,
+  ATTR_NET_PEER_PORT,
+  ATTR_NET_TRANSPORT,
+} from './semconv';
 
 const contextSymbol = Symbol('opentelemetry.instrumentation-knex.context');
 const DEFAULT_CONFIG: KnexInstrumentationConfig = {
@@ -159,14 +161,14 @@ export class KnexInstrumentation extends InstrumentationBase<KnexInstrumentation
 
         if (instrumentation._semconvStability & SemconvStability.OLD) {
           Object.assign(attributes, {
-            [SEMATTRS_DB_SYSTEM]: utils.mapSystem(config.client),
-            [SEMATTRS_DB_SQL_TABLE]: table,
-            [SEMATTRS_DB_OPERATION]: operation,
-            [SEMATTRS_DB_USER]: config?.connection?.user,
-            [SEMATTRS_DB_NAME]: name,
-            [SEMATTRS_NET_PEER_NAME]: config?.connection?.host,
-            [SEMATTRS_NET_PEER_PORT]: config?.connection?.port,
-            [SEMATTRS_NET_TRANSPORT]: transport,
+            [ATTR_DB_SYSTEM]: utils.mapSystem(config.client),
+            [ATTR_DB_SQL_TABLE]: table,
+            [ATTR_DB_OPERATION]: operation,
+            [ATTR_DB_USER]: config?.connection?.user,
+            [ATTR_DB_NAME]: name,
+            [ATTR_NET_PEER_NAME]: config?.connection?.host,
+            [ATTR_NET_PEER_PORT]: config?.connection?.port,
+            [ATTR_NET_TRANSPORT]: transport,
           });
         }
         if (instrumentation._semconvStability & SemconvStability.STABLE) {
@@ -186,7 +188,7 @@ export class KnexInstrumentation extends InstrumentationBase<KnexInstrumentation
             attributes[ATTR_DB_QUERY_TEXT] = queryText;
           }
           if (instrumentation._semconvStability & SemconvStability.OLD) {
-            attributes[SEMATTRS_DB_STATEMENT] = queryText;
+            attributes[ATTR_DB_STATEMENT] = queryText;
           }
         }
 

packages/instrumentation-knex/src/instrumentation.ts

@@ -20,7 +20,111 @@
  * @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;
+
+/**
+ * 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;
+
+/**
+ * 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`, but only if not extracting the value from `db.query.text`.
+ */
+export const ATTR_DB_SQL_TABLE = 'db.sql.table' 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;
+
+/**
+ * Deprecated, use `network.transport`.
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ *
+ * @deprecated Replaced by `network.transport`.
+ */
+export const ATTR_NET_TRANSPORT = 'net.transport' as const;
+
 /**
  * Enum value "sqlite" for attribute {@link ATTR_DB_SYSTEM_NAME}.
+ *
+ * [SQLite](https://www.sqlite.org/)
+ *
+ * @experimental This enum value is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
  */
 export const DB_SYSTEM_NAME_VALUE_SQLITE = 'sqlite' as const;

packages/instrumentation-knex/src/semconv.ts

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