feat(auto-instrumentation-node): add options for serviceinstance

Signed-off-by: maryliag <[email protected]>
open-telemetry · Apr 26, 2024 · 97a16cd · 97a16cd
1 parent 7822461
commit 97a16cd
Show file tree

Hide file tree

Showing 5 changed files with 574 additions and 6 deletions.
diff --git a/metapackages/auto-instrumentations-node/README.md b/metapackages/auto-instrumentations-node/README.md
@@ -50,7 +50,7 @@ export OTEL_EXPORTER_OTLP_TRACES_ENDPOINT="https://your-endpoint"
 export OTEL_EXPORTER_OTLP_HEADERS="x-api-key=your-api-key"
 export OTEL_EXPORTER_OTLP_TRACES_HEADERS="x-api-key=your-api-key"
 export OTEL_RESOURCE_ATTRIBUTES="service.namespace=my-namespace"
-export OTEL_NODE_RESOURCE_DETECTORS="env,host,os"
+export OTEL_NODE_RESOURCE_DETECTORS="env,host,os,serviceinstace"
 export OTEL_SERVICE_NAME="client"
 export NODE_OPTIONS="--require @opentelemetry/auto-instrumentations-node/register"
 node app.js
@@ -62,6 +62,7 @@ By default, all SDK resource detectors are used, but you can use the environment
 - `host`
 - `os`
 - `process`
+- `serviceinstance`
 - `container`
 - `alibaba`
 - `aws`

diff --git a/metapackages/auto-instrumentations-node/package.json b/metapackages/auto-instrumentations-node/package.json
@@ -91,7 +91,7 @@
     "@opentelemetry/resource-detector-aws": "^1.4.2",
     "@opentelemetry/resource-detector-container": "^0.3.9",
     "@opentelemetry/resource-detector-gcp": "^0.29.9",
-    "@opentelemetry/resources": "^1.12.0",
+    "@opentelemetry/resources": "^1.24.0",
     "@opentelemetry/sdk-node": "^0.51.0"
   },
   "files": [

diff --git a/metapackages/auto-instrumentations-node/src/utils.ts b/metapackages/auto-instrumentations-node/src/utils.ts
@@ -72,12 +72,14 @@ import {
   hostDetectorSync,
   osDetectorSync,
   processDetectorSync,
+  serviceInstanceIdDetectorSync,
 } from '@opentelemetry/resources';
 
 const RESOURCE_DETECTOR_CONTAINER = 'container';
 const RESOURCE_DETECTOR_ENVIRONMENT = 'env';
 const RESOURCE_DETECTOR_HOST = 'host';
 const RESOURCE_DETECTOR_OS = 'os';
+const RESOURCE_DETECTOR_SERVICE_INSTANCE_ID = 'serviceinstance';
 const RESOURCE_DETECTOR_PROCESS = 'process';
 const RESOURCE_DETECTOR_ALIBABA = 'alibaba';
 const RESOURCE_DETECTOR_AWS = 'aws';
@@ -202,6 +204,7 @@ export function getResourceDetectorsFromEnv(): Array<Detector | DetectorSync> {
     [RESOURCE_DETECTOR_ENVIRONMENT, envDetectorSync],
     [RESOURCE_DETECTOR_HOST, hostDetectorSync],
     [RESOURCE_DETECTOR_OS, osDetectorSync],
+    [RESOURCE_DETECTOR_SERVICE_INSTANCE_ID, serviceInstanceIdDetectorSync],
     [RESOURCE_DETECTOR_PROCESS, processDetectorSync],
     [RESOURCE_DETECTOR_ALIBABA, alibabaCloudEcsDetector],
     [RESOURCE_DETECTOR_GCP, gcpDetector],

diff --git a/metapackages/auto-instrumentations-node/test/utils.test.ts b/metapackages/auto-instrumentations-node/test/utils.test.ts
@@ -126,13 +126,17 @@ describe('utils', () => {
     });
 
     it('should return specific resource detectors depending on OTEL_NODE_RESOURCE_DETECTORS', () => {
-      process.env.OTEL_NODE_RESOURCE_DETECTORS = 'env,host';
+      process.env.OTEL_NODE_RESOURCE_DETECTORS = 'env,host,serviceinstance';
 
       const resourceDetectors = getResourceDetectorsFromEnv();
 
-      assert.equal(resourceDetectors.length, 2);
+      assert.equal(resourceDetectors.length, 3);
       assert.equal(resourceDetectors[0].constructor.name, 'EnvDetectorSync');
       assert.equal(resourceDetectors[1].constructor.name, 'HostDetectorSync');
+      assert.equal(
+        resourceDetectors[2].constructor.name,
+        'ServiceInstanceIDDetectorSync'
+      );
 
       delete process.env.OTEL_NODE_RESOURCE_DETECTORS;
     });