Fix name of SDK Gauge

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

Hide file tree

Showing 8 changed files with 18 additions and 17 deletions.
diff --git a/opentelemetry-api/src/opentelemetry/metrics/__init__.py b/opentelemetry-api/src/opentelemetry/metrics/__init__.py
@@ -59,6 +59,9 @@
     Histogram,
     Instrument,
     NoOpCounter,
+)
+from opentelemetry.metrics._internal.instrument import NoOpGauge as _NoOpGauge
+from opentelemetry.metrics._internal.instrument import (
     NoOpHistogram,
     NoOpObservableCounter,
     NoOpObservableGauge,
@@ -78,6 +81,7 @@
     Asynchronous,
     CallbackOptions,
     _Gauge,
+    _NoOpGauge,
     get_meter_provider,
     get_meter,
     Histogram,
@@ -108,6 +112,7 @@
     "Meter",
     "Counter",
     "_Gauge",
+    "_NoOpGauge",
     "NoOpCounter",
     "UpDownCounter",
     "NoOpUpDownCounter",

diff --git a/opentelemetry-api/src/opentelemetry/metrics/_internal/__init__.py b/opentelemetry-api/src/opentelemetry/metrics/_internal/__init__.py
@@ -392,7 +392,7 @@ def create_gauge(
         unit: str = "",
         description: str = "",
     ) -> Gauge:
-        """Creates a `Gauge` instrument
+        """Creates a ``Gauge`` instrument
 
         Args:
             name: The name of the instrument to be created

diff --git a/opentelemetry-api/src/opentelemetry/metrics/_internal/instrument.py b/opentelemetry-api/src/opentelemetry/metrics/_internal/instrument.py
@@ -411,7 +411,7 @@ def set(
 
 
 class NoOpGauge(Gauge):
-    """No-op implementation of `Gauge`."""
+    """No-op implementation of ``Gauge``."""
 
     def __init__(
         self,

diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/metrics/__init__.py b/opentelemetry-sdk/src/opentelemetry/sdk/metrics/__init__.py
@@ -15,9 +15,9 @@
 
 from opentelemetry.sdk.metrics._internal import Meter, MeterProvider
 from opentelemetry.sdk.metrics._internal.exceptions import MetricsTimeoutError
+from opentelemetry.sdk.metrics._internal.instrument import Counter
+from opentelemetry.sdk.metrics._internal.instrument import Gauge as _Gauge
 from opentelemetry.sdk.metrics._internal.instrument import (
-    Counter,
-    Gauge,
     Histogram,
     ObservableCounter,
     ObservableGauge,
@@ -31,7 +31,7 @@
     "MetricsTimeoutError",
     "Counter",
     "Histogram",
-    "Gauge",
+    "_Gauge",
     "ObservableCounter",
     "ObservableGauge",
     "ObservableUpDownCounter",

diff --git a/opentelemetry-sdk/tests/metrics/test_import.py b/opentelemetry-sdk/tests/metrics/test_import.py
@@ -26,14 +26,14 @@ def test_import_init(self):
         with self.assertNotRaises(Exception):
             from opentelemetry.sdk.metrics import (  # noqa: F401
                 Counter,
-                Gauge,
                 Histogram,
                 Meter,
                 MeterProvider,
                 ObservableCounter,
                 ObservableGauge,
                 ObservableUpDownCounter,
                 UpDownCounter,
+                _Gauge,
             )
 
     def test_import_export(self):

diff --git a/opentelemetry-sdk/tests/metrics/test_instrument.py b/opentelemetry-sdk/tests/metrics/test_instrument.py
@@ -20,13 +20,13 @@
 from opentelemetry.metrics._internal.instrument import CallbackOptions
 from opentelemetry.sdk.metrics import (
     Counter,
-    Gauge,
     Histogram,
     ObservableCounter,
     ObservableGauge,
     ObservableUpDownCounter,
     UpDownCounter,
 )
+from opentelemetry.sdk.metrics import _Gauge as _SDKGauge
 from opentelemetry.sdk.metrics._internal.instrument import (
     _Counter,
     _Gauge,
@@ -309,7 +309,7 @@ def test_set(self):
     def test_disallow_direct_counter_creation(self):
         with self.assertRaises(TypeError):
             # pylint: disable=abstract-class-instantiated
-            Gauge("name", Mock(), Mock())
+            _SDKGauge("name", Mock(), Mock())
 
 
 class TestObservableUpDownCounter(TestCase):

diff --git a/opentelemetry-sdk/tests/metrics/test_metric_reader.py b/opentelemetry-sdk/tests/metrics/test_metric_reader.py
@@ -16,12 +16,8 @@
 from unittest import TestCase
 from unittest.mock import patch
 
-from opentelemetry.sdk.metrics import (
-    Counter,
-    Gauge,
-    Histogram,
-    ObservableGauge,
-)
+from opentelemetry.sdk.metrics import Counter, Histogram, ObservableGauge
+from opentelemetry.sdk.metrics import _Gauge as _SDKGauge
 from opentelemetry.sdk.metrics._internal.instrument import (
     _Counter,
     _Gauge,
@@ -83,7 +79,7 @@ def test_configure_temporality(self):
             preferred_temporality={
                 Histogram: AggregationTemporality.DELTA,
                 ObservableGauge: AggregationTemporality.DELTA,
-                Gauge: AggregationTemporality.DELTA,
+                _SDKGauge: AggregationTemporality.DELTA,
             }
         )
 

diff --git a/opentelemetry-sdk/tests/metrics/test_metrics.py b/opentelemetry-sdk/tests/metrics/test_metrics.py
@@ -21,14 +21,14 @@
 from opentelemetry.metrics import NoOpMeter
 from opentelemetry.sdk.metrics import (
     Counter,
-    Gauge,
     Histogram,
     Meter,
     MeterProvider,
     ObservableCounter,
     ObservableGauge,
     ObservableUpDownCounter,
     UpDownCounter,
+    _Gauge,
 )
 from opentelemetry.sdk.metrics._internal import SynchronousMeasurementConsumer
 from opentelemetry.sdk.metrics.export import (
@@ -448,7 +448,7 @@ def test_create_gauge(self):
             "name", unit="unit", description="description"
         )
 
-        self.assertIsInstance(gauge, Gauge)
+        self.assertIsInstance(gauge, _Gauge)
         self.assertEqual(gauge.name, "name")
 
     def test_create_observable_up_down_counter(self):