Make synchronous gauge private for opentelemetry API

open-telemetry · Feb 5, 2024 · 86f615c · 86f615c
1 parent 472a98b
commit 86f615c
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 11 deletions.
diff --git a/opentelemetry-api/src/opentelemetry/metrics/__init__.py b/opentelemetry-api/src/opentelemetry/metrics/__init__.py
@@ -53,7 +53,9 @@
     CallbackOptions,
     CallbackT,
     Counter,
-    Gauge,
+)
+from opentelemetry.metrics._internal.instrument import Gauge as _Gauge
+from opentelemetry.metrics._internal.instrument import (
     Histogram,
     Instrument,
     NoOpCounter,
@@ -75,7 +77,7 @@
     Synchronous,
     Asynchronous,
     CallbackOptions,
-    Gauge,
+    _Gauge,
     get_meter_provider,
     get_meter,
     Histogram,
@@ -105,7 +107,7 @@
     "NoOpMeterProvider",
     "Meter",
     "Counter",
-    "Gauge",
+    "_Gauge",
     "NoOpCounter",
     "UpDownCounter",
     "NoOpUpDownCounter",

diff --git a/opentelemetry-api/tests/metrics/test_instruments.py b/opentelemetry-api/tests/metrics/test_instruments.py
@@ -18,7 +18,6 @@
 
 from opentelemetry.metrics import (
     Counter,
-    Gauge,
     Histogram,
     Instrument,
     Meter,
@@ -30,6 +29,7 @@
     ObservableGauge,
     ObservableUpDownCounter,
     UpDownCounter,
+    _Gauge,
 )
 
 # FIXME Test that the instrument methods can be called concurrently safely.
@@ -285,15 +285,15 @@ def test_create_gauge(self):
         """
 
         self.assertTrue(
-            isinstance(NoOpMeter("name").create_gauge("name"), Gauge)
+            isinstance(NoOpMeter("name").create_gauge("name"), _Gauge)
         )
 
     def test_api_gauge_abstract(self):
         """
         Test that the API Gauge is an abstract class.
         """
 
-        self.assertTrue(isabstract(Gauge))
+        self.assertTrue(isabstract(_Gauge))
 
     def test_create_gauge_api(self):
         """

diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/metrics/_internal/__init__.py b/opentelemetry-sdk/src/opentelemetry/sdk/metrics/_internal/__init__.py
@@ -21,7 +21,6 @@
 # This kind of import is needed to avoid Sphinx errors.
 import opentelemetry.sdk.metrics
 from opentelemetry.metrics import Counter as APICounter
-from opentelemetry.metrics import Gauge as APIGauge
 from opentelemetry.metrics import Histogram as APIHistogram
 from opentelemetry.metrics import Meter as APIMeter
 from opentelemetry.metrics import MeterProvider as APIMeterProvider
@@ -32,6 +31,7 @@
     ObservableUpDownCounter as APIObservableUpDownCounter,
 )
 from opentelemetry.metrics import UpDownCounter as APIUpDownCounter
+from opentelemetry.metrics import _Gauge as APIGauge
 from opentelemetry.sdk.metrics._internal.exceptions import MetricsTimeoutError
 from opentelemetry.sdk.metrics._internal.instrument import (
     _Counter,

diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/metrics/_internal/aggregation.py b/opentelemetry-sdk/src/opentelemetry/sdk/metrics/_internal/aggregation.py
@@ -25,14 +25,14 @@
 from opentelemetry.metrics import (
     Asynchronous,
     Counter,
-    Gauge,
     Histogram,
     Instrument,
     ObservableCounter,
     ObservableGauge,
     ObservableUpDownCounter,
     Synchronous,
     UpDownCounter,
+    _Gauge,
 )
 from opentelemetry.sdk.metrics._internal.exponential_histogram.buckets import (
     Buckets,
@@ -1047,7 +1047,7 @@ class DefaultAggregation(Aggregation):
     `opentelemetry.sdk.metrics.ObservableCounter`        `SumAggregation`
     `opentelemetry.sdk.metrics.ObservableUpDownCounter`  `SumAggregation`
     `opentelemetry.sdk.metrics.Histogram`                `ExplicitBucketHistogramAggregation`
-    `opentelemetry.sdk.metrics.Gauge`                    `LastValueAggregation`
+    `opentelemetry.sdk.metrics._Gauge`                    `LastValueAggregation`
     `opentelemetry.sdk.metrics.ObservableGauge`          `LastValueAggregation`
     ==================================================== ====================================
     """
@@ -1107,7 +1107,7 @@ def _create_aggregation(
         if isinstance(instrument, ObservableGauge):
             return _LastValueAggregation(attributes)
 
-        if isinstance(instrument, Gauge):
+        if isinstance(instrument, _Gauge):
             return _LastValueAggregation(attributes)
 
         raise Exception(f"Invalid instrument type {type(instrument)} found")

diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/metrics/_internal/instrument.py b/opentelemetry-sdk/src/opentelemetry/sdk/metrics/_internal/instrument.py
@@ -21,14 +21,14 @@
 import opentelemetry.sdk.metrics
 from opentelemetry.metrics import CallbackT
 from opentelemetry.metrics import Counter as APICounter
-from opentelemetry.metrics import Gauge as APIGauge
 from opentelemetry.metrics import Histogram as APIHistogram
 from opentelemetry.metrics import ObservableCounter as APIObservableCounter
 from opentelemetry.metrics import ObservableGauge as APIObservableGauge
 from opentelemetry.metrics import (
     ObservableUpDownCounter as APIObservableUpDownCounter,
 )
 from opentelemetry.metrics import UpDownCounter as APIUpDownCounter
+from opentelemetry.metrics import _Gauge as APIGauge
 from opentelemetry.metrics._internal.instrument import CallbackOptions
 from opentelemetry.sdk.metrics._internal.measurement import Measurement
 from opentelemetry.sdk.util.instrumentation import InstrumentationScope