Centralize instrument registration conflict logging

Author: xrmx

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

@@ -277,6 +277,25 @@ def _register_instrument(
             current_advisory=current_advisory,
         )
 
+    @staticmethod
+    def _log_instrument_registration_conflict(
+        name: str,
+        instrumentation_type: str,
+        unit: str,
+        description: str,
+        status: _InstrumentRegistrationStatus,
+    ):
+        _logger.warning(
+            "An instrument with name %s, type %s, unit %s and "
+            "description %s has been created already with a "
+            "different advisory value %s.",
+            name,
+            Counter.__name__,
+            unit,
+            description,
+            status.current_advisory,
+        )
+
     @abstractmethod
     def create_counter(
         self,
@@ -654,16 +673,14 @@ def create_counter(
             name, NoOpCounter, unit, description, advisory
         )
         if status.conflict:
-            _logger.warning(
-                "An instrument with name %s, type %s, unit %s and "
-                "description %s has been created already with a "
-                "different advisory value %s.",
+            self._log_instrument_registration_conflict(
                 name,
                 Counter.__name__,
                 unit,
                 description,
-                status.current_advisory,
+                status,
             )
+
         return NoOpCounter(name, unit=unit, description=description)
 
     def create_gauge(
@@ -678,15 +695,12 @@ def create_gauge(
             name, NoOpGauge, unit, description, advisory
         )
         if status.conflict:
-            _logger.warning(
-                "An instrument with name %s, type %s, unit %s and "
-                "description %s has been created already with a "
-                "different advisory value %s.",
+            self._log_instrument_registration_conflict(
                 name,
                 Gauge.__name__,
                 unit,
                 description,
-                status.current_advisory,
+                status,
             )
         return NoOpGauge(name, unit=unit, description=description)
 
@@ -702,15 +716,12 @@ def create_up_down_counter(
             name, NoOpUpDownCounter, unit, description, advisory
         )
         if status.conflict:
-            _logger.warning(
-                "An instrument with name %s, type %s, unit %s and "
-                "description %s has been created already with a "
-                "different advisory value %s.",
+            self._log_instrument_registration_conflict(
                 name,
                 UpDownCounter.__name__,
                 unit,
                 description,
-                status.current_advisory,
+                status,
             )
         return NoOpUpDownCounter(name, unit=unit, description=description)
 
@@ -727,15 +738,12 @@ def create_observable_counter(
             name, NoOpObservableCounter, unit, description, advisory
         )
         if status.conflict:
-            _logger.warning(
-                "An instrument with name %s, type %s, unit %s and "
-                "description %s has been created already with a "
-                "different advisory value %s.",
+            self._log_instrument_registration_conflict(
                 name,
                 ObservableCounter.__name__,
                 unit,
                 description,
-                status.current_advisory,
+                status,
             )
         return NoOpObservableCounter(
             name,
@@ -756,15 +764,12 @@ def create_histogram(
             name, NoOpHistogram, unit, description, advisory
         )
         if status.conflict:
-            _logger.warning(
-                "An instrument with name %s, type %s, unit %s and "
-                "description %s has been created already with a "
-                "different advisory value %s.",
+            self._log_instrument_registration_conflict(
                 name,
                 Histogram.__name__,
                 unit,
                 description,
-                status.current_advisory,
+                status,
             )
         return NoOpHistogram(
             name, unit=unit, description=description, advisory=advisory
@@ -783,15 +788,12 @@ def create_observable_gauge(
             name, NoOpObservableGauge, unit, description, advisory
         )
         if status.conflict:
-            _logger.warning(
-                "An instrument with name %s, type %s, unit %s and "
-                "description %s has been created already with a "
-                "different advisory value %s.",
+            self._log_instrument_registration_conflict(
                 name,
                 ObservableGauge.__name__,
                 unit,
                 description,
-                status.current_advisory,
+                status,
             )
         return NoOpObservableGauge(
             name,
@@ -813,15 +815,12 @@ def create_observable_up_down_counter(
             name, NoOpObservableUpDownCounter, unit, description, advisory
         )
         if status.conflict:
-            _logger.warning(
-                "An instrument with name %s, type %s, unit %s and "
-                "description %s has been created already with a "
-                "different advisory value %s.",
+            self._log_instrument_registration_conflict(
                 name,
                 ObservableUpDownCounter.__name__,
                 unit,
                 description,
-                status.current_advisory,
+                status,
             )
         return NoOpObservableUpDownCounter(
             name,

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

@@ -101,15 +101,12 @@ def create_counter(
             # FIXME #2558 go through all views here and check if this
             # instrument registration conflict can be fixed. If it can be, do
             # not log the following warning.
-            _logger.warning(
-                "An instrument with name %s, type %s, unit %s and "
-                "description %s has been created already with a "
-                "different advisory value %s.",
+            self._log_instrument_registration_conflict(
                 name,
                 APICounter.__name__,
                 unit,
                 description,
-                status.current_advisory,
+                status,
             )
         if status.already_registered:
             with self._instrument_id_instrument_lock:
@@ -138,15 +135,12 @@ def create_up_down_counter(
             # FIXME #2558 go through all views here and check if this
             # instrument registration conflict can be fixed. If it can be, do
             # not log the following warning.
-            _logger.warning(
-                "An instrument with name %s, type %s, unit %s and "
-                "description %s has been created already with a "
-                "different advisory value %s.",
+            self._log_instrument_registration_conflict(
                 name,
                 APIUpDownCounter.__name__,
                 unit,
                 description,
-                status.current_advisory,
+                status,
             )
         if status.already_registered:
             with self._instrument_id_instrument_lock:
@@ -175,15 +169,12 @@ def create_observable_counter(
             # FIXME #2558 go through all views here and check if this
             # instrument registration conflict can be fixed. If it can be, do
             # not log the following warning.
-            _logger.warning(
-                "An instrument with name %s, type %s, unit %s and "
-                "description %s has been created already with a "
-                "different advisory value %s.",
+            self._log_instrument_registration_conflict(
                 name,
                 APIObservableCounter.__name__,
                 unit,
                 description,
-                status.current_advisory,
+                status,
             )
         if status.already_registered:
             with self._instrument_id_instrument_lock:
@@ -236,15 +227,12 @@ def create_histogram(
             # FIXME #2558 go through all views here and check if this
             # instrument registration conflict can be fixed. If it can be, do
             # not log the following warning.
-            _logger.warning(
-                "An instrument with name %s, type %s, unit %s and "
-                "description %s has been created already with a "
-                "different advisory value %s.",
+            self._log_instrument_registration_conflict(
                 name,
                 APIHistogram.__name__,
                 unit,
                 description,
-                status.current_advisory,
+                status,
             )
         if status.already_registered:
             with self._instrument_id_instrument_lock:
@@ -273,15 +261,12 @@ def create_gauge(
             # FIXME #2558 go through all views here and check if this
             # instrument registration conflict can be fixed. If it can be, do
             # not log the following warning.
-            _logger.warning(
-                "An instrument with name %s, type %s, unit %s and "
-                "description %s has been created already with a "
-                "different advisory value %s.",
+            self._log_instrument_registration_conflict(
                 name,
                 APIGauge.__name__,
                 unit,
                 description,
-                status.current_advisory,
+                status,
             )
         if status.already_registered:
             with self._instrument_id_instrument_lock:
@@ -310,15 +295,12 @@ def create_observable_gauge(
             # FIXME #2558 go through all views here and check if this
             # instrument registration conflict can be fixed. If it can be, do
             # not log the following warning.
-            _logger.warning(
-                "An instrument with name %s, type %s, unit %s and "
-                "description %s has been created already with a "
-                "different advisory value %s.",
+            self._log_instrument_registration_conflict(
                 name,
                 APIObservableGauge.__name__,
                 unit,
                 description,
-                status.current_advisory,
+                status,
             )
         if status.already_registered:
             with self._instrument_id_instrument_lock:
@@ -350,15 +332,12 @@ def create_observable_up_down_counter(
             # FIXME #2558 go through all views here and check if this
             # instrument registration conflict can be fixed. If it can be, do
             # not log the following warning.
-            _logger.warning(
-                "An instrument with name %s, type %s, unit %s and "
-                "description %s has been created already with a "
-                "different advisory value %s.",
+            self._log_instrument_registration_conflict(
                 name,
                 APIObservableUpDownCounter.__name__,
                 unit,
                 description,
-                status.current_advisory,
+                status,
             )
         if status.already_registered:
             with self._instrument_id_instrument_lock: