Ruff

Author: tammy-baylis-swi

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

@@ -97,7 +97,7 @@ def hello():
 
 Custom Metrics Attributes using Labeler
 ***************************************
-The Flask instrumentation reads from a Labeler utility that supports adding custom attributes 
+The Flask instrumentation reads from a Labeler utility that supports adding custom attributes
 to the HTTP metrics recorded by the instrumentation.
 
 .. code-block:: python
@@ -113,17 +113,17 @@ def hello():
     def user_profile(user_id):
         # Get the labeler for the current request
         labeler = get_labeler()
-        
+
         # Add custom attributes to Flask instrumentation metrics
         labeler.add("user_id", user_id)
         labeler.add("user_type", "registered")
-        
+
         # Or, add multiple attributes at once
         labeler.add_attributes({
             "feature_flag": "new_ui",
             "experiment_group": "control"
         })
-        
+
         return f"User profile for {user_id}"
 
 
@@ -288,6 +288,7 @@ def response_hook(span: Span, status: str, response_headers: List):
 
 import opentelemetry.instrumentation.wsgi as otel_wsgi
 from opentelemetry import context, trace
+from opentelemetry.instrumentation._labeler import enhance_metric_attributes
 from opentelemetry.instrumentation._semconv import (
     HTTP_DURATION_HISTOGRAM_BUCKETS_NEW,
     _get_schema_url,
@@ -300,7 +301,6 @@ def response_hook(span: Span, status: str, response_headers: List):
 from opentelemetry.instrumentation.flask.package import _instruments
 from opentelemetry.instrumentation.flask.version import __version__
 from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
-from opentelemetry.instrumentation._labeler import enhance_metric_attributes
 from opentelemetry.instrumentation.propagators import (
     get_global_response_propagator,
 )
@@ -442,9 +442,7 @@ def _start_response(status, response_headers, *args, **kwargs):
                 )
 
             # Enhance attributes with any custom labeler attributes
-            duration_attrs_old = enhance_metric_attributes(
-                duration_attrs_old
-            )
+            duration_attrs_old = enhance_metric_attributes(duration_attrs_old)
 
             duration_histogram_old.record(
                 max(round(duration_s * 1000), 0), duration_attrs_old
@@ -458,9 +456,7 @@ def _start_response(status, response_headers, *args, **kwargs):
                 duration_attrs_new[HTTP_ROUTE] = str(request_route)
 
             # Enhance attributes with any custom labeler attributes
-            duration_attrs_new = enhance_metric_attributes(
-                duration_attrs_new
-            )
+            duration_attrs_new = enhance_metric_attributes(duration_attrs_new)
 
             duration_histogram_new.record(
                 max(duration_s, 0), duration_attrs_new
@@ -490,9 +486,7 @@ def _before_request():
             sem_conv_opt_in_mode=sem_conv_opt_in_mode,
         )
         # Enhance attributes with custom labeler attributes
-        attributes = enhance_metric_attributes(
-            attributes
-        )
+        attributes = enhance_metric_attributes(attributes)
         if flask.request.url_rule:
             # For 404 that result from no route found, etc, we
             # don't have a url_rule.

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

@@ -22,17 +22,17 @@
 
 from opentelemetry.instrumentation._labeler._internal import (
     Labeler,
-    get_labeler,
-    set_labeler,
     clear_labeler,
-    get_labeler_attributes,
     enhance_metric_attributes,
+    get_labeler,
+    get_labeler_attributes,
+    set_labeler,
 )
 
 __all__ = [
     "Labeler",
     "get_labeler",
-    "set_labeler", 
+    "set_labeler",
     "clear_labeler",
     "get_labeler_attributes",
     "enhance_metric_attributes",

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

@@ -12,21 +12,21 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import threading
-from typing import Dict, Union, Optional, Any
 import contextvars
+import threading
+from typing import Any, Dict, Optional, Union
 
 # Context variable to store the current labeler
-_labeler_context: contextvars.ContextVar[Optional["Labeler"]] = contextvars.ContextVar(
-    "otel_labeler", default=None
+_labeler_context: contextvars.ContextVar[Optional["Labeler"]] = (
+    contextvars.ContextVar("otel_labeler", default=None)
 )
 
 
 class Labeler:
     """
     Labeler can be used by instrumented code or distro to add custom attributes
     to the metrics recorded by those OpenTelemetry instrumentations reading it.
-    
+
     Labeler accumulates custom attributes for OpenTelemetry metrics for the
     current request in context.
 
@@ -40,28 +40,34 @@ def __init__(self):
     def add(self, key: str, value: Union[str, int, float, bool]) -> None:
         """
         Add a single attribute to the labeler.
-        
+
         Args:
             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)}")
-        
+            raise ValueError(
+                f"Attribute value must be str, int, float, or bool, got {type(value)}"
+            )
+
         with self._lock:
             self._attributes[key] = value
 
-    def add_attributes(self, attributes: Dict[str, Union[str, int, float, bool]]) -> None:
+    def add_attributes(
+        self, attributes: Dict[str, Union[str, int, float, bool]]
+    ) -> None:
         """
         Add multiple attributes to the labeler.
-        
+
         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)}")
-        
+                raise ValueError(
+                    f"Attribute value for '{key}' must be str, int, float, or bool, got {type(value)}"
+                )
+
         with self._lock:
             self._attributes.update(attributes)
 
@@ -84,10 +90,10 @@ def __len__(self) -> int:
 def get_labeler() -> Labeler:
     """
     Get the Labeler instance for the current request context.
-    
+
     If no Labeler exists in the current context, a new one is created
     and stored in the context.
-    
+
     Returns:
         Labeler instance for the current request, or a new empty Labeler
         if not in a request context
@@ -102,7 +108,7 @@ def get_labeler() -> Labeler:
 def set_labeler(labeler: Labeler) -> None:
     """
     Set the Labeler instance for the current request context.
-    
+
     Args:
         labeler: The Labeler instance to set
     """
@@ -119,7 +125,7 @@ def clear_labeler() -> None:
 def get_labeler_attributes() -> Dict[str, Union[str, int, float, bool]]:
     """
     Get attributes from the current labeler, if any.
-    
+
     Returns:
         Dictionary of custom attributes, or empty dict if no labeler exists
     """
@@ -130,38 +136,38 @@ def get_labeler_attributes() -> Dict[str, Union[str, int, float, bool]]:
 
 
 def enhance_metric_attributes(
-    base_attributes: Dict[str, Any], 
+    base_attributes: Dict[str, Any],
     include_custom: bool = True,
     max_custom_attrs: int = 20,
-    max_attr_value_length: int = 100
+    max_attr_value_length: int = 100,
 ) -> Dict[str, Any]:
     """
     This function combines base_attributes with custom attributes
     from the current labeler.
-    
+
     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.
-    
+
     Args:
         base_attributes: The base attributes for the metric
         include_custom: Whether to include custom labeler attributes
         max_custom_attrs: Maximum number of custom attributes to include
         max_attr_value_length: Maximum length for string attribute values
-        
+
     Returns:
         Dictionary combining base and custom attributes
     """
     if not include_custom:
         return base_attributes.copy()
-    
+
     custom_attributes = get_labeler_attributes()
     if not custom_attributes:
         return base_attributes.copy()
-    
+
     enhanced_attributes = base_attributes.copy()
-    
+
     added_count = 0
     for key, value in custom_attributes.items():
         if added_count >= max_custom_attrs:
@@ -175,5 +181,5 @@ def enhance_metric_attributes(
         if isinstance(value, (str, int, float, bool)):
             enhanced_attributes[key] = value
             added_count += 1
-    
+
     return enhanced_attributes

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

@@ -17,8 +17,9 @@
 """
 
 from flask import Flask
-from opentelemetry.instrumentation.flask import FlaskInstrumentor
+
 from opentelemetry.instrumentation._labeler import get_labeler
+from opentelemetry.instrumentation.flask import FlaskInstrumentor
 
 app = Flask(__name__)
 FlaskInstrumentor().instrument_app(app)
@@ -29,24 +30,28 @@ def healthcheck():
     # Get the labeler for the current request
     labeler = get_labeler()
 
-    labeler.add_attributes({
-        "endpoint_type": "healthcheck",
-        "internal_request": True,
-    })
+    labeler.add_attributes(
+        {
+            "endpoint_type": "healthcheck",
+            "internal_request": True,
+        }
+    )
     return "OK"
 
 
 @app.route("/user/<user_id>")
 def user_profile(user_id):
     labeler = get_labeler()
-    
+
     # Can add individual attributes or multiple at once
     labeler.add("user_id", user_id)
-    labeler.add_attributes({
-        "has_premium": user_id in ["123", "456"],
-        "experiment_group": "control",
-        "feature_enabled": True,
-        "user_segment": "active"
-    })
-    
+    labeler.add_attributes(
+        {
+            "has_premium": user_id in ["123", "456"],
+            "experiment_group": "control",
+            "feature_enabled": True,
+            "user_segment": "active",
+        }
+    )
+
     return f"Got user profile for {user_id}"