fix: remove default version from Tracer/Meter (#1828)

According to spec the version is optional for Tracer and Meter. TracerProvider/MeterProvider should not add a default to ensure that exporters only export a version if supplied during creation.
open-telemetry · Jan 18, 2021 · 1a3f3f8 · 1a3f3f8
1 parent 471306f
commit 1a3f3f8
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 14 deletions.
diff --git a/packages/opentelemetry-core/src/common/types.ts b/packages/opentelemetry-core/src/common/types.ts
@@ -51,13 +51,13 @@ export interface ShimWrapped {
 }
 
 /**
- * An instrumentation library consists of the name and version used to
- * obtain a tracer or meter from a provider. This metadata is made available
- * on ReadableSpan and MetricRecord for use by the export pipeline.
+ * An instrumentation library consists of the name and and optional version
+ * used to obtain a tracer or meter from a provider. This metadata is made
+ * available on ReadableSpan and MetricRecord for use by the export pipeline.
  */
 export interface InstrumentationLibrary {
   readonly name: string;
-  readonly version: string;
+  readonly version?: string;
 }
 
 /** Defines an error handler function */

diff --git a/packages/opentelemetry-exporter-collector/src/types.ts b/packages/opentelemetry-exporter-collector/src/types.ts
@@ -311,7 +311,7 @@ export namespace opentelemetryProto {
 
     export interface InstrumentationLibrary {
       name: string;
-      version: string;
+      version?: string;
     }
 
     export interface StringKeyValue {

diff --git a/packages/opentelemetry-metrics/src/MeterProvider.ts b/packages/opentelemetry-metrics/src/MeterProvider.ts
@@ -50,8 +50,8 @@ export class MeterProvider implements api.MeterProvider {
    *
    * @returns Meter A Meter with the given name and version
    */
-  getMeter(name: string, version = '*', config?: MeterConfig): Meter {
-    const key = `${name}@${version}`;
+  getMeter(name: string, version?: string, config?: MeterConfig): Meter {
+    const key = `${name}@${version || ''}`;
     if (!this._meters.has(key)) {
       this._meters.set(
         key,

diff --git a/packages/opentelemetry-metrics/test/Meter.test.ts b/packages/opentelemetry-metrics/test/Meter.test.ts
@@ -154,7 +154,7 @@ describe('Meter', () => {
       const [record] = await counter.getMetricRecord();
       const { name, version } = record.instrumentationLibrary;
       assert.strictEqual(name, 'test-meter');
-      assert.strictEqual(version, '*');
+      assert.strictEqual(version, undefined);
     });
 
     describe('.bind()', () => {
@@ -607,7 +607,7 @@ describe('Meter', () => {
       const [record] = await valueRecorder.getMetricRecord();
       const { name, version } = record.instrumentationLibrary;
       assert.strictEqual(name, 'test-meter');
-      assert.strictEqual(version, '*');
+      assert.strictEqual(version, undefined);
     });
 
     describe('names', () => {
@@ -1297,7 +1297,7 @@ describe('Meter', () => {
       const [record] = await observer.getMetricRecord();
       const { name, version } = record.instrumentationLibrary;
       assert.strictEqual(name, 'test-meter');
-      assert.strictEqual(version, '*');
+      assert.strictEqual(version, undefined);
     });
   });
 

diff --git a/packages/opentelemetry-metrics/test/MeterProvider.test.ts b/packages/opentelemetry-metrics/test/MeterProvider.test.ts
@@ -51,7 +51,7 @@ describe('MeterProvider', () => {
     it('should return the meter with default version without a version option', () => {
       const provider = new MeterProvider();
       const meter1 = provider.getMeter('default');
-      const meter2 = provider.getMeter('default', '*');
+      const meter2 = provider.getMeter('default', undefined);
       assert.deepEqual(meter1, meter2);
     });
 

diff --git a/packages/opentelemetry-tracing/src/BasicTracerProvider.ts b/packages/opentelemetry-tracing/src/BasicTracerProvider.ts
@@ -52,8 +52,8 @@ export class BasicTracerProvider implements api.TracerProvider {
     });
   }
 
-  getTracer(name: string, version = '*', config?: TracerConfig): Tracer {
-    const key = `${name}@${version}`;
+  getTracer(name: string, version?: string, config?: TracerConfig): Tracer {
+    const key = `${name}@${version || ''}`;
     if (!this._tracers.has(key)) {
       this._tracers.set(
         key,

diff --git a/packages/opentelemetry-tracing/test/Span.test.ts b/packages/opentelemetry-tracing/test/Span.test.ts
@@ -393,7 +393,7 @@ describe('Span', () => {
     assert.ok(span.instrumentationLibrary);
     const { name, version } = span.instrumentationLibrary;
     assert.strictEqual(name, 'default');
-    assert.strictEqual(version, '*');
+    assert.strictEqual(version, undefined);
   });
 
   it('should return ReadableSpan with attributes', () => {