Create sync resource with some attributes that resolve asynchronously

CHANGELOG.md

@@ -12,6 +12,7 @@ For experimental package changes, see the [experimental CHANGELOG](experimental/
 ### :rocket: (Enhancement)
 
 * feat(api): add `getActiveBaggage` API [#3385](https://github.com/open-telemetry/opentelemetry-js/pull/3385)
+* feat(resource): create sync resource with some attributes that resolve asynchronously [#3460](https://github.com/open-telemetry/opentelemetry-js/pull/3460)
 * feat(instrumentation-grpc): set net.peer.name and net.peer.port on client spans [#3430](https://github.com/open-telemetry/opentelemetry-js/pull/3430)
 
 ### :bug: (Bug Fix)

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

@@ -21,7 +21,7 @@ import {
 } from '@opentelemetry/instrumentation';
 import {
   Detector,
-  detectResources,
+  detectResourcesSync,
   envDetector,
   processDetector,
   Resource,
@@ -174,12 +174,12 @@ export class NodeSDK {
   }
 
   /** Detect resource attributes */
-  public async detectResources(): Promise<void> {
+  public detectResources(): void {
     const internalConfig: ResourceDetectionConfig = {
       detectors: this._resourceDetectors,
     };
 
-    this.addResource(await detectResources(internalConfig));
+    this.addResource(detectResourcesSync(internalConfig));
   }
 
   /** Manually add a resource */
@@ -190,9 +190,9 @@ export class NodeSDK {
   /**
    * Once the SDK has been configured, call this method to construct SDK components and register them with the OpenTelemetry API.
    */
-  public async start(): Promise<void> {
+  public start(): void {
     if (this._autoDetectResources) {
-      await this.detectResources();
+      this.detectResources();
     }
 
     this._resource =

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

@@ -87,7 +87,7 @@ describe('Node SDK', () => {
         autoDetectResources: false,
       });
 
-      await sdk.start();
+      sdk.start();
 
       assert.strictEqual(
         context['_getContextManager'](),
@@ -114,7 +114,7 @@ describe('Node SDK', () => {
         autoDetectResources: false,
       });
 
-      await sdk.start();
+      sdk.start();
 
       assert.ok(!(metrics.getMeterProvider() instanceof MeterProvider));
 
@@ -139,7 +139,7 @@ describe('Node SDK', () => {
         autoDetectResources: false,
       });
 
-      await sdk.start();
+      sdk.start();
 
       assert.ok(!(metrics.getMeterProvider() instanceof MeterProvider));
 
@@ -171,7 +171,7 @@ describe('Node SDK', () => {
         autoDetectResources: false,
       });
 
-      await sdk.start();
+      sdk.start();
 
       assert.strictEqual(
         context['_getContextManager'](),
@@ -237,7 +237,7 @@ describe('Node SDK', () => {
       autoDetectResources: false,
     });
 
-    await sdk.start();
+    sdk.start();
 
     assert.strictEqual(
       context['_getContextManager'](),
@@ -393,6 +393,7 @@ describe('Node SDK', () => {
         });
         await sdk.detectResources();
         const resource = sdk['_resource'];
+        await resource.waitForAsyncAttributes();
 
         assert.strictEqual(resource.attributes['customAttr'], 'someValue');
 
@@ -420,8 +421,9 @@ describe('Node SDK', () => {
           ],
         });
 
-        await sdk.detectResources();
+        sdk.detectResources();
         const resource = sdk['_resource'];
+        await resource.waitForAsyncAttributes();
 
         assertServiceResource(resource, {
           instanceId: '627cc493',
@@ -468,7 +470,8 @@ describe('Node SDK', () => {
           DiagLogLevel.VERBOSE
         );
 
-        await sdk.detectResources();
+        sdk.detectResources();
+        await sdk['_resource'].waitForAsyncAttributes().catch(() => {});
 
         // Test that the Env Detector successfully found its resource and populated it with the right values.
         assert.ok(
@@ -500,7 +503,7 @@ describe('Node SDK', () => {
             DiagLogLevel.DEBUG
           );
 
-          await sdk.detectResources();
+          sdk.detectResources();
 
           assert.ok(
             callArgsContains(
@@ -519,7 +522,7 @@ describe('Node SDK', () => {
         serviceName: 'config-set-name',
       });
 
-      await sdk.start();
+      sdk.start();
       const resource = sdk['_resource'];
 
       assertServiceResource(resource, {
@@ -531,8 +534,9 @@ describe('Node SDK', () => {
       process.env.OTEL_SERVICE_NAME = 'env-set-name';
       const sdk = new NodeSDK();
 
-      await sdk.start();
+      sdk.start();
       const resource = sdk['_resource'];
+      await resource.waitForAsyncAttributes();
 
       assertServiceResource(resource, {
         name: 'env-set-name',
@@ -546,7 +550,7 @@ describe('Node SDK', () => {
         serviceName: 'config-set-name',
       });
 
-      await sdk.start();
+      sdk.start();
       const resource = sdk['_resource'];
 
       assertServiceResource(resource, {
@@ -560,8 +564,9 @@ describe('Node SDK', () => {
         'service.name=resource-env-set-name';
       const sdk = new NodeSDK();
 
-      await sdk.start();
+      sdk.start();
       const resource = sdk['_resource'];
+      await resource.waitForAsyncAttributes();
 
       assertServiceResource(resource, {
         name: 'resource-env-set-name',
@@ -576,7 +581,7 @@ describe('Node SDK', () => {
         serviceName: 'config-set-name',
       });
 
-      await sdk.start();
+      sdk.start();
       const resource = sdk['_resource'];
 
       assertServiceResource(resource, {
@@ -604,7 +609,7 @@ describe('setup exporter from env', () => {
   });
   it('use default exporter TracerProviderWithEnvExporters when user does not provide span processor or trace exporter to sdk config', async () => {
     const sdk = new NodeSDK();
-    await sdk.start();
+    sdk.start();
     const listOfProcessors =
       sdk['_tracerProvider']!['_registeredSpanProcessors']!;
 
@@ -617,7 +622,7 @@ describe('setup exporter from env', () => {
     const sdk = new NodeSDK({
       traceExporter,
     });
-    await sdk.start();
+    sdk.start();
     const listOfProcessors =
       sdk['_tracerProvider']!['_registeredSpanProcessors']!;
 
@@ -634,7 +639,7 @@ describe('setup exporter from env', () => {
     const sdk = new NodeSDK({
       spanProcessor,
     });
-    await sdk.start();
+    sdk.start();
     const listOfProcessors =
       sdk['_tracerProvider']!['_registeredSpanProcessors']!;
 
@@ -651,7 +656,7 @@ describe('setup exporter from env', () => {
     const sdk = new NodeSDK({
       traceExporter,
     });
-    await sdk.start();
+    sdk.start();
     const listOfProcessors =
       sdk['_tracerProvider']!['_registeredSpanProcessors']!;
 
@@ -667,7 +672,7 @@ describe('setup exporter from env', () => {
     env.OTEL_TRACES_EXPORTER = 'otlp';
     env.OTEL_EXPORTER_OTLP_TRACES_PROTOCOL = 'grpc';
     const sdk = new NodeSDK();
-    await sdk.start();
+    sdk.start();
 
     const listOfProcessors =
       sdk['_tracerProvider']!['_registeredSpanProcessors']!;
@@ -680,7 +685,7 @@ describe('setup exporter from env', () => {
   it('use noop span processor when user sets env exporter to none', async () => {
     env.OTEL_TRACES_EXPORTER = 'none';
     const sdk = new NodeSDK();
-    await sdk.start();
+    sdk.start();
 
     const listOfProcessors =
       sdk['_tracerProvider']!['_registeredSpanProcessors']!;
@@ -693,7 +698,7 @@ describe('setup exporter from env', () => {
   it('log warning that sdk will not be initalized when exporter is set to none', async () => {
     env.OTEL_TRACES_EXPORTER = 'none';
     const sdk = new NodeSDK();
-    await sdk.start();
+    sdk.start();
 
     assert.strictEqual(
       stubLoggerError.args[0][0],
@@ -704,7 +709,7 @@ describe('setup exporter from env', () => {
   it('do not use any exporters when empty value is provided for exporter', async () => {
     env.OTEL_TRACES_EXPORTER = '';
     const sdk = new NodeSDK();
-    await sdk.start();
+    sdk.start();
 
     const listOfProcessors =
       sdk['_tracerProvider']!['_registeredSpanProcessors']!;
@@ -718,7 +723,7 @@ describe('setup exporter from env', () => {
   it('use only default exporter when none value is provided with other exporters', async () => {
     env.OTEL_TRACES_EXPORTER = 'otlp,zipkin,none';
     const sdk = new NodeSDK();
-    await sdk.start();
+    sdk.start();
 
     const listOfProcessors =
       sdk['_tracerProvider']!['_registeredSpanProcessors']!;
@@ -731,7 +736,7 @@ describe('setup exporter from env', () => {
   it('log warning that only default exporter will be used since exporter list contains none with other exports ', async () => {
     env.OTEL_TRACES_EXPORTER = 'otlp,zipkin,none';
     const sdk = new NodeSDK();
-    await sdk.start();
+    sdk.start();
 
     assert.strictEqual(
       stubLoggerError.args[0][0],
@@ -742,7 +747,7 @@ describe('setup exporter from env', () => {
   it('should warn that provided exporter value is unrecognized and not able to be set up', async () => {
     env.OTEL_TRACES_EXPORTER = 'invalid';
     const sdk = new NodeSDK();
-    await sdk.start();
+    sdk.start();
 
     assert.strictEqual(
       stubLoggerError.args[0][0],
@@ -760,7 +765,7 @@ describe('setup exporter from env', () => {
     env.OTEL_TRACES_EXPORTER = 'zipkin, otlp, jaeger';
     env.OTEL_EXPORTER_OTLP_TRACES_PROTOCOL = 'grpc';
     const sdk = new NodeSDK();
-    await sdk.start();
+    sdk.start();
 
     const listOfProcessors =
       sdk['_tracerProvider']!['_registeredSpanProcessors']!;
@@ -776,7 +781,7 @@ describe('setup exporter from env', () => {
   it('use the console exporter', async () => {
     env.OTEL_TRACES_EXPORTER = 'console, otlp';
     const sdk = new NodeSDK();
-    await sdk.start();
+    sdk.start();
 
     const listOfProcessors =
       sdk['_tracerProvider']!['_registeredSpanProcessors']!;