chore: more advanced types for sync/async resource

packages/opentelemetry-exporter-jaeger/src/transform.ts

@@ -15,7 +15,6 @@
  */
 
 import { Link, CanonicalCode, SpanKind } from '@opentelemetry/api';
-import { Resource } from '@opentelemetry/resources';
 import { ReadableSpan } from '@opentelemetry/tracing';
 import {
   hrTimeToMilliseconds,

packages/opentelemetry-exporter-zipkin/src/zipkin.ts

@@ -27,7 +27,7 @@ import {
   statusDescriptionTagName,
 } from './transform';
 import { OT_REQUEST_HEADER } from './utils';
-import { Resource, SERVICE_RESOURCE } from '@opentelemetry/resources';
+import { SERVICE_RESOURCE } from '@opentelemetry/resources';
 /**
  * Zipkin Exporter
  */

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

@@ -167,7 +167,7 @@ export class NodeSDK {
     if (this._tracerProviderConfig) {
       const tracerProvider = new NodeTracerProvider({
         ...this._tracerProviderConfig.tracerConfig,
-        resource: (this._detectResources() as unknown) as Resource,
+        resource: this._detectResources(),
       });
 
       tracerProvider.addSpanProcessor(this._tracerProviderConfig.spanProcessor);

packages/opentelemetry-tracing/src/BasicTracerProvider.ts

@@ -38,11 +38,18 @@ export class BasicTracerProvider implements api.TracerProvider {
 
   activeSpanProcessor = new NoopSpanProcessor();
   readonly logger: api.Logger;
-  readonly resource: Resource;
+  readonly resource: Promise<Resource>;
 
   constructor(config: TracerConfig = DEFAULT_CONFIG) {
     this.logger = config.logger ?? new ConsoleLogger(config.logLevel);
-    this.resource = config.resource ?? Resource.createTelemetrySDKResource();
+    if (config.resource) {
+      this.resource =
+        config.resource instanceof Promise
+          ? config.resource
+          : Promise.resolve(config.resource);
+    } else {
+      this.resource = Promise.resolve(Resource.createTelemetrySDKResource());
+    }
     this._config = Object.assign({}, config, {
       logger: this.logger,
       resource: this.resource,

packages/opentelemetry-tracing/src/Span.ts

@@ -23,15 +23,14 @@ import {
   timeInputToHrTime,
 } from '@opentelemetry/core';
 import { Resource } from '@opentelemetry/resources';
-import { ReadableSpan } from './export/ReadableSpan';
-import { Tracer } from './Tracer';
 import { SpanProcessor } from './SpanProcessor';
+import { Tracer } from './Tracer';
 import { TraceParams } from './types';
 
 /**
  * This class represents a span.
  */
-export class Span implements api.Span, ReadableSpan {
+export class Span implements api.Span {
   // Below properties are included to implement ReadableSpan for export
   // purposes but are not intended to be written-to directly.
   readonly spanContext: api.SpanContext;
@@ -41,7 +40,7 @@ export class Span implements api.Span, ReadableSpan {
   readonly links: api.Link[] = [];
   readonly events: api.TimedEvent[] = [];
   readonly startTime: api.HrTime;
-  resource: Resource;
+  private _resource: Resource | Promise<Resource>;
   readonly instrumentationLibrary: InstrumentationLibrary;
   name: string;
   status: api.Status = {
@@ -70,12 +69,15 @@ export class Span implements api.Span, ReadableSpan {
     this.kind = kind;
     this.links = links;
     this.startTime = timeInputToHrTime(startTime);
-    this.resource = parentTracer.resource;
+    this._resource = parentTracer.resource;
     this.instrumentationLibrary = parentTracer.instrumentationLibrary;
     this._logger = parentTracer.logger;
     this._traceParams = parentTracer.getActiveTraceParams();
     this._spanProcessor = parentTracer.getActiveSpanProcessor();
-    this._spanProcessor.onStart(this);
+
+    this._resolveResource().then(() => {
+      this._spanProcessor.onStart(this);
+    });
   }
 
   context(): api.SpanContext {
@@ -171,15 +173,9 @@ export class Span implements api.Span, ReadableSpan {
       );
     }
 
-    if (this.resource instanceof Promise) {
-      this.resource.then(resource => {
-        this.resource = resource;
-        this._spanProcessor.onEnd(this);
-      });
-      return;
-    }
-
-    this._spanProcessor.onEnd(this);
+    this._resolveResource().then(() => {
+      this._spanProcessor.onEnd(this);
+    });
   }
 
   isRecording(): boolean {
@@ -194,6 +190,13 @@ export class Span implements api.Span, ReadableSpan {
     return this._ended;
   }
 
+  get resource(): Resource {
+    if (this._resource instanceof Promise) {
+      return Resource.createTelemetrySDKResource();
+    }
+    return this._resource;
+  }
+
   private _isSpanEnded(): boolean {
     if (this._ended) {
       this._logger.warn(
@@ -204,4 +207,12 @@ export class Span implements api.Span, ReadableSpan {
     }
     return this._ended;
   }
+
+  private async _resolveResource() {
+    try {
+      this._resource = await this._resource;
+    } catch (err) {
+      this._logger.error(`Resource failed to resolve: ${err?.message}`);
+    }
+  }
 }

packages/opentelemetry-tracing/src/Tracer.ts

@@ -39,7 +39,8 @@ export class Tracer implements api.Tracer {
   private readonly _sampler: api.Sampler;
   private readonly _traceParams: TraceParams;
   private readonly _idGenerator: IdGenerator;
-  public resource: Resource;
+
+  public readonly resource: Promise<Resource>;
   readonly instrumentationLibrary: InstrumentationLibrary;
   readonly logger: api.Logger;
 
@@ -56,11 +57,6 @@ export class Tracer implements api.Tracer {
     this._traceParams = localConfig.traceParams;
     this._idGenerator = config.idGenerator || new RandomIdGenerator();
     this.resource = _tracerProvider.resource;
-    if (this.resource instanceof Promise) {
-      this.resource.then(resource => {
-        this.resource = resource;
-      });
-    }
     this.instrumentationLibrary = instrumentationLibrary;
     this.logger = config.logger || new ConsoleLogger(config.logLevel);
   }

packages/opentelemetry-tracing/src/types.ts

@@ -41,7 +41,7 @@ export interface TracerConfig {
   traceParams?: TraceParams;
 
   /** Resource associated with trace telemetry  */
-  resource?: Resource;
+  resource?: Resource | Promise<Resource>;
 
   /**
    * Generator of trace and span IDs