feat(opentelemetry-sdk-node): use declarative config for resource attributes

experimental/CHANGELOG.md

@@ -15,8 +15,8 @@ For notes on migrating to 2.x / 0.200.x see [the upgrade guide](doc/upgrade-to-2
 * feat(configuration): set logger provider exporter type from env variable [#6104](https://github.com/open-telemetry/opentelemetry-js/pull/6104) @maryliag
 * feat(configuration): set meter provider exporter type from env variable [#6105](https://github.com/open-telemetry/opentelemetry-js/pull/6105) @maryliag
 * feat(configuration): set tracer provider exporter type from env variables [#6106](https://github.com/open-telemetry/opentelemetry-js/pull/6106) @maryliag
-* feat(configuration): set meter provider exporter type from env variable [#6105](https://github.com/open-telemetry/opentelemetry-js/pull/6105) @maryliag
 * refactor(configuration): throw warning and not error for invalid files [#6124](https://github.com/open-telemetry/opentelemetry-js/pull/6124) @maryliag
+* feat(opentelemetry-sdk-node): use declarative config for resource attributes [#6044](https://github.com/open-telemetry/opentelemetry-js/pull/6044) @maryliag
 
 ### :bug: Bug Fixes
 

experimental/packages/configuration/package.json

@@ -1,6 +1,5 @@
 {
   "name": "@opentelemetry/configuration",
-  "private": true,
   "version": "0.208.0",
   "description": "OpenTelemetry Configuration",
   "main": "build/src/index.js",

experimental/packages/opentelemetry-sdk-node/package.json

@@ -44,6 +44,7 @@
   },
   "dependencies": {
     "@opentelemetry/api-logs": "0.208.0",
+    "@opentelemetry/configuration": "0.208.0",
     "@opentelemetry/core": "2.2.0",
     "@opentelemetry/exporter-logs-otlp-grpc": "0.208.0",
     "@opentelemetry/exporter-logs-otlp-http": "0.208.0",

experimental/packages/opentelemetry-sdk-node/src/sdk.ts

@@ -63,19 +63,19 @@ import {
 } from '@opentelemetry/sdk-trace-node';
 import { ATTR_SERVICE_NAME } from '@opentelemetry/semantic-conventions';
 import { NodeSDKConfiguration } from './types';
-import {
-  getBooleanFromEnv,
-  getStringFromEnv,
-  getStringListFromEnv,
-  diagLogLevelFromString,
-} from '@opentelemetry/core';
+import { getStringFromEnv, getStringListFromEnv } from '@opentelemetry/core';
 import {
   getResourceDetectorsFromEnv,
   getSpanProcessorsFromEnv,
   getPropagatorFromEnv,
   setupPropagator,
   setupContextManager,
 } from './utils';
+import {
+  ConfigFactory,
+  ConfigurationModel,
+  createConfigFactory,
+} from '@opentelemetry/configuration';
 
 type TracerProviderConfig = {
   tracerConfig: NodeTracerConfig;
@@ -124,7 +124,7 @@ function configureMetricProviderFromEnv(): IMetricReader[] {
 
   if (enabledExporters.includes('none')) {
     diag.info(
-      `OTEL_METRICS_EXPORTER contains "none". Metric provider will not be initialized.`
+      `OTEL_METRICS_EXPORTER contains "none". Meter provider will not be initialized.`
     );
     return metricReaders;
   }
@@ -223,6 +223,7 @@ function configureMetricProviderFromEnv(): IMetricReader[] {
  *    nodeSdk.start(); // registers all configured SDK components
  */
 export class NodeSDK {
+  private _config: ConfigurationModel;
   private _tracerProviderConfig?: TracerProviderConfig;
   private _loggerProviderConfig?: LoggerProviderConfig;
   private _meterProviderConfig?: MeterProviderConfig;
@@ -245,16 +246,17 @@ export class NodeSDK {
    * Create a new NodeJS SDK instance
    */
   public constructor(configuration: Partial<NodeSDKConfiguration> = {}) {
-    if (getBooleanFromEnv('OTEL_SDK_DISABLED')) {
+    const configFactory: ConfigFactory = createConfigFactory();
+    this._config = configFactory.getConfigModel();
+    if (this._config.disabled) {
       this._disabled = true;
       // Functions with possible side-effects are set
       // to no-op via the _disabled flag
     }
 
-    const logLevel = getStringFromEnv('OTEL_LOG_LEVEL');
-    if (logLevel != null) {
+    if (this._config.log_level != null) {
       diag.setLogger(new DiagConsoleLogger(), {
-        logLevel: diagLogLevelFromString(logLevel),
+        logLevel: this._config.log_level,
       });
     }
 
@@ -266,8 +268,8 @@ export class NodeSDK {
       this._resourceDetectors = [];
     } else if (configuration.resourceDetectors != null) {
       this._resourceDetectors = configuration.resourceDetectors;
-    } else if (getStringFromEnv('OTEL_NODE_RESOURCE_DETECTORS')) {
-      this._resourceDetectors = getResourceDetectorsFromEnv();
+    } else if (this._config.node_resource_detectors) {
+      this._resourceDetectors = getResourceDetectorsFromEnv(this._config);
     } else {
       this._resourceDetectors = [envDetector, processDetector, hostDetector];
     }

experimental/packages/opentelemetry-sdk-node/src/utils.ts

@@ -50,14 +50,17 @@ import {
 import { B3InjectEncoding, B3Propagator } from '@opentelemetry/propagator-b3';
 import { JaegerPropagator } from '@opentelemetry/propagator-jaeger';
 import { AsyncLocalStorageContextManager } from '@opentelemetry/context-async-hooks';
+import { ConfigurationModel } from '@opentelemetry/configuration';
 
 const RESOURCE_DETECTOR_ENVIRONMENT = 'env';
 const RESOURCE_DETECTOR_HOST = 'host';
 const RESOURCE_DETECTOR_OS = 'os';
 const RESOURCE_DETECTOR_PROCESS = 'process';
 const RESOURCE_DETECTOR_SERVICE_INSTANCE_ID = 'serviceinstance';
 
-export function getResourceDetectorsFromEnv(): Array<ResourceDetector> {
+export function getResourceDetectorsFromEnv(
+  config: ConfigurationModel
+): Array<ResourceDetector> {
   // When updating this list, make sure to also update the section `resourceDetectors` on README.
   const resourceDetectors = new Map<string, ResourceDetector>([
     [RESOURCE_DETECTOR_ENVIRONMENT, envDetector],
@@ -67,9 +70,7 @@ export function getResourceDetectorsFromEnv(): Array<ResourceDetector> {
     [RESOURCE_DETECTOR_PROCESS, processDetector],
   ]);
 
-  const resourceDetectorsFromEnv = getStringListFromEnv(
-    'OTEL_NODE_RESOURCE_DETECTORS'
-  ) ?? ['all'];
+  const resourceDetectorsFromEnv = config.node_resource_detectors ?? ['all'];
 
   if (resourceDetectorsFromEnv.includes('all')) {
     return [...resourceDetectors.values()].flat();
@@ -82,9 +83,7 @@ export function getResourceDetectorsFromEnv(): Array<ResourceDetector> {
   return resourceDetectorsFromEnv.flatMap(detector => {
     const resourceDetector = resourceDetectors.get(detector);
     if (!resourceDetector) {
-      diag.warn(
-        `Invalid resource detector "${detector}" specified in the environment variable OTEL_NODE_RESOURCE_DETECTORS`
-      );
+      diag.warn(`Invalid resource detector "${detector}" specified`);
     }
     return resourceDetector || [];
   });

experimental/packages/opentelemetry-sdk-node/test/sdk.test.ts

@@ -82,7 +82,7 @@ import { OTLPTraceExporter as OTLPProtoTraceExporter } from '@opentelemetry/expo
 import { OTLPTraceExporter as OTLPGrpcTraceExporter } from '@opentelemetry/exporter-trace-otlp-grpc';
 import { ZipkinExporter } from '@opentelemetry/exporter-zipkin';
 
-import { ATTR_HOST_NAME, ATTR_PROCESS_PID } from './semconv';
+import { ATTR_HOST_NAME, ATTR_PROCESS_PID } from '../src/semconv';
 
 function assertDefaultContextManagerRegistered() {
   assert.ok(
@@ -179,20 +179,6 @@ describe('Node SDK', () => {
       sdk.shutdown();
     });
 
-    it('should not register a diag logger with OTEL_LOG_LEVEL unset', () => {
-      delete process.env.OTEL_LOG_LEVEL;
-
-      const spy = Sinon.spy(diag, 'setLogger');
-      const sdk = new NodeSDK({
-        autoDetectResources: false,
-      });
-
-      sdk.start();
-
-      assert.strictEqual(spy.callCount, 0);
-      sdk.shutdown();
-    });
-
     it('should register a tracer provider if an exporter is provided', async () => {
       const sdk = new NodeSDK({
         traceExporter: new ConsoleSpanExporter(),
@@ -1224,7 +1210,7 @@ describe('Node SDK', () => {
     });
   });
 
-  describe('configuring metric provider from env', () => {
+  describe('configuring meter provider from env', () => {
     let stubLogger: Sinon.SinonStub;
 
     beforeEach(() => {
@@ -1247,7 +1233,7 @@ describe('Node SDK', () => {
       assert.ok(!(metrics.getMeterProvider() instanceof MeterProvider));
       assert.strictEqual(
         stubLogger.args[0][0],
-        'OTEL_METRICS_EXPORTER contains "none". Metric provider will not be initialized.'
+        'OTEL_METRICS_EXPORTER contains "none". Meter provider will not be initialized.'
       );
       await sdk.shutdown();
     });

experimental/packages/opentelemetry-sdk-node/test/util/resource-assertions.ts

@@ -21,7 +21,10 @@ import {
   ATTR_SERVICE_VERSION,
 } from '@opentelemetry/semantic-conventions';
 
-import { ATTR_SERVICE_INSTANCE_ID, ATTR_SERVICE_NAMESPACE } from '../semconv';
+import {
+  ATTR_SERVICE_INSTANCE_ID,
+  ATTR_SERVICE_NAMESPACE,
+} from '../../src/semconv';
 
 /**
  * Test utility method to validate a service resource
@@ -43,6 +46,7 @@ export const assertServiceResource = (
     resource.attributes[ATTR_SERVICE_INSTANCE_ID],
     validations.instanceId
   );
+
   if (validations.namespace)
     assert.strictEqual(
       resource.attributes[ATTR_SERVICE_NAMESPACE],

experimental/packages/opentelemetry-sdk-node/tsconfig.json

@@ -45,6 +45,9 @@
     {
       "path": "../api-logs"
     },
+    {
+      "path": "../configuration"
+    },
     {
       "path": "../exporter-logs-otlp-grpc"
     },