add 'get_custom_header_attributes' helper to opentelemetry-util-http

Author: herin049

instrumentation/opentelemetry-instrumentation-aiohttp-client/src/opentelemetry/instrumentation/aiohttp_client/__init__.py

@@ -196,7 +196,7 @@ def response_hook(span: Span, params: typing.Union[
 import types
 import typing
 from timeit import default_timer
-from typing import Callable, Collection, Mapping
+from typing import Collection
 from urllib.parse import urlparse
 
 import aiohttp
@@ -244,13 +244,12 @@ def response_hook(span: Span, params: typing.Union[
     OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_CLIENT_REQUEST,
     OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_CLIENT_RESPONSE,
     OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SANITIZE_FIELDS,
-    SanitizeValue,
     get_custom_headers,
     get_excluded_urls,
     normalise_request_header_name,
     normalise_response_header_name,
     redact_url,
-    sanitize_method,
+    sanitize_method, get_custom_header_attributes,
 )
 
 _UrlFilterT = typing.Optional[typing.Callable[[yarl.URL], str]]
@@ -304,35 +303,6 @@ def _set_http_status_code_attribute(
     )
 
 
-def _get_custom_header_attributes(
-    headers: typing.Optional[Mapping[str, typing.Union[str, list[str]]]],
-    captured_headers: typing.Optional[list[str]],
-    sensitive_headers: typing.Optional[list[str]],
-    normalize_function: Callable[[str], str],
-) -> dict[str, list[str]]:
-    """Extract and sanitize HTTP headers for span attributes.
-
-    Args:
-        headers: The HTTP headers to process, either from a request or response.
-            Can be None if no headers are available.
-        captured_headers: List of header regexes to capture as span attributes.
-            If None or empty, no headers will be captured.
-        sensitive_headers: List of header regexes whose values should be sanitized
-            (redacted). If None, no sanitization is applied.
-        normalize_function: Function to normalize header names.
-
-    Returns:
-        Dictionary of normalized header attribute names to their values
-        as lists of strings.
-    """
-    if not headers or not captured_headers:
-        return {}
-    sanitize: SanitizeValue = SanitizeValue(sensitive_headers or ())
-    return sanitize.sanitize_header_values(
-        headers, captured_headers, normalize_function
-    )
-
-
 # pylint: disable=too-many-locals
 # pylint: disable=too-many-statements
 def create_trace_config(
@@ -525,7 +495,7 @@ async def on_request_start(
             pass
 
         span_attributes.update(
-            _get_custom_header_attributes(
+            get_custom_header_attributes(
                 {
                     key: params.headers.getall(key)
                     for key in params.headers.keys()
@@ -567,7 +537,7 @@ async def on_request_end(
         )
 
         trace_config_ctx.span.set_attributes(
-            _get_custom_header_attributes(
+            get_custom_header_attributes(
                 {
                     key: params.response.headers.getall(key)
                     for key in params.response.headers.keys()

util/opentelemetry-util-http/src/opentelemetry/util/http/__init__.py

@@ -257,6 +257,35 @@ def get_custom_headers(env_var: str) -> list[str]:
     return []
 
 
+def get_custom_header_attributes(
+        headers: Mapping[str, str | list[str]] | None,
+        captured_headers: list[str] | None,
+        sensitive_headers: list[str] | None,
+        normalize_function: Callable[[str], str],
+) -> dict[str, list[str]]:
+    """Extract and sanitize HTTP headers for span attributes.
+
+    Args:
+        headers: The HTTP headers to process, either from a request or response.
+            Can be None if no headers are available.
+        captured_headers: List of header regexes to capture as span attributes.
+            If None or empty, no headers will be captured.
+        sensitive_headers: List of header regexes whose values should be sanitized
+            (redacted). If None, no sanitization is applied.
+        normalize_function: Function to normalize header names.
+
+    Returns:
+        Dictionary of normalized header attribute names to their values
+        as lists of strings.
+    """
+    if not headers or not captured_headers:
+        return {}
+    sanitize: SanitizeValue = SanitizeValue(sensitive_headers or ())
+    return sanitize.sanitize_header_values(
+        headers, captured_headers, normalize_function
+    )
+
+
 def _parse_active_request_count_attrs(req_attrs):
     active_requests_count_attrs = {
         key: req_attrs[key]