Merge remote-tracking branch 'upstream/main' into redis-tracer-provider

Author: blumamir

detectors/node/opentelemetry-resource-detector-gcp/test/detectors/GcpDetector.test.ts

@@ -176,6 +176,46 @@ describe('gcpDetector', () => {
       });
     });
 
+    it('should return resource and undefined for non-available kubernetes attributes', async () => {
+      process.env.KUBERNETES_SERVICE_HOST = 'my-host';
+      process.env.HOSTNAME = 'my-hostname';
+      process.env.CONTAINER_NAME = 'my-container-name';
+      const scope = nock(HOST_ADDRESS)
+        .get(INSTANCE_PATH)
+        .reply(200, {}, HEADERS)
+        .get(INSTANCE_ID_PATH)
+        .reply(200, () => '4520031799277581759', HEADERS)
+        .get(CLUSTER_NAME_PATH)
+        .reply(200, () => 'my-cluster', HEADERS)
+        .get(PROJECT_ID_PATH)
+        .reply(200, () => 'my-project-id', HEADERS)
+        .get(ZONE_PATH)
+        .reply(200, () => 'project/zone/my-zone', HEADERS)
+        .get(HOSTNAME_PATH)
+        .reply(200, () => 'dev.my-project.local', HEADERS);
+      const secondaryScope = nock(SECONDARY_HOST_ADDRESS)
+        .get(INSTANCE_PATH)
+        .reply(200, {}, HEADERS);
+
+      const resource = detectResources({ detectors: [gcpDetector] });
+      await resource.waitForAsyncAttributes?.();
+
+      secondaryScope.done();
+      scope.done();
+
+      assertCloudResource(resource, {
+        provider: 'gcp',
+        accountId: 'my-project-id',
+        zone: 'my-zone',
+      });
+      assertK8sResource(resource, {
+        clusterName: 'my-cluster',
+        podName: 'my-hostname',
+        namespaceName: undefined,
+      });
+      assertContainerResource(resource, { name: 'my-container-name' });
+    });
+
     it('returns empty resource if not detected', async () => {
       const resource = detectResources({ detectors: [gcpDetector] });
       await resource.waitForAsyncAttributes?.();

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-aws-sdk/README.md

@@ -65,7 +65,7 @@ The instrumentations are collecting the following attributes:
 | `rpc.system` | string | Always equals "aws-api" | |
 | `rpc.method` | string | he name of the operation corresponding to the request, as returned by the AWS SDK. If the SDK does not provide a way to retrieve a name, the name of the command SHOULD be used, removing the suffix `Command` if present, resulting in a PascalCase name with no spaces. | `PutObject` |
 | `rpc.service` | string | The name of the service to which a request is made, as returned by the AWS SDK. If the SDK does not provide a away to retrieve a name, the name of the SDK's client interface for a service SHOULD be used, removing the suffix `Client` if present, resulting in a PascalCase name with no spaces. | `S3`, `DynamoDB`, `Route53` |
-| `aws.region` | string | Region name for the request | "eu-west-1" |
+| `cloud.region` | string | Region name for the request | "eu-west-1" |
 
 ### Custom User Attributes
 
@@ -112,6 +112,7 @@ Attributes collected:
 | `rpc.method`                                  | The name of the (logical) method being called.                                                 |          |
 | `rpc.service`                                 | The full (logical) name of the service being called.                                           |          |
 | `rpc.system`                                  | A string identifying the remoting system.                                                      |          |
+| `cloud.region`                                | The AWS Region where the requested service is being accessed.                                  |          |
 | `aws.dynamodb.attribute_definitions`          | The JSON-serialized value of each item in the `AttributeDefinitions` request field.            | dynamodb |
 | `aws.dynamodb.consistent_read`                | The value of the `ConsistentRead` request parameter.                                           | dynamodb |
 | `aws.dynamodb.consumed_capacity`              | The JSON-serialized value of each item in the `ConsumedCapacity` response field.               | dynamodb |

plugins/node/opentelemetry-instrumentation-aws-sdk/src/aws-sdk.ts

@@ -350,7 +350,7 @@ export class AwsInstrumentation extends InstrumentationBase<AwsSdkInstrumentatio
           Promise.resolve(regionPromise)
             .then(resolvedRegion => {
               normalizedRequest.region = resolvedRegion;
-              span.setAttribute(AttributeNames.AWS_REGION, resolvedRegion);
+              span.setAttribute(AttributeNames.CLOUD_REGION, resolvedRegion);
             })
             .catch(e => {
               // there is nothing much we can do in this case.

plugins/node/opentelemetry-instrumentation-aws-sdk/src/enums.ts

@@ -15,7 +15,7 @@
  */
 export enum AttributeNames {
   AWS_OPERATION = 'aws.operation',
-  AWS_REGION = 'aws.region',
+  CLOUD_REGION = 'cloud.region',
   AWS_SERVICE_API = 'aws.service.api',
   AWS_SERVICE_NAME = 'aws.service.name',
   AWS_SERVICE_IDENTIFIER = 'aws.service.identifier',

plugins/node/opentelemetry-instrumentation-aws-sdk/src/utils.ts

@@ -56,7 +56,7 @@ export const extractAttributesFromNormalizedRequest = (
     [SEMATTRS_RPC_SYSTEM]: 'aws-api',
     [SEMATTRS_RPC_METHOD]: normalizedRequest.commandName,
     [SEMATTRS_RPC_SERVICE]: normalizedRequest.serviceName,
-    [AttributeNames.AWS_REGION]: normalizedRequest.region,
+    [AttributeNames.CLOUD_REGION]: normalizedRequest.region,
   };
 };
 

plugins/node/opentelemetry-instrumentation-aws-sdk/test/aws-sdk-v3-s3.test.ts

@@ -73,7 +73,7 @@ describe('instrumentation-aws-sdk-v3 (client-s3)', () => {
       expect(span.attributes[AttributeNames.AWS_S3_BUCKET]).toEqual(
         'ot-demo-test'
       );
-      expect(span.attributes[AttributeNames.AWS_REGION]).toEqual(region);
+      expect(span.attributes[AttributeNames.CLOUD_REGION]).toEqual(region);
       expect(span.name).toEqual('S3.PutObject');
       expect(span.kind).toEqual(SpanKind.CLIENT);
       expect(span.attributes[SEMATTRS_HTTP_STATUS_CODE]).toEqual(200);
@@ -100,7 +100,7 @@ describe('instrumentation-aws-sdk-v3 (client-s3)', () => {
         expect(span.attributes[AttributeNames.AWS_S3_BUCKET]).toEqual(
           'ot-demo-test'
         );
-        expect(span.attributes[AttributeNames.AWS_REGION]).toEqual(region);
+        expect(span.attributes[AttributeNames.CLOUD_REGION]).toEqual(region);
         expect(span.name).toEqual('S3.PutObject');
         expect(span.attributes[SEMATTRS_HTTP_STATUS_CODE]).toEqual(200);
         done();
@@ -129,7 +129,7 @@ describe('instrumentation-aws-sdk-v3 (client-s3)', () => {
       expect(span.attributes[AttributeNames.AWS_S3_BUCKET]).toEqual(
         'ot-demo-test'
       );
-      expect(span.attributes[AttributeNames.AWS_REGION]).toEqual(region);
+      expect(span.attributes[AttributeNames.CLOUD_REGION]).toEqual(region);
       expect(span.name).toEqual('S3.PutObject');
       expect(span.attributes[SEMATTRS_HTTP_STATUS_CODE]).toEqual(200);
     });
@@ -166,7 +166,7 @@ describe('instrumentation-aws-sdk-v3 (client-s3)', () => {
           'invalid-bucket-name'
         );
         expect(span.attributes[SEMATTRS_HTTP_STATUS_CODE]).toEqual(403);
-        expect(span.attributes[AttributeNames.AWS_REGION]).toEqual(region);
+        expect(span.attributes[AttributeNames.CLOUD_REGION]).toEqual(region);
         expect(span.attributes[AttributeNames.AWS_REQUEST_ID]).toEqual(
           'MS95GTS7KXQ34X2S'
         );

plugins/node/opentelemetry-instrumentation-aws-sdk/test/aws-sdk-v3-sqs.test.ts

@@ -84,7 +84,7 @@ describe('instrumentation-aws-sdk-v3 (client-sqs)', () => {
     expect(span.attributes[SEMATTRS_RPC_SYSTEM]).toEqual('aws-api');
     expect(span.attributes[SEMATTRS_RPC_METHOD]).toEqual('SendMessage');
     expect(span.attributes[SEMATTRS_RPC_SERVICE]).toEqual('SQS');
-    expect(span.attributes[AttributeNames.AWS_REGION]).toEqual(region);
+    expect(span.attributes[AttributeNames.CLOUD_REGION]).toEqual(region);
 
     // custom messaging attributes
     expect(span.attributes[SEMATTRS_MESSAGING_SYSTEM]).toEqual('aws.sqs');
@@ -140,7 +140,7 @@ describe('instrumentation-aws-sdk-v3 (client-sqs)', () => {
     expect(span.attributes[SEMATTRS_RPC_SYSTEM]).toEqual('aws-api');
     expect(span.attributes[SEMATTRS_RPC_METHOD]).toEqual('SendMessageBatch');
     expect(span.attributes[SEMATTRS_RPC_SERVICE]).toEqual('SQS');
-    expect(span.attributes[AttributeNames.AWS_REGION]).toEqual(region);
+    expect(span.attributes[AttributeNames.CLOUD_REGION]).toEqual(region);
 
     // messaging semantic attributes
     expect(span.attributes[SEMATTRS_MESSAGING_SYSTEM]).toEqual('aws.sqs');
@@ -183,7 +183,7 @@ describe('instrumentation-aws-sdk-v3 (client-sqs)', () => {
       expect(span.attributes[SEMATTRS_RPC_SYSTEM]).toEqual('aws-api');
       expect(span.attributes[SEMATTRS_RPC_METHOD]).toEqual('ReceiveMessage');
       expect(span.attributes[SEMATTRS_RPC_SERVICE]).toEqual('SQS');
-      expect(span.attributes[AttributeNames.AWS_REGION]).toEqual(region);
+      expect(span.attributes[AttributeNames.CLOUD_REGION]).toEqual(region);
       expect(span.attributes[SEMATTRS_HTTP_STATUS_CODE]).toEqual(200);
       done();
     });

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],
             '/'
           );