Tidy Labeler

Author: tammy-baylis-swi

opentelemetry-instrumentation/src/opentelemetry/instrumentation/_labeler/__init__.py

@@ -16,20 +16,20 @@
 OpenTelemetry Labeler
 =====================
 
-The labeler utility provides a way to add custom attributes to metrics generated by OpenTelemetry instrumentors. This supports enriching metrics with context-specific information available only after HTTP requests are received, at their origin rather than requiring downstream processing or additional metric calculations.
+The labeler utility provides a way to add custom attributes to some metrics generated by some OpenTelemetry instrumentors.
 
 This was inspired by OpenTelemetry Go's net/http instrumentation Labeler
 https://github.com/open-telemetry/opentelemetry-go-contrib/pull/306
 
 Usage
 -----
 
-The labeler works within the context of an instrumented request or operation. Use ``get_labeler()`` to obtain a labeler instance for the current context, then add attributes using the ``add()`` or ``add_attributes()`` methods.
+The labeler works within the context of an instrumented request or operation. Use ``get_labeler`` to obtain a labeler instance for the current context, then add attributes using the ``add`` or ``add_attributes`` methods.
 
 Example with Flask
 ------------------
 
-Here's an example showing how to use the labeler with Flask instrumentation:
+Here's an example showing how to use the labeler with programmatic Flask instrumentation:
 
 .. code-block:: python
 
@@ -42,15 +42,6 @@
 
     @app.route("/healthcheck")
     def healthcheck():
-        # Get the labeler for the current request
-        labeler = get_labeler()
-
-        labeler.add_attributes(
-            {
-                "endpoint_type": "healthcheck",
-                "internal_request": True,
-            }
-        )
         return "OK"
 
     @app.route("/user/<user_id>")
@@ -70,7 +61,9 @@ def user_profile(user_id):
 
         return f"Got user profile for {user_id}"
 
-The labeler also works with auto-instrumentation and those instrumentors that have implemented custom attributes support for metrics.
+The labeler also works with auto-instrumentation.
+
+Custom attributes are merged by any instrumentors that use ``enhance_metric_attributes`` before their calls to report individual metrics recording, such as ``Histogram.record``. ``enchance_metrics_attributes`` does not overwrite base attributes that exist at the same keys.
 """
 
 from opentelemetry.instrumentation._labeler._internal import (

opentelemetry-instrumentation/src/opentelemetry/instrumentation/_labeler/_internal/__init__.py

@@ -41,11 +41,6 @@ def add(self, key: str, value: Union[str, int, float, bool]) -> None:
             key: The attribute key
             value: The attribute value (must be a primitive type)
         """
-        if not isinstance(value, (str, int, float, bool)):
-            raise ValueError(
-                f"Attribute value must be str, int, float, or bool, got {type(value)}"
-            )
-
         with self._lock:
             self._attributes[key] = value
 
@@ -58,12 +53,6 @@ def add_attributes(
         Args:
             attributes: Dictionary of attributes to add
         """
-        for key, value in attributes.items():
-            if not isinstance(value, (str, int, float, bool)):
-                raise ValueError(
-                    f"Attribute value for '{key}' must be str, int, float, or bool, got {type(value)}"
-                )
-
         with self._lock:
             self._attributes.update(attributes)
 
@@ -140,9 +129,9 @@ def enhance_metric_attributes(
     """
     Combines base_attributes with custom attributes from the current labeler,
     returning a new dictionary of attributes. Custom attributes are skipped
-    if they would override base_attributes, exceed max_custom_attrs number,
-    or are not simple types (str, int, float, bool). If custom attributes
-    have string values exceeding the max_attr_value_length, then they are truncated.
+    if they would override base_attributes, or exceed max_custom_attrs number.
+    If custom attributes have string values exceeding the max_attr_value_length,
+    then they are truncated.
 
     Args:
         base_attributes: The base attributes for the metric
@@ -151,7 +140,8 @@ def enhance_metric_attributes(
         max_attr_value_length: Maximum length for string attribute values
 
     Returns:
-        Dictionary combining base and custom attributes
+        Dictionary combining base and custom attributes. If no custom attributes,
+        returns a copy of the original base attributes.
     """
     if not include_custom:
         return base_attributes.copy()
@@ -172,8 +162,7 @@ def enhance_metric_attributes(
         if isinstance(value, str) and len(value) > max_attr_value_length:
             value = value[:max_attr_value_length]
 
-        if isinstance(value, (str, int, float, bool)):
-            enhanced_attributes[key] = value
-            added_count += 1
+        enhanced_attributes[key] = value
+        added_count += 1
 
     return enhanced_attributes

opentelemetry-instrumentation/tests/test_labeler.py

@@ -61,18 +61,6 @@ def test_add_attributes_dict(self):
         attributes = labeler.get_attributes()
         self.assertEqual(attributes, attrs)
 
-    def test_invalid_attribute_types(self):
-        labeler = Labeler()
-
-        with self.assertRaises(ValueError):
-            labeler.add("key", [1, 2, 3])
-
-        with self.assertRaises(ValueError):
-            labeler.add("key", {"nested": "dict"})
-
-        with self.assertRaises(ValueError):
-            labeler.add_attributes({"key": None})
-
     def test_overwrite_attribute(self):
         labeler = Labeler()
         labeler.add("key1", "original")