Merge branch 'main' into gcp-resource-detector-unit-test

Author: david-luna

detectors/node/opentelemetry-resource-detector-instana/README.md

@@ -38,7 +38,7 @@ sdk.start()
 
 ## Available detectors
 
-This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which implements Semantic Convention [Version 1.7.0](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.7.0/semantic_conventions/README.md)
+This package implements Semantic Convention v1.33.1.
 
 ### Instana Agent Detector
 

detectors/node/opentelemetry-resource-detector-instana/package.json

@@ -53,8 +53,7 @@
   },
   "dependencies": {
     "@opentelemetry/core": "^2.0.0",
-    "@opentelemetry/resources": "^2.0.0",
-    "@opentelemetry/semantic-conventions": "^1.27.0"
+    "@opentelemetry/resources": "^2.0.0"
   },
   "peerDependencies": {
     "@opentelemetry/api": "^1.3.0"

detectors/node/opentelemetry-resource-detector-instana/src/detectors/InstanaAgentDetector.ts

@@ -21,10 +21,7 @@ import {
   DetectedResource,
   DetectedResourceAttributes,
 } from '@opentelemetry/resources';
-import {
-  SEMRESATTRS_PROCESS_PID,
-  SEMRESATTRS_SERVICE_INSTANCE_ID,
-} from '@opentelemetry/semantic-conventions';
+import { ATTR_PROCESS_PID, ATTR_SERVICE_INSTANCE_ID } from '../semconv';
 import * as http from 'http';
 
 class InstanaAgentDetector implements ResourceDetector {
@@ -36,10 +33,7 @@ class InstanaAgentDetector implements ResourceDetector {
       this._gatherData()
     );
 
-    const attrNames = [
-      SEMRESATTRS_PROCESS_PID,
-      SEMRESATTRS_SERVICE_INSTANCE_ID,
-    ];
+    const attrNames = [ATTR_PROCESS_PID, ATTR_SERVICE_INSTANCE_ID];
 
     const attributes = {} as DetectedResourceAttributes;
     attrNames.forEach(name => {
@@ -61,8 +55,8 @@ class InstanaAgentDetector implements ResourceDetector {
       const data = await this._retryHandler(host, port, 0);
 
       return {
-        [SEMRESATTRS_PROCESS_PID]: data.pid,
-        [SEMRESATTRS_SERVICE_INSTANCE_ID]: data.agentUuid,
+        [ATTR_PROCESS_PID]: data.pid,
+        [ATTR_SERVICE_INSTANCE_ID]: data.agentUuid,
       };
     } catch {
       return {};

detectors/node/opentelemetry-resource-detector-instana/src/semconv.ts

@@ -0,0 +1,66 @@
+/*
+ * 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
+ */
+
+/**
+ * Process identifier (PID).
+ *
+ * @example 1234
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ */
+export const ATTR_PROCESS_PID = 'process.pid' as const;
+
+/**
+ * The string ID of the service instance.
+ *
+ * @example 627cc493-f310-47de-96bd-71410b7dec09
+ *
+ * @note **MUST** be unique for each instance of the same `service.namespace,service.name` pair (in other words
+ * `service.namespace,service.name,service.instance.id` triplet **MUST** be globally unique). The ID helps to
+ * distinguish instances of the same service that exist at the same time (e.g. instances of a horizontally scaled
+ * service).
+ *
+ * Implementations, such as SDKs, are recommended to generate a random Version 1 or Version 4 [RFC
+ * 4122](https://www.ietf.org/rfc/rfc4122.txt) UUID, but are free to use an inherent unique ID as the source of
+ * this value if stability is desirable. In that case, the ID **SHOULD** be used as source of a UUID Version 5 and
+ * **SHOULD** use the following UUID as the namespace: `4d63009a-8d0f-11ee-aad7-4c796ed8e320`.
+ *
+ * UUIDs are typically recommended, as only an opaque value for the purposes of identifying a service instance is
+ * needed. Similar to what can be seen in the man page for the
+ * [`/etc/machine-id`](https://www.freedesktop.org/software/systemd/man/latest/machine-id.html) file, the underlying
+ * data, such as pod name and namespace should be treated as confidential, being the user's choice to expose it
+ * or not via another resource attribute.
+ *
+ * For applications running behind an application server (like unicorn), we do not recommend using one identifier
+ * for all processes participating in the application. Instead, it's recommended each division (e.g. a worker
+ * thread in unicorn) to have its own instance.id.
+ *
+ * It's not recommended for a Collector to set `service.instance.id` if it can't unambiguously determine the
+ * service instance that is generating that telemetry. For instance, creating an UUID based on `pod.name` will
+ * likely be wrong, as the Collector might not know from which container within that pod the telemetry originated.
+ * However, Collectors can set the `service.instance.id` if they can unambiguously determine the service instance
+ * for that telemetry. This is typically the case for scraping receivers, as they know the target address and
+ * port.
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ */
+export const ATTR_SERVICE_INSTANCE_ID = 'service.instance.id' as const;

plugins/node/opentelemetry-instrumentation-connect/README.md

@@ -55,7 +55,7 @@ See [examples/connect](https://github.com/open-telemetry/opentelemetry-js-contri
 
 ## Semantic Conventions
 
-This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which implements Semantic Convention [Version 1.7.0](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.7.0/semantic_conventions/README.md)
+This package implements Semantic Convention v1.33.1.
 
 Attributes collected:
 

plugins/node/opentelemetry-instrumentation-connect/src/instrumentation.ts

@@ -32,7 +32,7 @@ import {
   InstrumentationNodeModuleDefinition,
   isWrapped,
 } from '@opentelemetry/instrumentation';
-import { SEMATTRS_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
+import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
 import {
   replaceCurrentStackRoute,
   addNewStackLayer,
@@ -101,7 +101,7 @@ export class ConnectInstrumentation extends InstrumentationBase {
     const spanName = `${connectTypeName} - ${connectName}`;
     const options: SpanOptions = {
       attributes: {
-        [SEMATTRS_HTTP_ROUTE]: routeName.length > 0 ? routeName : '/',
+        [ATTR_HTTP_ROUTE]: routeName.length > 0 ? routeName : '/',
         [AttributeNames.CONNECT_TYPE]: connectType,
         [AttributeNames.CONNECT_NAME]: connectName,
       },

plugins/node/opentelemetry-instrumentation-connect/test/instrumentation.test.ts

@@ -17,7 +17,7 @@ import * as assert from 'assert';
 
 import { context, trace } from '@opentelemetry/api';
 import { RPCType, setRPCMetadata, RPCMetadata } from '@opentelemetry/core';
-import { SEMATTRS_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
+import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
 import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks';
 import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
 import {
@@ -145,7 +145,7 @@ describe('connect', () => {
       assert.deepStrictEqual(span.attributes, {
         'connect.type': 'middleware',
         'connect.name': ANONYMOUS_NAME,
-        [SEMATTRS_HTTP_ROUTE]: '/',
+        [ATTR_HTTP_ROUTE]: '/',
       });
       assert.strictEqual(span.name, 'middleware - anonymous');
     });
@@ -164,7 +164,7 @@ describe('connect', () => {
       assert.deepStrictEqual(span.attributes, {
         'connect.type': 'middleware',
         'connect.name': 'middleware1',
-        [SEMATTRS_HTTP_ROUTE]: '/',
+        [ATTR_HTTP_ROUTE]: '/',
       });
       assert.strictEqual(span.name, 'middleware - middleware1');
     });
@@ -182,7 +182,7 @@ describe('connect', () => {
       assert.deepStrictEqual(span.attributes, {
         'connect.type': 'request_handler',
         'connect.name': '/foo',
-        [SEMATTRS_HTTP_ROUTE]: '/foo',
+        [ATTR_HTTP_ROUTE]: '/foo',
       });
       assert.strictEqual(span.name, 'request handler - /foo');
     });

plugins/node/opentelemetry-instrumentation-express/src/instrumentation.ts

@@ -41,7 +41,7 @@ import {
   isWrapped,
   safeExecuteInTheMiddle,
 } from '@opentelemetry/instrumentation';
-import { SEMATTRS_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
+import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
 import {
   ExpressLayer,
   ExpressRouter,
@@ -195,7 +195,7 @@ export class ExpressInstrumentation extends InstrumentationBase<ExpressInstrumen
           .replace(/\/{2,}/g, '/');
 
         const attributes: Attributes = {
-          [SEMATTRS_HTTP_ROUTE]: route.length > 0 ? route : '/',
+          [ATTR_HTTP_ROUTE]: route.length > 0 ? route : '/',
         };
         const metadata = getLayerMetadata(route, layer, layerPath);
         const type = metadata.attributes[

plugins/node/opentelemetry-instrumentation-express/test/custom-config.test.ts

@@ -21,7 +21,7 @@ import {
   InMemorySpanExporter,
   SimpleSpanProcessor,
 } from '@opentelemetry/sdk-trace-base';
-import { SEMATTRS_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
+import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
 import * as assert from 'assert';
 import { RPCMetadata, RPCType, setRPCMetadata } from '@opentelemetry/core';
 import { ExpressLayerType } from '../src/enums/ExpressLayerType';
@@ -145,7 +145,7 @@ describe('ExpressInstrumentation', () => {
             .find(span => span.name.includes('request handler'));
           assert.notStrictEqual(requestHandlerSpan, undefined);
           assert.strictEqual(
-            requestHandlerSpan?.attributes[SEMATTRS_HTTP_ROUTE],
+            requestHandlerSpan?.attributes[ATTR_HTTP_ROUTE],
             '/mw'
           );
 
@@ -196,7 +196,7 @@ describe('ExpressInstrumentation', () => {
             .find(span => span.name.includes('request handler'));
           assert.notStrictEqual(requestHandlerSpan, undefined);
           assert.strictEqual(
-            requestHandlerSpan?.attributes[SEMATTRS_HTTP_ROUTE],
+            requestHandlerSpan?.attributes[ATTR_HTTP_ROUTE],
             '/'
           );
 

plugins/node/opentelemetry-instrumentation-express/test/express.test.ts

@@ -26,7 +26,7 @@ import * as semver from 'semver';
 import { AttributeNames } from '../src/enums/AttributeNames';
 import { ExpressInstrumentation } from '../src';
 import { createServer, httpRequest, serverWithMiddleware } from './utils';
-import { SEMATTRS_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
+import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
 import * as testUtils from '@opentelemetry/contrib-test-utils';
 
 const instrumentation = new ExpressInstrumentation();
@@ -119,7 +119,7 @@ describe('ExpressInstrumentation', () => {
             .find(span => span.name.includes('request handler'));
           assert.notStrictEqual(requestHandlerSpan, undefined);
           assert.strictEqual(
-            requestHandlerSpan?.attributes[SEMATTRS_HTTP_ROUTE],
+            requestHandlerSpan?.attributes[ATTR_HTTP_ROUTE],
             '/toto/:id'
           );
           assert.strictEqual(
@@ -486,7 +486,7 @@ describe('ExpressInstrumentation', () => {
             .getFinishedSpans()
             .find(span => span.name.includes('request handler'));
           assert.strictEqual(
-            requestHandlerSpan?.attributes[SEMATTRS_HTTP_ROUTE],
+            requestHandlerSpan?.attributes[ATTR_HTTP_ROUTE],
             '/double-slashes/:id'
           );
           assert.strictEqual(rpcMetadata?.route, '/double-slashes/:id');

plugins/node/opentelemetry-instrumentation-express/test/hooks.test.ts

@@ -27,7 +27,7 @@ import * as sinon from 'sinon';
 import { ExpressInstrumentation } from '../src';
 import { ExpressRequestInfo, SpanNameHook } from '../src/types';
 import { ExpressLayerType } from '../src/enums/ExpressLayerType';
-import { SEMATTRS_HTTP_METHOD } from '@opentelemetry/semantic-conventions';
+import { ATTR_HTTP_REQUEST_METHOD } from '@opentelemetry/semantic-conventions';
 
 const instrumentation = new ExpressInstrumentation();
 instrumentation.enable();
@@ -179,7 +179,7 @@ describe('ExpressInstrumentation hooks', () => {
 
     it('should call requestHook when set in config', async () => {
       const requestHook = sinon.spy((span: Span, info: ExpressRequestInfo) => {
-        span.setAttribute(SEMATTRS_HTTP_METHOD, info.request.method);
+        span.setAttribute(ATTR_HTTP_REQUEST_METHOD, info.request.method);
 
         if (info.layerType) {
           span.setAttribute('express.layer_type', info.layerType);
@@ -204,7 +204,7 @@ describe('ExpressInstrumentation hooks', () => {
           assert.strictEqual(spans.length, 2);
           sinon.assert.calledOnce(requestHook);
           assert.strictEqual(
-            requestHandlerSpan?.attributes['http.method'],
+            requestHandlerSpan?.attributes['http.request.method'],
             'GET'
           );
           assert.strictEqual(

plugins/node/opentelemetry-instrumentation-fastify/src/instrumentation.ts

@@ -21,7 +21,7 @@ import {
   InstrumentationNodeModuleDefinition,
   safeExecuteInTheMiddle,
 } from '@opentelemetry/instrumentation';
-import { SEMATTRS_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
+import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
 import type {
   HookHandlerDoneFunction,
   FastifyInstance,
@@ -269,7 +269,7 @@ export class FastifyInstrumentation extends InstrumentationBase<FastifyInstrumen
       const spanAttributes: Attributes = {
         [AttributeNames.PLUGIN_NAME]: this.pluginName,
         [AttributeNames.FASTIFY_TYPE]: FastifyTypes.REQUEST_HANDLER,
-        [SEMATTRS_HTTP_ROUTE]: anyRequest.routeOptions
+        [ATTR_HTTP_ROUTE]: anyRequest.routeOptions
           ? anyRequest.routeOptions.url // since fastify@4.10.0
           : request.routerPath,
       };

plugins/node/opentelemetry-instrumentation-fastify/test/instrumentation.test.ts

@@ -16,10 +16,7 @@
 
 import * as assert from 'assert';
 import { context, SpanStatusCode } from '@opentelemetry/api';
-import {
-  SEMATTRS_HTTP_ROUTE,
-  SEMATTRS_HTTP_METHOD,
-} from '@opentelemetry/semantic-conventions';
+import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
 import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks';
 import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
 import {
@@ -161,7 +158,7 @@ describe('fastify', () => {
       assert.deepStrictEqual(span.attributes, {
         'fastify.type': 'request_handler',
         'plugin.name': 'fastify -> @fastify/express',
-        [SEMATTRS_HTTP_ROUTE]: '/test',
+        [ATTR_HTTP_ROUTE]: '/test',
       });
       assert.strictEqual(
         span.name,
@@ -190,7 +187,7 @@ describe('fastify', () => {
         'fastify.type': 'request_handler',
         'fastify.name': 'namedHandler',
         'plugin.name': 'fastify -> @fastify/express',
-        [SEMATTRS_HTTP_ROUTE]: '/test',
+        [ATTR_HTTP_ROUTE]: '/test',
       });
       assert.strictEqual(span.name, 'request handler - namedHandler');
 
@@ -502,7 +499,7 @@ describe('fastify', () => {
     describe('using requestHook in config', () => {
       it('calls requestHook provided function when set in config', async () => {
         const requestHook = (span: Span, info: FastifyRequestInfo) => {
-          span.setAttribute(SEMATTRS_HTTP_METHOD, info.request.method);
+          span.setAttribute('my.http.method', info.request.method);
         };
 
         instrumentation.setConfig({
@@ -523,14 +520,14 @@ describe('fastify', () => {
         assert.deepStrictEqual(span.attributes, {
           'fastify.type': 'request_handler',
           'plugin.name': 'fastify -> @fastify/express',
-          [SEMATTRS_HTTP_ROUTE]: '/test',
-          [SEMATTRS_HTTP_METHOD]: 'GET',
+          [ATTR_HTTP_ROUTE]: '/test',
+          'my.http.method': 'GET',
         });
       });
 
       it('does not propagate an error from a requestHook that throws exception', async () => {
         const requestHook = (span: Span, info: FastifyRequestInfo) => {
-          span.setAttribute(SEMATTRS_HTTP_METHOD, info.request.method);
+          span.setAttribute('my.http.method', info.request.method);
 
           throw Error('error thrown in requestHook');
         };
@@ -553,8 +550,8 @@ describe('fastify', () => {
         assert.deepStrictEqual(span.attributes, {
           'fastify.type': 'request_handler',
           'plugin.name': 'fastify -> @fastify/express',
-          [SEMATTRS_HTTP_ROUTE]: '/test',
-          [SEMATTRS_HTTP_METHOD]: 'GET',
+          [ATTR_HTTP_ROUTE]: '/test',
+          'my.http.method': 'GET',
         });
       });
     });

plugins/node/opentelemetry-instrumentation-restify/src/instrumentation.ts

@@ -31,7 +31,7 @@ import {
   isWrapped,
   safeExecuteInTheMiddle,
 } from '@opentelemetry/instrumentation';
-import { SEMATTRS_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
+import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
 import { isPromise, isAsyncFunction } from './utils';
 import { getRPCMetadata, RPCType } from '@opentelemetry/core';
 import type { RestifyInstrumentationConfig } from './types';
@@ -172,7 +172,7 @@ export class RestifyInstrumentation extends InstrumentationBase<RestifyInstrumen
           [AttributeNames.VERSION]: this._moduleVersion || 'n/a',
           [AttributeNames.TYPE]: metadata.type,
           [AttributeNames.METHOD]: metadata.methodName,
-          [SEMATTRS_HTTP_ROUTE]: route,
+          [ATTR_HTTP_ROUTE]: route,
         };
         const span = this.tracer.startSpan(
           spanName,