Return instrument_id in _InstrumentRegistrationStatus

Author: xrmx

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

@@ -46,7 +46,7 @@
 from logging import getLogger
 from os import environ
 from threading import Lock
-from typing import Dict, List, Optional, Sequence, Tuple, Union, cast
+from typing import Dict, List, Optional, Sequence, Union, cast
 
 from opentelemetry.environment_variables import OTEL_PYTHON_METER_PROVIDER
 from opentelemetry.metrics._internal.instrument import (
@@ -184,6 +184,7 @@ def on_set_meter_provider(self, meter_provider: MeterProvider) -> None:
 
 @dataclass
 class _InstrumentRegistrationStatus:
+    instrument_id: str
     already_registered: bool
     conflict: bool
     current_advisory: Optional[MetricsInstrumentAdvisory]
@@ -239,7 +240,7 @@ def _register_instrument(
         unit: str,
         description: str,
         advisory: Optional[MetricsInstrumentAdvisory] = None,
-    ) -> Tuple[str, _InstrumentRegistrationStatus]:
+    ) -> _InstrumentRegistrationStatus:
         """
         Register an instrument with the name, type, unit and description as
         identifying keys and the advisory as value.
@@ -269,8 +270,8 @@ def _register_instrument(
                 self._instrument_ids[instrument_id] = advisory
 
         return (
-            instrument_id,
             _InstrumentRegistrationStatus(
+                instrument_id=instrument_id,
                 already_registered=already_registered,
                 conflict=conflict,
                 current_advisory=current_advisory,
@@ -650,7 +651,7 @@ def create_counter(
         advisory: None = None,
     ) -> Counter:
         """Returns a no-op Counter."""
-        _, status = self._register_instrument(
+        status = self._register_instrument(
             name, NoOpCounter, unit, description, advisory
         )
         if status.conflict:
@@ -674,7 +675,7 @@ def create_gauge(
         advisory: None = None,
     ) -> Gauge:
         """Returns a no-op Gauge."""
-        _, status = self._register_instrument(
+        status = self._register_instrument(
             name, NoOpGauge, unit, description, advisory
         )
         if status.conflict:
@@ -698,7 +699,7 @@ def create_up_down_counter(
         advisory: None = None,
     ) -> UpDownCounter:
         """Returns a no-op UpDownCounter."""
-        _, status = self._register_instrument(
+        status = self._register_instrument(
             name, NoOpUpDownCounter, unit, description, advisory
         )
         if status.conflict:
@@ -723,7 +724,7 @@ def create_observable_counter(
         advisory: None = None,
     ) -> ObservableCounter:
         """Returns a no-op ObservableCounter."""
-        _, status = self._register_instrument(
+        status = self._register_instrument(
             name, NoOpObservableCounter, unit, description, advisory
         )
         if status.conflict:
@@ -752,7 +753,7 @@ def create_histogram(
         advisory: Optional[MetricsHistogramAdvisory] = None,
     ) -> Histogram:
         """Returns a no-op Histogram."""
-        _, status = self._register_instrument(
+        status = self._register_instrument(
             name, NoOpHistogram, unit, description, advisory
         )
         if status.conflict:
@@ -779,7 +780,7 @@ def create_observable_gauge(
         advisory: None = None,
     ) -> ObservableGauge:
         """Returns a no-op ObservableGauge."""
-        _, status = self._register_instrument(
+        status = self._register_instrument(
             name, NoOpObservableGauge, unit, description, advisory
         )
         if status.conflict:
@@ -809,7 +810,7 @@ def create_observable_up_down_counter(
         advisory: None = None,
     ) -> ObservableUpDownCounter:
         """Returns a no-op ObservableUpDownCounter."""
-        _, status = self._register_instrument(
+        status = self._register_instrument(
             name, NoOpObservableUpDownCounter, unit, description, advisory
         )
         if status.conflict:

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

@@ -93,10 +93,7 @@ def __init__(
     def create_counter(
         self, name, unit="", description="", advisory=None
     ) -> APICounter:
-        (
-            instrument_id,
-            status,
-        ) = self._register_instrument(
+        status = self._register_instrument(
             name, _Counter, unit, description, advisory
         )
 
@@ -116,7 +113,7 @@ def create_counter(
             )
         if status.already_registered:
             with self._instrument_id_instrument_lock:
-                return self._instrument_id_instrument[instrument_id]
+                return self._instrument_id_instrument[status.instrument_id]
 
         instrument = _Counter(
             name,
@@ -127,16 +124,13 @@ def create_counter(
         )
 
         with self._instrument_id_instrument_lock:
-            self._instrument_id_instrument[instrument_id] = instrument
+            self._instrument_id_instrument[status.instrument_id] = instrument
             return instrument
 
     def create_up_down_counter(
         self, name, unit="", description="", advisory=None
     ) -> APIUpDownCounter:
-        (
-            instrument_id,
-            status,
-        ) = self._register_instrument(
+        status = self._register_instrument(
             name, _UpDownCounter, unit, description, advisory
         )
 
@@ -156,7 +150,7 @@ def create_up_down_counter(
             )
         if status.already_registered:
             with self._instrument_id_instrument_lock:
-                return self._instrument_id_instrument[instrument_id]
+                return self._instrument_id_instrument[status.instrument_id]
 
         instrument = _UpDownCounter(
             name,
@@ -167,16 +161,13 @@ def create_up_down_counter(
         )
 
         with self._instrument_id_instrument_lock:
-            self._instrument_id_instrument[instrument_id] = instrument
+            self._instrument_id_instrument[status.instrument_id] = instrument
             return instrument
 
     def create_observable_counter(
         self, name, callbacks=None, unit="", description="", advisory=None
     ) -> APIObservableCounter:
-        (
-            instrument_id,
-            status,
-        ) = self._register_instrument(
+        status = self._register_instrument(
             name, _ObservableCounter, unit, description, advisory
         )
 
@@ -196,7 +187,7 @@ def create_observable_counter(
             )
         if status.already_registered:
             with self._instrument_id_instrument_lock:
-                return self._instrument_id_instrument[instrument_id]
+                return self._instrument_id_instrument[status.instrument_id]
 
         instrument = _ObservableCounter(
             name,
@@ -210,7 +201,7 @@ def create_observable_counter(
         self._measurement_consumer.register_asynchronous_instrument(instrument)
 
         with self._instrument_id_instrument_lock:
-            self._instrument_id_instrument[instrument_id] = instrument
+            self._instrument_id_instrument[status.instrument_id] = instrument
             return instrument
 
     def create_histogram(
@@ -237,10 +228,7 @@ def create_histogram(
                     "Advisory must be a dict with explicit_bucket_boundaries key containing a sequence of numbers"
                 )
 
-        (
-            instrument_id,
-            status,
-        ) = self._register_instrument(
+        status = self._register_instrument(
             name, _Histogram, unit, description, advisory
         )
 
@@ -260,7 +248,7 @@ def create_histogram(
             )
         if status.already_registered:
             with self._instrument_id_instrument_lock:
-                return self._instrument_id_instrument[instrument_id]
+                return self._instrument_id_instrument[status.instrument_id]
 
         instrument = _Histogram(
             name,
@@ -271,16 +259,13 @@ def create_histogram(
             advisory,
         )
         with self._instrument_id_instrument_lock:
-            self._instrument_id_instrument[instrument_id] = instrument
+            self._instrument_id_instrument[status.instrument_id] = instrument
             return instrument
 
     def create_gauge(
         self, name, unit="", description="", advisory=None
     ) -> APIGauge:
-        (
-            instrument_id,
-            status,
-        ) = self._register_instrument(
+        status = self._register_instrument(
             name, _Gauge, unit, description, advisory
         )
 
@@ -300,7 +285,7 @@ def create_gauge(
             )
         if status.already_registered:
             with self._instrument_id_instrument_lock:
-                return self._instrument_id_instrument[instrument_id]
+                return self._instrument_id_instrument[status.instrument_id]
 
         instrument = _Gauge(
             name,
@@ -311,16 +296,13 @@ def create_gauge(
         )
 
         with self._instrument_id_instrument_lock:
-            self._instrument_id_instrument[instrument_id] = instrument
+            self._instrument_id_instrument[status.instrument_id] = instrument
             return instrument
 
     def create_observable_gauge(
         self, name, callbacks=None, unit="", description="", advisory=None
     ) -> APIObservableGauge:
-        (
-            instrument_id,
-            status,
-        ) = self._register_instrument(
+        status = self._register_instrument(
             name, _ObservableGauge, unit, description, advisory
         )
 
@@ -340,7 +322,7 @@ def create_observable_gauge(
             )
         if status.already_registered:
             with self._instrument_id_instrument_lock:
-                return self._instrument_id_instrument[instrument_id]
+                return self._instrument_id_instrument[status.instrument_id]
 
         instrument = _ObservableGauge(
             name,
@@ -354,16 +336,13 @@ def create_observable_gauge(
         self._measurement_consumer.register_asynchronous_instrument(instrument)
 
         with self._instrument_id_instrument_lock:
-            self._instrument_id_instrument[instrument_id] = instrument
+            self._instrument_id_instrument[status.instrument_id] = instrument
             return instrument
 
     def create_observable_up_down_counter(
         self, name, callbacks=None, unit="", description="", advisory=None
     ) -> APIObservableUpDownCounter:
-        (
-            instrument_id,
-            status,
-        ) = self._register_instrument(
+        status = self._register_instrument(
             name, _ObservableUpDownCounter, unit, description, advisory
         )
 
@@ -383,7 +362,7 @@ def create_observable_up_down_counter(
             )
         if status.already_registered:
             with self._instrument_id_instrument_lock:
-                return self._instrument_id_instrument[instrument_id]
+                return self._instrument_id_instrument[status.instrument_id]
 
         instrument = _ObservableUpDownCounter(
             name,
@@ -397,7 +376,7 @@ def create_observable_up_down_counter(
         self._measurement_consumer.register_asynchronous_instrument(instrument)
 
         with self._instrument_id_instrument_lock:
-            self._instrument_id_instrument[instrument_id] = instrument
+            self._instrument_id_instrument[status.instrument_id] = instrument
             return instrument