feat: pipe instrumentation library from Meter to MetricRecord

Author: mwear

packages/opentelemetry-metrics/src/Meter.ts

@@ -15,7 +15,7 @@
  */
 
 import * as api from '@opentelemetry/api';
-import { ConsoleLogger } from '@opentelemetry/core';
+import { ConsoleLogger, InstrumentationLibrary } from '@opentelemetry/core';
 import { Resource } from '@opentelemetry/resources';
 import { BaseBoundInstrument } from './BoundInstrument';
 import {
@@ -42,14 +42,19 @@ export class Meter implements api.Meter {
   private readonly _metrics = new Map<string, Metric<BaseBoundInstrument>>();
   private readonly _batcher: Batcher;
   private readonly _resource: Resource;
+  private readonly _instrumentationLibrary: InstrumentationLibrary;
 
   /**
    * Constructs a new Meter instance.
    */
-  constructor(config: MeterConfig = DEFAULT_CONFIG) {
+  constructor(
+    instrumentationLibrary: InstrumentationLibrary,
+    config: MeterConfig = DEFAULT_CONFIG
+  ) {
     this._logger = config.logger || new ConsoleLogger(config.logLevel);
     this._batcher = config.batcher ?? new UngroupedBatcher();
     this._resource = config.resource || Resource.createTelemetrySDKResource();
+    this._instrumentationLibrary = instrumentationLibrary;
     // start the push controller
     const exporter = config.exporter || new NoopExporter();
     const interval = config.interval;
@@ -83,7 +88,8 @@ export class Meter implements api.Meter {
       name,
       opt,
       this._batcher,
-      this._resource
+      this._resource,
+      this._instrumentationLibrary
     );
     this._registerMetric(name, valueRecorder);
     return valueRecorder;
@@ -110,7 +116,13 @@ export class Meter implements api.Meter {
       ...DEFAULT_METRIC_OPTIONS,
       ...options,
     };
-    const counter = new CounterMetric(name, opt, this._batcher, this._resource);
+    const counter = new CounterMetric(
+      name,
+      opt,
+      this._batcher,
+      this._resource,
+      this._instrumentationLibrary
+    );
     this._registerMetric(name, counter);
     return counter;
   }
@@ -138,7 +150,8 @@ export class Meter implements api.Meter {
       name,
       opt,
       this._batcher,
-      this._resource
+      this._resource,
+      this._instrumentationLibrary
     );
     this._registerMetric(name, observer);
     return observer;

packages/opentelemetry-metrics/src/MeterProvider.ts

@@ -46,7 +46,10 @@ export class MeterProvider implements api.MeterProvider {
   getMeter(name: string, version = '*', config?: MeterConfig): Meter {
     const key = `${name}@${version}`;
     if (!this._meters.has(key)) {
-      this._meters.set(key, new Meter(config || this._config));
+      this._meters.set(
+        key,
+        new Meter({ name, version }, config || this._config)
+      );
     }
 
     return this._meters.get(key)!;

packages/opentelemetry-metrics/src/Metric.ts

@@ -27,6 +27,7 @@ import { MetricOptions } from './types';
 import { MetricKind, MetricDescriptor, MetricRecord } from './export/types';
 import { Batcher } from './export/Batcher';
 import { hashLabels } from './Utils';
+import { InstrumentationLibrary } from '@opentelemetry/core';
 
 /** This is a SDK implementation of {@link Metric} interface. */
 export abstract class Metric<T extends BaseBoundInstrument>
@@ -42,7 +43,8 @@ export abstract class Metric<T extends BaseBoundInstrument>
     private readonly _name: string,
     private readonly _options: MetricOptions,
     private readonly _kind: MetricKind,
-    readonly resource: Resource
+    readonly resource: Resource,
+    readonly instrumentationLibrary: InstrumentationLibrary
   ) {
     this._monotonic = _options.monotonic;
     this._disabled = _options.disabled;
@@ -88,6 +90,7 @@ export abstract class Metric<T extends BaseBoundInstrument>
       labels: instrument.getLabels(),
       aggregator: instrument.getAggregator(),
       resource: this.resource,
+      instrumentationLibrary: this.instrumentationLibrary,
     }));
   }
 
@@ -111,9 +114,10 @@ export class CounterMetric extends Metric<BoundCounter> implements api.Counter {
     name: string,
     options: MetricOptions,
     private readonly _batcher: Batcher,
-    resource: Resource
+    resource: Resource,
+    instrumentationLibrary: InstrumentationLibrary
   ) {
-    super(name, options, MetricKind.COUNTER, resource);
+    super(name, options, MetricKind.COUNTER, resource, instrumentationLibrary);
   }
   protected _makeInstrument(labels: api.Labels): BoundCounter {
     return new BoundCounter(
@@ -146,9 +150,16 @@ export class ValueRecorderMetric extends Metric<BoundValueRecorder>
     name: string,
     options: MetricOptions,
     private readonly _batcher: Batcher,
-    resource: Resource
+    resource: Resource,
+    instrumentationLibrary: InstrumentationLibrary
   ) {
-    super(name, options, MetricKind.VALUE_RECORDER, resource);
+    super(
+      name,
+      options,
+      MetricKind.VALUE_RECORDER,
+      resource,
+      instrumentationLibrary
+    );
 
     this._absolute = options.absolute !== undefined ? options.absolute : true; // Absolute default is true
   }
@@ -178,9 +189,10 @@ export class ObserverMetric extends Metric<BoundObserver>
     name: string,
     options: MetricOptions,
     private readonly _batcher: Batcher,
-    resource: Resource
+    resource: Resource,
+    instrumentationLibrary: InstrumentationLibrary
   ) {
-    super(name, options, MetricKind.OBSERVER, resource);
+    super(name, options, MetricKind.OBSERVER, resource, instrumentationLibrary);
   }
 
   protected _makeInstrument(labels: api.Labels): BoundObserver {

packages/opentelemetry-metrics/src/export/types.ts

@@ -15,7 +15,7 @@
  */
 
 import { ValueType, HrTime, Labels } from '@opentelemetry/api';
-import { ExportResult } from '@opentelemetry/core';
+import { ExportResult, InstrumentationLibrary } from '@opentelemetry/core';
 import { Resource } from '@opentelemetry/resources';
 
 /** The kind of metric. */
@@ -74,6 +74,7 @@ export interface MetricRecord {
   readonly labels: Labels;
   readonly aggregator: Aggregator;
   readonly resource: Resource;
+  readonly instrumentationLibrary: InstrumentationLibrary;
 }
 
 export interface MetricDescriptor {

packages/opentelemetry-metrics/test/Meter.test.ts

@@ -115,6 +115,18 @@ describe('Meter', () => {
       assert.ok(record.resource instanceof Resource);
     });
 
+    it('should pipe through instrumentation library', () => {
+      const counter = meter.createCounter('name') as CounterMetric;
+      assert.ok(counter.instrumentationLibrary);
+
+      counter.add(1, { foo: 'bar' });
+
+      const [record] = counter.getMetricRecord();
+      const { name, version } = record.instrumentationLibrary;
+      assert.strictEqual(name, 'test-meter');
+      assert.strictEqual(version, '*');
+    });
+
     describe('.bind()', () => {
       it('should create a counter instrument', () => {
         const counter = meter.createCounter('name') as CounterMetric;
@@ -319,6 +331,20 @@ describe('Meter', () => {
       assert.ok(record.resource instanceof Resource);
     });
 
+    it('should pipe through instrumentation library', () => {
+      const valueRecorder = meter.createValueRecorder(
+        'name'
+      ) as ValueRecorderMetric;
+      assert.ok(valueRecorder.instrumentationLibrary);
+
+      valueRecorder.record(1, { foo: 'bar' });
+
+      const [record] = valueRecorder.getMetricRecord();
+      const { name, version } = record.instrumentationLibrary;
+      assert.strictEqual(name, 'test-meter');
+      assert.strictEqual(version, '*');
+    });
+
     describe('names', () => {
       it('should return no op metric if name is an empty string', () => {
         const valueRecorder = meter.createValueRecorder('');
@@ -537,6 +563,20 @@ describe('Meter', () => {
       const [record] = observer.getMetricRecord();
       assert.ok(record.resource instanceof Resource);
     });
+
+    it('should pipe through instrumentation library', () => {
+      const observer = meter.createObserver('name') as ObserverMetric;
+      assert.ok(observer.instrumentationLibrary);
+
+      observer.setCallback(result => {
+        result.observe(() => 42, { foo: 'bar' });
+      });
+
+      const [record] = observer.getMetricRecord();
+      const { name, version } = record.instrumentationLibrary;
+      assert.strictEqual(name, 'test-meter');
+      assert.strictEqual(version, '*');
+    });
   });
 
   describe('#getMetrics', () => {