Skip to content

Commit b5d824c

Browse files
committed
Add check for duplicate instrument names
Fixes open-telemetry#2142
1 parent df3ffc3 commit b5d824c

4 files changed

Lines changed: 107 additions & 6 deletions

File tree

‎opentelemetry-api/src/opentelemetry/_metrics/__init__.py‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,11 @@ def version(self):
132132
def schema_url(self):
133133
return self._schema_url
134134

135-
# FIXME check that the instrument name has not been used already
135+
def _check_instrument_name(self, name):
136+
if name in self._instrument_names:
137+
raise Exception(f"Instrument name {name} has been used already")
138+
139+
self._instrument_names.add(name)
136140

137141
@abstractmethod
138142
def create_counter(self, name, unit="", description="") -> Counter:
@@ -144,6 +148,7 @@ def create_counter(self, name, unit="", description="") -> Counter:
144148
example, ``By`` for bytes. UCUM units are recommended.
145149
description: A description for this instrument and what it measures.
146150
"""
151+
self._check_instrument_name(name)
147152

148153
@abstractmethod
149154
def create_up_down_counter(
@@ -157,6 +162,7 @@ def create_up_down_counter(
157162
example, ``By`` for bytes. UCUM units are recommended.
158163
description: A description for this instrument and what it measures.
159164
"""
165+
self._check_instrument_name(name)
160166

161167
@abstractmethod
162168
def create_observable_counter(
@@ -240,6 +246,7 @@ def cpu_time_callback(states_to_include: set[str]) -> Iterable[Iterable[Measurem
240246
example, ``By`` for bytes. UCUM units are recommended.
241247
description: A description for this instrument and what it measures.
242248
"""
249+
self._check_instrument_name(name)
243250

244251
@abstractmethod
245252
def create_histogram(self, name, unit="", description="") -> Histogram:
@@ -251,6 +258,7 @@ def create_histogram(self, name, unit="", description="") -> Histogram:
251258
example, ``By`` for bytes. UCUM units are recommended.
252259
description: A description for this instrument and what it measures.
253260
"""
261+
self._check_instrument_name(name)
254262

255263
@abstractmethod
256264
def create_observable_gauge(
@@ -268,13 +276,13 @@ def create_observable_gauge(
268276
example, ``By`` for bytes. UCUM units are recommended.
269277
description: A description for this instrument and what it measures.
270278
"""
279+
self._check_instrument_name(name)
271280

272281
@abstractmethod
273282
def create_observable_up_down_counter(
274283
self, name, callback, unit="", description=""
275284
) -> ObservableUpDownCounter:
276-
"""Creates an `ObservableUpDownCounter` instrument
277-
285+
"""
278286
Args:
279287
name: The name of the instrument to be created
280288
callback: A callback that returns an iterable of
@@ -285,6 +293,7 @@ def create_observable_up_down_counter(
285293
example, ``By`` for bytes. UCUM units are recommended.
286294
description: A description for this instrument and what it measures.
287295
"""
296+
self._check_instrument_name(name)
288297

289298

290299
class _ProxyMeter(Meter):

‎opentelemetry-api/tests/metrics/test_meter.py‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,17 @@
1414
# type: ignore
1515

1616
from unittest import TestCase
17+
from unittest.mock import Mock
1718

1819
from opentelemetry._metrics import Meter
20+
from opentelemetry._metrics.instrument import (
21+
Counter,
22+
Histogram,
23+
ObservableCounter,
24+
ObservableGauge,
25+
ObservableUpDownCounter,
26+
UpDownCounter,
27+
)
1928

2029
# FIXME Test that the meter methods can be called concurrently safely.
2130

@@ -53,6 +62,75 @@ def create_observable_up_down_counter(
5362

5463

5564
class TestMeter(TestCase):
65+
def test_repeated_instrument_names(self):
66+
class TestMeter(Meter):
67+
def create_counter(self, name, unit="", description="") -> Counter:
68+
super().create_counter(
69+
name, unit=unit, description=description
70+
)
71+
72+
def create_up_down_counter(
73+
self, name, unit="", description=""
74+
) -> UpDownCounter:
75+
super().create_up_down_counter(
76+
name, unit=unit, description=description
77+
)
78+
79+
def create_observable_counter(
80+
self, name, callback, unit="", description=""
81+
) -> ObservableCounter:
82+
super().create_observable_up_down_counter(
83+
name, callback, unit=unit, description=description
84+
)
85+
86+
def create_histogram(
87+
self, name, unit="", description=""
88+
) -> Histogram:
89+
super().create_histogram(
90+
name, unit=unit, description=description
91+
)
92+
93+
def create_observable_gauge(
94+
self, name, callback, unit="", description=""
95+
) -> ObservableGauge:
96+
super().create_observable_gauge(
97+
name, callback, unit=unit, description=description
98+
)
99+
100+
def create_observable_up_down_counter(
101+
self, name, callback, unit="", description=""
102+
) -> ObservableUpDownCounter:
103+
super().create_observable_up_down_counter(
104+
name, callback, unit=unit, description=description
105+
)
106+
107+
try:
108+
test_meter = TestMeter("name")
109+
110+
test_meter.create_counter("counter")
111+
test_meter.create_up_down_counter("up_down_counter")
112+
test_meter.create_observable_counter("observable_counter", Mock())
113+
test_meter.create_histogram("histogram")
114+
test_meter.create_observable_gauge("observable_gauge", Mock())
115+
test_meter.create_observable_up_down_counter(
116+
"observable_up_down_counter", Mock()
117+
)
118+
except Exception as error:
119+
self.fail(f"Unexpected exception raised {error}")
120+
121+
for instrument_name in [
122+
"counter",
123+
"up_down_counter",
124+
"observable_counter",
125+
"histogram",
126+
"observable_gauge",
127+
"observable_up_down_counter",
128+
]:
129+
with self.assertRaises(Exception):
130+
getattr(test_meter, f"create_{instrument_name}")(
131+
instrument_name
132+
)
133+
56134
def test_create_counter(self):
57135
"""
58136
Test that the meter provides a function to create a new Counter

‎opentelemetry-sdk/src/opentelemetry/sdk/_metrics/__init__.py‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ def __init__(
6565
self._measurement_consumer = measurement_consumer
6666

6767
def create_counter(self, name, unit=None, description=None) -> APICounter:
68+
super().create_counter(name, unit=unit, description=description)
6869
return Counter(
6970
name,
7071
self._instrumentation_info,
@@ -76,6 +77,9 @@ def create_counter(self, name, unit=None, description=None) -> APICounter:
7677
def create_up_down_counter(
7778
self, name, unit=None, description=None
7879
) -> APIUpDownCounter:
80+
super().create_up_down_counter(
81+
name, unit=unit, description=description
82+
)
7983
return UpDownCounter(
8084
name,
8185
self._instrumentation_info,
@@ -87,6 +91,9 @@ def create_up_down_counter(
8791
def create_observable_counter(
8892
self, name, callback, unit=None, description=None
8993
) -> APIObservableCounter:
94+
super().create_observable_counter(
95+
name, callback, unit=unit, description=description
96+
)
9097

9198
instrument = ObservableCounter(
9299
name,
@@ -104,6 +111,7 @@ def create_observable_counter(
104111
def create_histogram(
105112
self, name, unit=None, description=None
106113
) -> APIHistogram:
114+
super().create_histogram(name, unit=unit, description=description)
107115
return Histogram(
108116
name,
109117
self._instrumentation_info,
@@ -115,6 +123,9 @@ def create_histogram(
115123
def create_observable_gauge(
116124
self, name, callback, unit=None, description=None
117125
) -> APIObservableGauge:
126+
super().create_observable_gauge(
127+
name, callback, unit=unit, description=description
128+
)
118129

119130
instrument = ObservableGauge(
120131
name,
@@ -132,6 +143,9 @@ def create_observable_gauge(
132143
def create_observable_up_down_counter(
133144
self, name, callback, unit=None, description=None
134145
) -> APIObservableUpDownCounter:
146+
super().create_observable_up_down_counter(
147+
name, callback, unit=unit, description=description
148+
)
135149

136150
instrument = ObservableUpDownCounter(
137151
name,

‎opentelemetry-sdk/tests/metrics/test_metrics.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -243,17 +243,17 @@ def test_register_asynchronous_instrument(
243243

244244
meter_provider._measurement_consumer.register_asynchronous_instrument.assert_called_with(
245245
meter_provider.get_meter("name").create_observable_counter(
246-
"name", Mock()
246+
"name0", Mock()
247247
)
248248
)
249249
meter_provider._measurement_consumer.register_asynchronous_instrument.assert_called_with(
250250
meter_provider.get_meter("name").create_observable_up_down_counter(
251-
"name", Mock()
251+
"name1", Mock()
252252
)
253253
)
254254
meter_provider._measurement_consumer.register_asynchronous_instrument.assert_called_with(
255255
meter_provider.get_meter("name").create_observable_gauge(
256-
"name", Mock()
256+
"name2", Mock()
257257
)
258258
)
259259

0 commit comments

Comments
 (0)