Skip to content

Commit 87e5a4c

Browse files
sarafonseca-123ocelotl
authored andcommitted
Make synchronous gauge private for opentelemetry API
1 parent 2c422b2 commit 87e5a4c

File tree

5 files changed

+13
-11
lines changed

5 files changed

+13
-11
lines changed

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,9 @@
5353
CallbackOptions,
5454
CallbackT,
5555
Counter,
56-
Gauge,
56+
)
57+
from opentelemetry.metrics._internal.instrument import Gauge as _Gauge
58+
from opentelemetry.metrics._internal.instrument import (
5759
Histogram,
5860
Instrument,
5961
NoOpCounter,
@@ -75,7 +77,7 @@
7577
Synchronous,
7678
Asynchronous,
7779
CallbackOptions,
78-
Gauge,
80+
_Gauge,
7981
get_meter_provider,
8082
get_meter,
8183
Histogram,
@@ -105,7 +107,7 @@
105107
"NoOpMeterProvider",
106108
"Meter",
107109
"Counter",
108-
"Gauge",
110+
"_Gauge",
109111
"NoOpCounter",
110112
"UpDownCounter",
111113
"NoOpUpDownCounter",

opentelemetry-api/tests/metrics/test_instruments.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818

1919
from opentelemetry.metrics import (
2020
Counter,
21-
Gauge,
2221
Histogram,
2322
Instrument,
2423
Meter,
@@ -30,6 +29,7 @@
3029
ObservableGauge,
3130
ObservableUpDownCounter,
3231
UpDownCounter,
32+
_Gauge,
3333
)
3434

3535
# FIXME Test that the instrument methods can be called concurrently safely.
@@ -285,15 +285,15 @@ def test_create_gauge(self):
285285
"""
286286

287287
self.assertTrue(
288-
isinstance(NoOpMeter("name").create_gauge("name"), Gauge)
288+
isinstance(NoOpMeter("name").create_gauge("name"), _Gauge)
289289
)
290290

291291
def test_api_gauge_abstract(self):
292292
"""
293293
Test that the API Gauge is an abstract class.
294294
"""
295295

296-
self.assertTrue(isabstract(Gauge))
296+
self.assertTrue(isabstract(_Gauge))
297297

298298
def test_create_gauge_api(self):
299299
"""

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121
# This kind of import is needed to avoid Sphinx errors.
2222
import opentelemetry.sdk.metrics
2323
from opentelemetry.metrics import Counter as APICounter
24-
from opentelemetry.metrics import Gauge as APIGauge
2524
from opentelemetry.metrics import Histogram as APIHistogram
2625
from opentelemetry.metrics import Meter as APIMeter
2726
from opentelemetry.metrics import MeterProvider as APIMeterProvider
@@ -32,6 +31,7 @@
3231
ObservableUpDownCounter as APIObservableUpDownCounter,
3332
)
3433
from opentelemetry.metrics import UpDownCounter as APIUpDownCounter
34+
from opentelemetry.metrics import _Gauge as APIGauge
3535
from opentelemetry.sdk.metrics._internal.exceptions import MetricsTimeoutError
3636
from opentelemetry.sdk.metrics._internal.instrument import (
3737
_Counter,

opentelemetry-sdk/src/opentelemetry/sdk/metrics/_internal/aggregation.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,14 @@
2525
from opentelemetry.metrics import (
2626
Asynchronous,
2727
Counter,
28-
Gauge,
2928
Histogram,
3029
Instrument,
3130
ObservableCounter,
3231
ObservableGauge,
3332
ObservableUpDownCounter,
3433
Synchronous,
3534
UpDownCounter,
35+
_Gauge,
3636
)
3737
from opentelemetry.sdk.metrics._internal.exponential_histogram.buckets import (
3838
Buckets,
@@ -1047,7 +1047,7 @@ class DefaultAggregation(Aggregation):
10471047
`opentelemetry.sdk.metrics.ObservableCounter` `SumAggregation`
10481048
`opentelemetry.sdk.metrics.ObservableUpDownCounter` `SumAggregation`
10491049
`opentelemetry.sdk.metrics.Histogram` `ExplicitBucketHistogramAggregation`
1050-
`opentelemetry.sdk.metrics.Gauge` `LastValueAggregation`
1050+
`opentelemetry.sdk.metrics._Gauge` `LastValueAggregation`
10511051
`opentelemetry.sdk.metrics.ObservableGauge` `LastValueAggregation`
10521052
==================================================== ====================================
10531053
"""
@@ -1107,7 +1107,7 @@ def _create_aggregation(
11071107
if isinstance(instrument, ObservableGauge):
11081108
return _LastValueAggregation(attributes)
11091109

1110-
if isinstance(instrument, Gauge):
1110+
if isinstance(instrument, _Gauge):
11111111
return _LastValueAggregation(attributes)
11121112

11131113
raise Exception(f"Invalid instrument type {type(instrument)} found")

opentelemetry-sdk/src/opentelemetry/sdk/metrics/_internal/instrument.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@
2121
import opentelemetry.sdk.metrics
2222
from opentelemetry.metrics import CallbackT
2323
from opentelemetry.metrics import Counter as APICounter
24-
from opentelemetry.metrics import Gauge as APIGauge
2524
from opentelemetry.metrics import Histogram as APIHistogram
2625
from opentelemetry.metrics import ObservableCounter as APIObservableCounter
2726
from opentelemetry.metrics import ObservableGauge as APIObservableGauge
2827
from opentelemetry.metrics import (
2928
ObservableUpDownCounter as APIObservableUpDownCounter,
3029
)
3130
from opentelemetry.metrics import UpDownCounter as APIUpDownCounter
31+
from opentelemetry.metrics import _Gauge as APIGauge
3232
from opentelemetry.metrics._internal.instrument import CallbackOptions
3333
from opentelemetry.sdk.metrics._internal.measurement import Measurement
3434
from opentelemetry.sdk.util.instrumentation import InstrumentationScope

0 commit comments

Comments
 (0)