Merge branch 'main' into fix/host-metrics-bundling

open-telemetry · Apr 29, 2024 · 769de9e · 769de9e
2 parents 9f81a2d + 3ad9fdf
commit 769de9e
Show file tree

Hide file tree

Showing 23 changed files with 194 additions and 129 deletions.
diff --git a/metapackages/auto-instrumentations-node/README.md b/metapackages/auto-instrumentations-node/README.md
@@ -65,6 +65,7 @@ By default, all SDK resource detectors are used, but you can use the environment
 - `container`
 - `alibaba`
 - `aws`
+- `azure`
 - `gcp`
 - `all` - enable all resource detectors
 - `none` - disable resource detection

diff --git a/metapackages/auto-instrumentations-node/package.json b/metapackages/auto-instrumentations-node/package.json
@@ -89,6 +89,7 @@
     "@opentelemetry/instrumentation-winston": "^0.37.0",
     "@opentelemetry/resource-detector-alibaba-cloud": "^0.28.9",
     "@opentelemetry/resource-detector-aws": "^1.4.2",
+    "@opentelemetry/resource-detector-azure": "^0.2.6",
     "@opentelemetry/resource-detector-container": "^0.3.9",
     "@opentelemetry/resource-detector-gcp": "^0.29.9",
     "@opentelemetry/resources": "^1.12.0",

diff --git a/metapackages/auto-instrumentations-node/src/utils.ts b/metapackages/auto-instrumentations-node/src/utils.ts
@@ -73,6 +73,11 @@ import {
   osDetectorSync,
   processDetectorSync,
 } from '@opentelemetry/resources';
+import {
+  azureAppServiceDetector,
+  azureFunctionsDetector,
+  azureVmDetector,
+} from '@opentelemetry/resource-detector-azure';
 
 const RESOURCE_DETECTOR_CONTAINER = 'container';
 const RESOURCE_DETECTOR_ENVIRONMENT = 'env';
@@ -81,6 +86,7 @@ const RESOURCE_DETECTOR_OS = 'os';
 const RESOURCE_DETECTOR_PROCESS = 'process';
 const RESOURCE_DETECTOR_ALIBABA = 'alibaba';
 const RESOURCE_DETECTOR_AWS = 'aws';
+const RESOURCE_DETECTOR_AZURE = 'azure';
 const RESOURCE_DETECTOR_GCP = 'gcp';
 
 const InstrumentationMap = {
@@ -196,7 +202,7 @@ function getEnabledInstrumentationsFromEnv() {
 export function getResourceDetectorsFromEnv(): Array<Detector | DetectorSync> {
   const resourceDetectors = new Map<
     string,
-    Detector | DetectorSync | Detector[]
+    Detector | DetectorSync | Detector[] | DetectorSync[]
   >([
     [RESOURCE_DETECTOR_CONTAINER, containerDetector],
     [RESOURCE_DETECTOR_ENVIRONMENT, envDetectorSync],
@@ -215,6 +221,10 @@ export function getResourceDetectorsFromEnv(): Array<Detector | DetectorSync> {
         awsLambdaDetector,
       ],
     ],
+    [
+      RESOURCE_DETECTOR_AZURE,
+      [azureAppServiceDetector, azureFunctionsDetector, azureVmDetector],
+    ],
   ]);
 
   const resourceDetectorsFromEnv =

diff --git a/metapackages/auto-instrumentations-node/test/utils.test.ts b/metapackages/auto-instrumentations-node/test/utils.test.ts
@@ -114,13 +114,13 @@ describe('utils', () => {
 
   describe('getResourceDetectorsFromEnv', () => {
     it('should return all resource detectors by default', () => {
-      assert.equal(getResourceDetectorsFromEnv().length, 12);
+      assert.equal(getResourceDetectorsFromEnv().length, 15);
     });
 
     it('should return all resource detectors when OTEL_NODE_RESOURCE_DETECTORS contains "all"', () => {
       process.env.OTEL_NODE_RESOURCE_DETECTORS = 'all';
 
-      assert.equal(getResourceDetectorsFromEnv().length, 12);
+      assert.equal(getResourceDetectorsFromEnv().length, 15);
 
       delete process.env.OTEL_NODE_RESOURCE_DETECTORS;
     });

diff --git a/package-lock.json b/package-lock.json
diff --git a/plugins/node/instrumentation-cucumber/README.md b/plugins/node/instrumentation-cucumber/README.md
@@ -43,6 +43,19 @@ Cucumber instrumentation has currently no options.
 | Options | Type | Description |
 | ------- | ---- | ----------- |
 
+## 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)
+
+Attributes collected:
+
+| Attribute        | Short Description                                                                |
+| ---------------- | -------------------------------------------------------------------------------- |
+| `code.filepath`  | The source code file name that identifies the code unit as uniquely as possible. |
+| `code.function`  | The method or function name, or equivalent.                                      |
+| `code.lineno`    | The line number in `code.filepath` best representing the operation.              |
+| `code.namespace` | The "namespace" within which `code.function` is defined.                         |
+
 ## Useful links
 
 - For more information on OpenTelemetry, visit: <https://opentelemetry.io/>

diff --git a/plugins/node/instrumentation-cucumber/package.json b/plugins/node/instrumentation-cucumber/package.json
@@ -63,7 +63,7 @@
   },
   "dependencies": {
     "@opentelemetry/instrumentation": "^0.51.0",
-    "@opentelemetry/semantic-conventions": "^1.0.0"
+    "@opentelemetry/semantic-conventions": "^1.22.0"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/instrumentation-cucumber#readme"
 }
diff --git a/plugins/node/instrumentation-cucumber/src/instrumentation.ts b/plugins/node/instrumentation-cucumber/src/instrumentation.ts
@@ -21,7 +21,12 @@ import {
   InstrumentationNodeModuleFile,
   isWrapped,
 } from '@opentelemetry/instrumentation';
-import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
+import {
+  SEMATTRS_CODE_FILEPATH,
+  SEMATTRS_CODE_FUNCTION,
+  SEMATTRS_CODE_LINENO,
+  SEMATTRS_CODE_NAMESPACE,
+} from '@opentelemetry/semantic-conventions';
 
 import type * as cucumber from '@cucumber/cucumber';
 import type * as messages from '@cucumber/messages';
@@ -174,10 +179,10 @@ export class CucumberInstrumentation extends InstrumentationBase {
           {
             kind: SpanKind.CLIENT,
             attributes: {
-              [SemanticAttributes.CODE_FILEPATH]: gherkinDocument.uri,
-              [SemanticAttributes.CODE_LINENO]: scenario.location.line,
-              [SemanticAttributes.CODE_FUNCTION]: scenario.name,
-              [SemanticAttributes.CODE_NAMESPACE]: feature.name,
+              [SEMATTRS_CODE_FILEPATH]: gherkinDocument.uri,
+              [SEMATTRS_CODE_LINENO]: scenario.location.line,
+              [SEMATTRS_CODE_FUNCTION]: scenario.name,
+              [SEMATTRS_CODE_NAMESPACE]: feature.name,
               [AttributeNames.FEATURE_TAGS]: CucumberInstrumentation.mapTags(
                 feature.tags
               ),

diff --git a/plugins/node/instrumentation-cucumber/test/cucumber.test.ts b/plugins/node/instrumentation-cucumber/test/cucumber.test.ts
@@ -21,9 +21,14 @@ import {
   InMemorySpanExporter,
   SimpleSpanProcessor,
 } from '@opentelemetry/sdk-trace-base';
-import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
+import {
+  SEMATTRS_CODE_FILEPATH,
+  SEMATTRS_CODE_FUNCTION,
+  SEMATTRS_CODE_LINENO,
+  SEMATTRS_CODE_NAMESPACE,
+  SEMRESATTRS_SERVICE_NAME,
+} from '@opentelemetry/semantic-conventions';
 import { Resource } from '@opentelemetry/resources';
-import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions';
 
 import * as path from 'path';
 import * as assert from 'assert';
@@ -50,7 +55,7 @@ import { PassThrough } from 'stream';
 describe('CucumberInstrumentation', () => {
   const provider = new NodeTracerProvider({
     resource: new Resource({
-      [SemanticResourceAttributes.SERVICE_NAME]: 'CucumberInstrumentation',
+      [SEMRESATTRS_SERVICE_NAME]: 'CucumberInstrumentation',
     }),
   });
   const memoryExporter = new InMemorySpanExporter();
@@ -165,10 +170,10 @@ describe('CucumberInstrumentation', () => {
         assert(parent, 'Expected a parent span');
 
         assert.deepEqual(parent.attributes, {
-          [SemanticAttributes.CODE_FILEPATH]: 'test/current.feature',
-          [SemanticAttributes.CODE_LINENO]: 7,
-          [SemanticAttributes.CODE_FUNCTION]: 'Button pushing',
-          [SemanticAttributes.CODE_NAMESPACE]: 'Basic',
+          [SEMATTRS_CODE_FILEPATH]: 'test/current.feature',
+          [SEMATTRS_CODE_LINENO]: 7,
+          [SEMATTRS_CODE_FUNCTION]: 'Button pushing',
+          [SEMATTRS_CODE_NAMESPACE]: 'Basic',
           [AttributeNames.FEATURE_DESCRIPTION]:
             '          A very basic feature file with a single scenario',
           [AttributeNames.FEATURE_LANGUAGE]: 'en',

diff --git a/plugins/node/instrumentation-socket.io/README.md b/plugins/node/instrumentation-socket.io/README.md
@@ -59,6 +59,19 @@ Few breaking changes were made during porting to the contrib repo:
 The instrumentation's config `filterHttpTransport` option was removed to decouple this instrumentation from the http instrumentation.
 if you do not want to trace the socket.io http requests, add the default socket.io route (`/socket.io/`) to the `HttpInstrumentationConfig.ignoreIncomingPaths` array
 
+## 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)
+
+Attributes collected:
+
+| Attribute                    | Short Description                                                                                |
+| ---------------------------- | ------------------------------------------------------------------------------------------------ |
+| `messaging.destination`      | The message destination name. This might be equal to the span name but is required nevertheless. |
+| `messaging.destination_kind` | The kind of message destination.                                                                 |
+| `messaging.operation`        | A string identifying the kind of message consumption.                                            |
+| `messaging.system`           | A string identifying the messaging system.                                                       |
+
 ## Useful links
 
 - For more information on OpenTelemetry, visit: <https://opentelemetry.io/>

diff --git a/plugins/node/instrumentation-socket.io/package.json b/plugins/node/instrumentation-socket.io/package.json
@@ -59,7 +59,7 @@
   },
   "dependencies": {
     "@opentelemetry/instrumentation": "^0.51.0",
-    "@opentelemetry/semantic-conventions": "^1.0.0"
+    "@opentelemetry/semantic-conventions": "^1.22.0"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/instrumentation-socket.io#readme"
 }
diff --git a/plugins/node/instrumentation-socket.io/src/socket.io.ts b/plugins/node/instrumentation-socket.io/src/socket.io.ts
@@ -28,9 +28,12 @@ import {
   safeExecuteInTheMiddle,
 } from '@opentelemetry/instrumentation';
 import {
-  SemanticAttributes,
-  MessagingOperationValues,
-  MessagingDestinationKindValues,
+  SEMATTRS_MESSAGING_DESTINATION,
+  SEMATTRS_MESSAGING_DESTINATION_KIND,
+  SEMATTRS_MESSAGING_OPERATION,
+  SEMATTRS_MESSAGING_SYSTEM,
+  MESSAGINGOPERATIONVALUES_RECEIVE,
+  MESSAGINGDESTINATIONKINDVALUES_TOPIC,
 } from '@opentelemetry/semantic-conventions';
 import { SocketIoInstrumentationConfig } from './types';
 import { SocketIoInstrumentationAttributes } from './AttributeNames';
@@ -302,14 +305,14 @@ export class SocketIoInstrumentation extends InstrumentationBase {
               ? eventName
               : `${namespace} ${eventName}`;
           const span: Span = self.tracer.startSpan(
-            `${destination} ${MessagingOperationValues.RECEIVE}`,
+            `${destination} ${MESSAGINGOPERATIONVALUES_RECEIVE}`,
             {
               kind: SpanKind.CONSUMER,
               attributes: {
-                [SemanticAttributes.MESSAGING_SYSTEM]: 'socket.io',
-                [SemanticAttributes.MESSAGING_DESTINATION]: namespace,
-                [SemanticAttributes.MESSAGING_OPERATION]:
-                  MessagingOperationValues.RECEIVE,
+                [SEMATTRS_MESSAGING_SYSTEM]: 'socket.io',
+                [SEMATTRS_MESSAGING_DESTINATION]: namespace,
+                [SEMATTRS_MESSAGING_OPERATION]:
+                  MESSAGINGOPERATIONVALUES_RECEIVE,
                 [SocketIoInstrumentationAttributes.SOCKET_IO_EVENT_NAME]:
                   eventName,
               },
@@ -379,9 +382,9 @@ export class SocketIoInstrumentation extends InstrumentationBase {
         const messagingSystem = 'socket.io';
         const eventName = ev;
         const attributes: any = {
-          [SemanticAttributes.MESSAGING_SYSTEM]: messagingSystem,
-          [SemanticAttributes.MESSAGING_DESTINATION_KIND]:
-            MessagingDestinationKindValues.TOPIC,
+          [SEMATTRS_MESSAGING_SYSTEM]: messagingSystem,
+          [SEMATTRS_MESSAGING_DESTINATION_KIND]:
+            MESSAGINGDESTINATIONKINDVALUES_TOPIC,
           [SocketIoInstrumentationAttributes.SOCKET_IO_EVENT_NAME]: eventName,
         };
 
@@ -394,7 +397,7 @@ export class SocketIoInstrumentation extends InstrumentationBase {
         if (namespace) {
           attributes[SocketIoInstrumentationAttributes.SOCKET_IO_NAMESPACE] =
             namespace;
-          attributes[SemanticAttributes.MESSAGING_DESTINATION] = namespace;
+          attributes[SEMATTRS_MESSAGING_DESTINATION] = namespace;
         }
         const spanRooms = rooms.length ? `[${rooms.join()}]` : '';
         const span = self.tracer.startSpan(`${namespace}${spanRooms} send`, {