fixup! feat(instrumentation): added synchronous gauge

open-telemetry · May 18, 2024 · c40fc1d · c40fc1d
1 parent 40dcded
commit c40fc1d
Show file tree

Hide file tree

Showing 4 changed files with 3 additions and 20 deletions.
diff --git a/api/src/metrics/NoopMeter.ts b/api/src/metrics/NoopMeter.ts
@@ -40,7 +40,7 @@ export class NoopMeter implements Meter {
   /**
    * @see {@link Meter.createGauge}
    */
-  createGauge(_name: string, _options?: MetricOptions): Histogram {
+  createGauge(_name: string, _options?: MetricOptions): Gauge {
     return NOOP_GAUGE_METRIC;
   }
 

diff --git a/packages/sdk-metrics/src/Instruments.ts b/packages/sdk-metrics/src/Instruments.ts
@@ -28,6 +28,7 @@ import {
   ObservableCounter,
   ObservableGauge,
   ObservableUpDownCounter,
+  Gauge,
 } from '@opentelemetry/api';
 import { millisToHrTime } from '@opentelemetry/core';
 import { InstrumentDescriptor } from './InstrumentDescriptor';
@@ -36,7 +37,6 @@ import {
   AsyncWritableMetricStorage,
   WritableMetricStorage,
 } from './state/WritableMetricStorage';
-import { Gauge } from './types';
 
 export class SyncInstrument {
   constructor(

diff --git a/packages/sdk-metrics/src/Meter.ts b/packages/sdk-metrics/src/Meter.ts
@@ -26,6 +26,7 @@ import {
   BatchObservableCallback,
   Observable,
   Attributes,
+  Gauge,
 } from '@opentelemetry/api';
 import {
   createInstrumentDescriptor,
@@ -41,7 +42,6 @@ import {
   UpDownCounterInstrument,
 } from './Instruments';
 import { MeterSharedState } from './state/MeterSharedState';
-import { Gauge } from './types';
 
 /**
  * This class implements the {@link IMeter} interface.
@@ -51,7 +51,6 @@ export class Meter implements IMeter {
 
   /**
    * Create a {@link Gauge} instrument.
-   * @experimental
    */
   createGauge<AttributesTypes extends Attributes = Attributes>(
     name: string,

diff --git a/packages/sdk-metrics/src/types.ts b/packages/sdk-metrics/src/types.ts
@@ -13,7 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Context, MetricAttributes } from '@opentelemetry/api';
 
 export type CommonReaderOptions = {
   timeoutMillis?: number;
@@ -24,18 +23,3 @@ export type CollectionOptions = CommonReaderOptions;
 export type ShutdownOptions = CommonReaderOptions;
 
 export type ForceFlushOptions = CommonReaderOptions;
-
-/**
- * @experimental
- *
- * This is intentionally not using the API's type as it's only available from @opentelemetry/api 1.9.0 and up.
- * In SDK 2.0 we'll be able to bump the minimum API version and remove this workaround.
- */
-export interface Gauge<
-  AttributesTypes extends MetricAttributes = MetricAttributes,
-> {
-  /**
-   * Records a measurement. Value of the measurement must not be negative.
-   */
-  record(value: number, attributes?: AttributesTypes, context?: Context): void;
-}