Skip to content

Commit 8426501

Browse files
committed
Fix name of SDK Gauge
1 parent 87e5a4c commit 8426501

File tree

7 files changed

+17
-16
lines changed

7 files changed

+17
-16
lines changed

opentelemetry-api/src/opentelemetry/metrics/__init__.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,9 @@
5959
Histogram,
6060
Instrument,
6161
NoOpCounter,
62+
)
63+
from opentelemetry.metrics._internal.instrument import NoOpGauge as _NoOpGauge
64+
from opentelemetry.metrics._internal.instrument import (
6265
NoOpHistogram,
6366
NoOpObservableCounter,
6467
NoOpObservableGauge,
@@ -78,6 +81,7 @@
7881
Asynchronous,
7982
CallbackOptions,
8083
_Gauge,
84+
_NoOpGauge,
8185
get_meter_provider,
8286
get_meter,
8387
Histogram,
@@ -108,6 +112,7 @@
108112
"Meter",
109113
"Counter",
110114
"_Gauge",
115+
"_NoOpGauge",
111116
"NoOpCounter",
112117
"UpDownCounter",
113118
"NoOpUpDownCounter",

opentelemetry-api/src/opentelemetry/metrics/_internal/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -392,7 +392,7 @@ def create_gauge(
392392
unit: str = "",
393393
description: str = "",
394394
) -> Gauge:
395-
"""Creates a `Gauge` instrument
395+
"""Creates a ``Gauge`` instrument
396396
397397
Args:
398398
name: The name of the instrument to be created

opentelemetry-sdk/src/opentelemetry/sdk/metrics/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@
1515

1616
from opentelemetry.sdk.metrics._internal import Meter, MeterProvider
1717
from opentelemetry.sdk.metrics._internal.exceptions import MetricsTimeoutError
18+
from opentelemetry.sdk.metrics._internal.instrument import Counter
19+
from opentelemetry.sdk.metrics._internal.instrument import Gauge as _Gauge
1820
from opentelemetry.sdk.metrics._internal.instrument import (
19-
Counter,
20-
Gauge,
2121
Histogram,
2222
ObservableCounter,
2323
ObservableGauge,
@@ -31,7 +31,7 @@
3131
"MetricsTimeoutError",
3232
"Counter",
3333
"Histogram",
34-
"Gauge",
34+
"_Gauge",
3535
"ObservableCounter",
3636
"ObservableGauge",
3737
"ObservableUpDownCounter",

opentelemetry-sdk/tests/metrics/test_import.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@ def test_import_init(self):
2626
with self.assertNotRaises(Exception):
2727
from opentelemetry.sdk.metrics import ( # noqa: F401
2828
Counter,
29-
Gauge,
3029
Histogram,
3130
Meter,
3231
MeterProvider,
3332
ObservableCounter,
3433
ObservableGauge,
3534
ObservableUpDownCounter,
3635
UpDownCounter,
36+
_Gauge,
3737
)
3838

3939
def test_import_export(self):

opentelemetry-sdk/tests/metrics/test_instrument.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@
2020
from opentelemetry.metrics._internal.instrument import CallbackOptions
2121
from opentelemetry.sdk.metrics import (
2222
Counter,
23-
Gauge,
2423
Histogram,
2524
ObservableCounter,
2625
ObservableGauge,
2726
ObservableUpDownCounter,
2827
UpDownCounter,
2928
)
29+
from opentelemetry.sdk.metrics import _Gauge as _SDKGauge
3030
from opentelemetry.sdk.metrics._internal.instrument import (
3131
_Counter,
3232
_Gauge,
@@ -309,7 +309,7 @@ def test_set(self):
309309
def test_disallow_direct_counter_creation(self):
310310
with self.assertRaises(TypeError):
311311
# pylint: disable=abstract-class-instantiated
312-
Gauge("name", Mock(), Mock())
312+
_SDKGauge("name", Mock(), Mock())
313313

314314

315315
class TestObservableUpDownCounter(TestCase):

opentelemetry-sdk/tests/metrics/test_metric_reader.py

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,8 @@
1616
from unittest import TestCase
1717
from unittest.mock import patch
1818

19-
from opentelemetry.sdk.metrics import (
20-
Counter,
21-
Gauge,
22-
Histogram,
23-
ObservableGauge,
24-
)
19+
from opentelemetry.sdk.metrics import Counter, Histogram, ObservableGauge
20+
from opentelemetry.sdk.metrics import _Gauge as _SDKGauge
2521
from opentelemetry.sdk.metrics._internal.instrument import (
2622
_Counter,
2723
_Gauge,
@@ -83,7 +79,7 @@ def test_configure_temporality(self):
8379
preferred_temporality={
8480
Histogram: AggregationTemporality.DELTA,
8581
ObservableGauge: AggregationTemporality.DELTA,
86-
Gauge: AggregationTemporality.DELTA,
82+
_SDKGauge: AggregationTemporality.DELTA,
8783
}
8884
)
8985

opentelemetry-sdk/tests/metrics/test_metrics.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@
2121
from opentelemetry.metrics import NoOpMeter
2222
from opentelemetry.sdk.metrics import (
2323
Counter,
24-
Gauge,
2524
Histogram,
2625
Meter,
2726
MeterProvider,
2827
ObservableCounter,
2928
ObservableGauge,
3029
ObservableUpDownCounter,
3130
UpDownCounter,
31+
_Gauge,
3232
)
3333
from opentelemetry.sdk.metrics._internal import SynchronousMeasurementConsumer
3434
from opentelemetry.sdk.metrics.export import (
@@ -448,7 +448,7 @@ def test_create_gauge(self):
448448
"name", unit="unit", description="description"
449449
)
450450

451-
self.assertIsInstance(gauge, Gauge)
451+
self.assertIsInstance(gauge, _Gauge)
452452
self.assertEqual(gauge.name, "name")
453453

454454
def test_create_observable_up_down_counter(self):

0 commit comments

Comments
 (0)