remove references to env variables

open-telemetry · Apr 10, 2024 · 605cd62 · 605cd62
1 parent 19c7189
commit 605cd62
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 59 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,11 +12,7 @@ For experimental package changes, see the [experimental CHANGELOG](experimental/
 ### :rocket: (Enhancement)
 
 * feat(sdk-trace-base): log resource attributes in ConsoleSpanExporter [#4605](https://github.com/open-telemetry/opentelemetry-js/pull/4605) @pichlermarc
-* feat(resources): set value for `service.instance.id` as random UUID by default if environment variable `OTEL_NODE_EXPERIMENTAL_DEFAULT_SERVICE_INSTANCE_ID` is set to true.
-  * The value can be overwritten by
-    * merging a resource containing the `service.instance.id` attribute
-    * setting `service.instance.id` via the `OTEL_RESOURCE_ATTRIBUTES`  environment variable when using `envDetector`
-    * using another resource detector which writes `service.instance.id`
+* feat(resources): new detector ServiceInstanceIDDetector that sets the value for `service.instance.id` as random UUID.
 
 ### :bug: (Bug Fix)
 

diff --git a/experimental/packages/opentelemetry-sdk-node/src/sdk.ts b/experimental/packages/opentelemetry-sdk-node/src/sdk.ts
@@ -36,7 +36,6 @@ import {
   processDetector,
   Resource,
   ResourceDetectionConfig,
-  serviceInstanceIDDetector,
 } from '@opentelemetry/resources';
 import { LogRecordProcessor, LoggerProvider } from '@opentelemetry/sdk-logs';
 import { MeterProvider, MetricReader, View } from '@opentelemetry/sdk-metrics';
@@ -122,13 +121,12 @@ export class NodeSDK {
     this._configuration = configuration;
 
     this._resource = configuration.resource ?? new Resource({});
-    const defaultDetectors = [envDetector, processDetector, hostDetector];
 
-    if (env.OTEL_NODE_EXPERIMENTAL_DEFAULT_SERVICE_INSTANCE_ID) {
-      defaultDetectors.push(serviceInstanceIDDetector);
-    }
-    this._resourceDetectors =
-      configuration.resourceDetectors ?? defaultDetectors;
+    this._resourceDetectors = configuration.resourceDetectors ?? [
+      envDetector,
+      processDetector,
+      hostDetector,
+    ];
 
     this._serviceName = configuration.serviceName;
 

diff --git a/experimental/packages/opentelemetry-sdk-node/test/sdk.test.ts b/experimental/packages/opentelemetry-sdk-node/test/sdk.test.ts
@@ -59,6 +59,7 @@ import {
   processDetector,
   hostDetector,
   Resource,
+  serviceInstanceIDDetector,
 } from '@opentelemetry/resources';
 import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http';
 import { logs } from '@opentelemetry/api-logs';
@@ -696,10 +697,16 @@ describe('Node SDK', () => {
       sdk.shutdown();
     });
 
-    it('should configure service instance id with random UUID with OTEL_NODE_EXPERIMENTAL_DEFAULT_SERVICE_INSTANCE_ID env var', async () => {
-      process.env.OTEL_RESOURCE_ATTRIBUTES = 'service.name=my-service';
-      process.env.OTEL_NODE_EXPERIMENTAL_DEFAULT_SERVICE_INSTANCE_ID = 'true';
-      const sdk = new NodeSDK();
+    it('should configure service instance id with random UUID', async () => {
+      const sdk = new NodeSDK({
+        autoDetectResources: true,
+        resourceDetectors: [
+          processDetector,
+          envDetector,
+          hostDetector,
+          serviceInstanceIDDetector,
+        ],
+      });
 
       sdk.start();
       const resource = sdk['_resource'];
@@ -713,44 +720,6 @@ describe('Node SDK', () => {
         ),
         true
       );
-
-      delete process.env.OTEL_RESOURCE_ATTRIBUTES;
-      delete process.env.OTEL_NODE_EXPERIMENTAL_DEFAULT_SERVICE_INSTANCE_ID;
-      await sdk.shutdown();
-    });
-
-    it('should configure service instance id via OTEL_RESOURCE_ATTRIBUTES env var even with OTEL_NODE_EXPERIMENTAL_DEFAULT_SERVICE_INSTANCE_ID env var', async () => {
-      process.env.OTEL_RESOURCE_ATTRIBUTES =
-        'service.instance.id=627cc493,service.name=my-service';
-      process.env.OTEL_NODE_EXPERIMENTAL_DEFAULT_SERVICE_INSTANCE_ID = 'true';
-      const sdk = new NodeSDK();
-
-      sdk.start();
-      const resource = sdk['_resource'];
-      await resource.waitForAsyncAttributes?.();
-
-      assertServiceResource(resource, {
-        name: 'my-service',
-        instanceId: '627cc493',
-      });
-      delete process.env.OTEL_RESOURCE_ATTRIBUTES;
-      delete process.env.OTEL_NODE_EXPERIMENTAL_DEFAULT_SERVICE_INSTANCE_ID;
-      sdk.shutdown();
-    });
-
-    it('should not configure service instance id with no value for it on OTEL_RESOURCE_ATTRIBUTES env var and  OTEL_NODE_EXPERIMENTAL_DEFAULT_SERVICE_INSTANCE_ID env var as false', async () => {
-      process.env.OTEL_RESOURCE_ATTRIBUTES = 'service.name=my-service';
-      process.env.OTEL_NODE_EXPERIMENTAL_DEFAULT_SERVICE_INSTANCE_ID = 'false';
-      const sdk = new NodeSDK();
-
-      sdk.start();
-      const resource = sdk['_resource'];
-      await resource.waitForAsyncAttributes?.();
-
-      assertServiceResource(resource, {
-        name: 'my-service',
-      });
-      delete process.env.OTEL_RESOURCE_ATTRIBUTES;
       await sdk.shutdown();
     });
   });

diff --git a/packages/opentelemetry-core/src/utils/environment.ts b/packages/opentelemetry-core/src/utils/environment.ts
@@ -24,10 +24,7 @@ const DEFAULT_LIST_SEPARATOR = ',';
  * Environment interface to define all names
  */
 
-const ENVIRONMENT_BOOLEAN_KEYS = [
-  'OTEL_SDK_DISABLED',
-  'OTEL_NODE_EXPERIMENTAL_DEFAULT_SERVICE_INSTANCE_ID',
-] as const;
+const ENVIRONMENT_BOOLEAN_KEYS = ['OTEL_SDK_DISABLED'] as const;
 
 type ENVIRONMENT_BOOLEANS = {
   [K in (typeof ENVIRONMENT_BOOLEAN_KEYS)[number]]?: boolean;
@@ -239,7 +236,6 @@ export const DEFAULT_ENVIRONMENT: Required<ENVIRONMENT> = {
   OTEL_EXPORTER_OTLP_METRICS_PROTOCOL: 'http/protobuf',
   OTEL_EXPORTER_OTLP_LOGS_PROTOCOL: 'http/protobuf',
   OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE: 'cumulative',
-  OTEL_NODE_EXPERIMENTAL_DEFAULT_SERVICE_INSTANCE_ID: false,
 };
 
 /**