Expand attribute value type to support complex values everywhere and cleanup surrounding code

.changelog/5266.added

@@ -0,0 +1 @@
+`opentelemetry-api`, `opentelemetry-sdk`: add support for extended attribute values everywhere.

.changelog/5266.changed

@@ -0,0 +1,2 @@
+The public `opentelemetry.util.types.AttributeValue` type in package `opentelemetry-api` is being expanded to include `None`, heterogeneous sequences of primitive types (and nested sequences) as opposed to only homogeneous primitive sequences, and Mappings of strings to any primitive types or sequences/mappings (which themselves must only contain primitive types or sequences/mappings validated the same way).
+If a `bytes` type is found as an AttributeValue, it will no longer be utf-8 decoded to a string, instead it will be passed along as is in accordance with the OTEL spec, since `bytes` is a valid type in the OTLP proto.

docs/conf.py

@@ -26,14 +26,17 @@
 
 settings.configure()
 
-# Provide AnyValue in opentelemetry.attributes module's namespace so the
-# "AnyValue" forward reference in opentelemetry.util.types._ExtendedAttributes
-# resolves when sphinx_autodoc_typehints calls typing.get_type_hints() on
-# BoundedAttributes (whose __globals__ is the attributes module). Docs-only.
-import opentelemetry.attributes  # noqa: E402
-from opentelemetry.util.types import AnyValue as _AnyValue  # noqa: E402
+# Docs-only: resolves the "AnyValue" forward reference wherever
+# get_type_hints() evaluates it. AnyValue is a recursive alias, so
+# modules that import it only under TYPE_CHECKING hit a NameError.
+# TODO: https://github.com/open-telemetry/opentelemetry-python/issues/5304
+# this can be removed by importing AnyValue at runtime in the
+# modules that annotate with it
+import builtins  # noqa: E402
 
-opentelemetry.attributes.AnyValue = _AnyValue
+from opentelemetry.util.types import AnyValue  # noqa: E402
+
+builtins.AnyValue = AnyValue
 
 
 source_dirs = [
@@ -186,10 +189,6 @@
         "py:class",
         "AnyValue",
     ),
-    (
-        "py:class",
-        "_ExtendedAttributes",
-    ),
     ("py:class", "Token"),
     # ``from os import PathLike`` renders as the bare name ``PathLike`` in the
     # file exporter type hints, which sphinx cannot resolve to os.PathLike.

exporter/opentelemetry-exporter-otlp-json-common/src/opentelemetry/exporter/otlp/json/common/_internal/__init__.py

@@ -44,7 +44,7 @@
 )
 from opentelemetry.sdk.resources import Resource
 from opentelemetry.sdk.util.instrumentation import InstrumentationScope
-from opentelemetry.util.types import _ExtendedAttributes
+from opentelemetry.util.types import Attributes
 
 _logger = logging.getLogger(__name__)
 
@@ -109,7 +109,7 @@ def _encode_trace_id(trace_id: int) -> bytes:
 
 
 def _encode_attributes(
-    attributes: _ExtendedAttributes | None,
+    attributes: Attributes,
 ) -> list[JSONKeyValue]:
     if not attributes:
         return []

exporter/opentelemetry-exporter-otlp-json-common/src/opentelemetry/exporter/otlp/json/common/_internal/_log_encoder/__init__.py

@@ -53,7 +53,7 @@ def _encode_log(readable_log_record: ReadableLogRecord) -> JSONLogRecord:
         body=_encode_value(readable_log_record.log_record.body),
         severity_text=readable_log_record.log_record.severity_text,
         attributes=_encode_attributes(
-            cast(Attributes, readable_log_record.log_record.attributes),
+            cast(Attributes, readable_log_record.log_record.attributes)
         ),
         dropped_attributes_count=readable_log_record.dropped_attributes,
         severity_number=getattr(

exporter/opentelemetry-exporter-otlp-proto-common/src/opentelemetry/exporter/otlp/proto/common/_internal/__init__.py

@@ -27,7 +27,7 @@
 )
 from opentelemetry.sdk.trace import Resource
 from opentelemetry.sdk.util.instrumentation import InstrumentationScope
-from opentelemetry.util.types import _ExtendedAttributes
+from opentelemetry.util.types import Attributes
 
 _logger = logging.getLogger(__name__)
 
@@ -89,9 +89,7 @@ def _encode_trace_id(trace_id: int) -> bytes:
     return trace_id.to_bytes(length=16, byteorder="big", signed=False)
 
 
-def _encode_attributes(
-    attributes: _ExtendedAttributes | None,
-) -> list[PB2KeyValue]:
+def _encode_attributes(attributes: Attributes) -> list[PB2KeyValue]:
     if not attributes:
         return []
     pb2_attributes = []

exporter/opentelemetry-exporter-otlp-proto-grpc/benchmarks/test_benchmark_trace_exporter.py

@@ -30,7 +30,7 @@ def __init__(self, channel):
 
 
 @patch(
-    "opentelemetry.exporter.otlp.proto.grpc.trace_exporter.OTLPSpanExporter._stub",
+    "opentelemetry.exporter.otlp.proto.grpc.trace_exporter.TraceServiceStub",
     new=MockTraceServiceStub,
 )
 def test_simple_span_processor(benchmark):
@@ -51,7 +51,7 @@ def create_spans_to_be_exported():
 
 
 @patch(
-    "opentelemetry.exporter.otlp.proto.grpc.trace_exporter.OTLPSpanExporter._stub",
+    "opentelemetry.exporter.otlp.proto.grpc.trace_exporter.TraceServiceStub",
     new=MockTraceServiceStub,
 )
 def test_batch_span_processor(benchmark):

opentelemetry-api/src/opentelemetry/_events/__init__.py

@@ -18,7 +18,7 @@
 from opentelemetry.trace.span import TraceFlags
 from opentelemetry.util._once import Once
 from opentelemetry.util._providers import _load_provider
-from opentelemetry.util.types import AnyValue, _ExtendedAttributes
+from opentelemetry.util.types import AnyValue, Attributes
 
 _logger = getLogger(__name__)
 
@@ -37,7 +37,7 @@ def __init__(
         trace_flags: TraceFlags | None = None,
         body: AnyValue | None = None,
         severity_number: SeverityNumber | None = None,
-        attributes: _ExtendedAttributes | None = None,
+        attributes: Attributes = None,
     ):
         attributes = attributes or {}
         event_attributes = {
@@ -66,7 +66,7 @@ def __init__(
         name: str,
         version: str | None = None,
         schema_url: str | None = None,
-        attributes: _ExtendedAttributes | None = None,
+        attributes: Attributes = None,
     ):
         self._name = name
         self._version = version
@@ -97,7 +97,7 @@ def __init__(
         name: str,
         version: str | None = None,
         schema_url: str | None = None,
-        attributes: _ExtendedAttributes | None = None,
+        attributes: Attributes = None,
     ):
         super().__init__(
             name=name,
@@ -138,7 +138,7 @@ def get_event_logger(
         name: str,
         version: str | None = None,
         schema_url: str | None = None,
-        attributes: _ExtendedAttributes | None = None,
+        attributes: Attributes = None,
     ) -> EventLogger:
         """Returns an EventLoggerProvider for use."""
 
@@ -153,7 +153,7 @@ def get_event_logger(
         name: str,
         version: str | None = None,
         schema_url: str | None = None,
-        attributes: _ExtendedAttributes | None = None,
+        attributes: Attributes = None,
     ) -> EventLogger:
         return NoOpEventLogger(
             name, version=version, schema_url=schema_url, attributes=attributes
@@ -170,7 +170,7 @@ def get_event_logger(
         name: str,
         version: str | None = None,
         schema_url: str | None = None,
-        attributes: _ExtendedAttributes | None = None,
+        attributes: Attributes = None,
     ) -> EventLogger:
         if _EVENT_LOGGER_PROVIDER:
             return _EVENT_LOGGER_PROVIDER.get_event_logger(
@@ -244,7 +244,7 @@ def get_event_logger(
     name: str,
     version: str | None = None,
     schema_url: str | None = None,
-    attributes: _ExtendedAttributes | None = None,
+    attributes: Attributes = None,
     event_logger_provider: EventLoggerProvider | None = None,
 ) -> EventLogger:
     if event_logger_provider is None:

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

@@ -40,7 +40,7 @@
 from opentelemetry.trace.span import TraceFlags
 from opentelemetry.util._once import Once
 from opentelemetry.util._providers import _load_provider
-from opentelemetry.util.types import AnyValue, _ExtendedAttributes
+from opentelemetry.util.types import AnyValue, Attributes
 
 _logger = getLogger(__name__)
 
@@ -63,7 +63,7 @@ def __init__(
         severity_text: str | None = None,
         severity_number: SeverityNumber | None = None,
         body: AnyValue = None,
-        attributes: _ExtendedAttributes | None = None,
+        attributes: Attributes = None,
         event_name: str | None = None,
         exception: BaseException | None = None,
     ) -> None: ...
@@ -83,7 +83,7 @@ def __init__(
         severity_text: str | None = None,
         severity_number: SeverityNumber | None = None,
         body: AnyValue = None,
-        attributes: _ExtendedAttributes | None = None,
+        attributes: Attributes = None,
     ) -> None: ...
 
     def __init__(
@@ -98,7 +98,7 @@ def __init__(
         severity_text: str | None = None,
         severity_number: SeverityNumber | None = None,
         body: AnyValue = None,
-        attributes: _ExtendedAttributes | None = None,
+        attributes: Attributes = None,
         event_name: str | None = None,
         exception: BaseException | None = None,
     ) -> None:
@@ -129,7 +129,7 @@ def __init__(
         name: str,
         version: str | None = None,
         schema_url: str | None = None,
-        attributes: _ExtendedAttributes | None = None,
+        attributes: Attributes = None,
     ) -> None:
         super().__init__()
         self._name = name
@@ -147,7 +147,7 @@ def emit(
         severity_number: SeverityNumber | None = None,
         severity_text: str | None = None,
         body: AnyValue | None = None,
-        attributes: _ExtendedAttributes | None = None,
+        attributes: Attributes = None,
         event_name: str | None = None,
         exception: BaseException | None = None,
     ) -> None: ...
@@ -169,7 +169,7 @@ def emit(
         severity_number: SeverityNumber | None = None,
         severity_text: str | None = None,
         body: AnyValue | None = None,
-        attributes: _ExtendedAttributes | None = None,
+        attributes: Attributes = None,
         event_name: str | None = None,
         exception: BaseException | None = None,
     ) -> None:
@@ -192,7 +192,7 @@ def emit(
         severity_number: SeverityNumber | None = None,
         severity_text: str | None = None,
         body: AnyValue | None = None,
-        attributes: _ExtendedAttributes | None = None,
+        attributes: Attributes = None,
         event_name: str | None = None,
         exception: BaseException | None = None,
     ) -> None: ...
@@ -213,7 +213,7 @@ def emit(
         severity_number: SeverityNumber | None = None,
         severity_text: str | None = None,
         body: AnyValue | None = None,
-        attributes: _ExtendedAttributes | None = None,
+        attributes: Attributes = None,
         event_name: str | None = None,
         exception: BaseException | None = None,
     ) -> None:
@@ -226,7 +226,7 @@ def __init__(  # pylint: disable=super-init-not-called
         name: str,
         version: str | None = None,
         schema_url: str | None = None,
-        attributes: _ExtendedAttributes | None = None,
+        attributes: Attributes = None,
     ):
         self._name = name
         self._version = version
@@ -260,7 +260,7 @@ def emit(
         severity_number: SeverityNumber | None = None,
         severity_text: str | None = None,
         body: AnyValue | None = None,
-        attributes: _ExtendedAttributes | None = None,
+        attributes: Attributes = None,
         event_name: str | None = None,
         exception: BaseException | None = None,
     ) -> None: ...
@@ -281,7 +281,7 @@ def emit(
         severity_number: SeverityNumber | None = None,
         severity_text: str | None = None,
         body: AnyValue | None = None,
-        attributes: _ExtendedAttributes | None = None,
+        attributes: Attributes = None,
         event_name: str | None = None,
         exception: BaseException | None = None,
     ) -> None:
@@ -312,7 +312,7 @@ def get_logger(
         name: str,
         version: str | None = None,
         schema_url: str | None = None,
-        attributes: _ExtendedAttributes | None = None,
+        attributes: Attributes = None,
     ) -> Logger:
         """Returns a `Logger` for use by the given instrumentation library.
 
@@ -351,7 +351,7 @@ def get_logger(
         name: str,
         version: str | None = None,
         schema_url: str | None = None,
-        attributes: _ExtendedAttributes | None = None,
+        attributes: Attributes = None,
     ) -> Logger:
         """Returns a NoOpLogger."""
         return NoOpLogger(
@@ -365,7 +365,7 @@ def get_logger(
         name: str,
         version: str | None = None,
         schema_url: str | None = None,
-        attributes: _ExtendedAttributes | None = None,
+        attributes: Attributes = None,
     ) -> Logger:
         if _LOGGER_PROVIDER:
             return _LOGGER_PROVIDER.get_logger(
@@ -428,7 +428,7 @@ def get_logger(
     instrumenting_library_version: str = "",
     logger_provider: LoggerProvider | None = None,
     schema_url: str | None = None,
-    attributes: _ExtendedAttributes | None = None,
+    attributes: Attributes = None,
 ) -> Logger:
     """Returns a `Logger` for use within a python process.