exporter/otlp: allow export of none values in logs attributes

Author: xrmx

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

@@ -45,7 +45,7 @@
 )
 from opentelemetry.sdk.trace import Resource
 from opentelemetry.sdk.util.instrumentation import InstrumentationScope
-from opentelemetry.util.types import Attributes
+from opentelemetry.util.types import _ExtendedAttributes
 
 _logger = logging.getLogger(__name__)
 
@@ -136,14 +136,17 @@ def _encode_trace_id(trace_id: int) -> bytes:
 
 
 def _encode_attributes(
-    attributes: Attributes,
+    attributes: _ExtendedAttributes,
+    allow_null: bool = False,
 ) -> Optional[List[PB2KeyValue]]:
     if attributes:
         pb2_attributes = []
         for key, value in attributes.items():
             # pylint: disable=broad-exception-caught
             try:
-                pb2_attributes.append(_encode_key_value(key, value))
+                pb2_attributes.append(
+                    _encode_key_value(key, value, allow_null=allow_null)
+                )
             except Exception as error:
                 _logger.exception("Failed to encode key %s: %s", key, error)
     else:

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

@@ -57,7 +57,9 @@ def _encode_log(log_data: LogData) -> PB2LogRecord:
         flags=int(log_data.log_record.trace_flags),
         body=_encode_value(body, allow_null=True),
         severity_text=log_data.log_record.severity_text,
-        attributes=_encode_attributes(log_data.log_record.attributes),
+        attributes=_encode_attributes(
+            log_data.log_record.attributes, allow_null=True
+        ),
         dropped_attributes_count=log_data.log_record.dropped_attributes,
         severity_number=log_data.log_record.severity_number.value,
     )

exporter/opentelemetry-exporter-otlp-proto-common/tests/test_log_encoder.py

@@ -225,7 +225,28 @@ def _get_sdk_log_data() -> List[LogData]:
             ),
         )
 
-        return [log1, log2, log3, log4, log5, log6, log7]
+        log8 = LogData(
+            log_record=SDKLogRecord(
+                timestamp=1644650584292683044,
+                observed_timestamp=1644650584292683044,
+                trace_id=212592107417388365804938480559624925566,
+                span_id=6077757853989569466,
+                trace_flags=TraceFlags(0x01),
+                severity_text="INFO",
+                severity_number=SeverityNumber.INFO,
+                body="Test export of extended attributes",
+                resource=SDKResource({}),
+                attributes={
+                    "extended": {
+                        "sequence": [{"inner": "mapping", "none": None}]
+                    }
+                },
+            ),
+            instrumentation_scope=InstrumentationScope(
+                "extended_name", "extended_version"
+            ),
+        )
+        return [log1, log2, log3, log4, log5, log6, log7, log8]
 
     def get_test_logs(
         self,
@@ -265,7 +286,8 @@ def get_test_logs(
                                         "Do not go gentle into that good night. Rage, rage against the dying of the light"
                                     ),
                                     attributes=_encode_attributes(
-                                        {"a": 1, "b": "c"}
+                                        {"a": 1, "b": "c"},
+                                        allow_null=True,
                                     ),
                                 )
                             ],
@@ -295,7 +317,8 @@ def get_test_logs(
                                         {
                                             "filename": "model.py",
                                             "func_name": "run_method",
-                                        }
+                                        },
+                                        allow_null=True,
                                     ),
                                 )
                             ],
@@ -326,7 +349,8 @@ def get_test_logs(
                                         {
                                             "filename": "model.py",
                                             "func_name": "run_method",
-                                        }
+                                        },
+                                        allow_null=True,
                                     ),
                                 )
                             ],
@@ -336,7 +360,8 @@ def get_test_logs(
                                 name="scope_with_attributes",
                                 version="scope_with_attributes_version",
                                 attributes=_encode_attributes(
-                                    {"one": 1, "two": "2"}
+                                    {"one": 1, "two": "2"},
+                                    allow_null=True,
                                 ),
                             ),
                             schema_url="instrumentation_schema_url",
@@ -360,7 +385,8 @@ def get_test_logs(
                                         {
                                             "filename": "model.py",
                                             "func_name": "run_method",
-                                        }
+                                        },
+                                        allow_null=True,
                                     ),
                                 )
                             ],
@@ -416,7 +442,8 @@ def get_test_logs(
                                     severity_number=SeverityNumber.DEBUG.value,
                                     body=_encode_value("To our galaxy"),
                                     attributes=_encode_attributes(
-                                        {"a": 1, "b": "c"}
+                                        {"a": 1, "b": "c"},
+                                        allow_null=True,
                                     ),
                                 ),
                             ],
@@ -471,6 +498,43 @@ def get_test_logs(
                                 ),
                             ],
                         ),
+                        PB2ScopeLogs(
+                            scope=PB2InstrumentationScope(
+                                name="extended_name",
+                                version="extended_version",
+                            ),
+                            log_records=[
+                                PB2LogRecord(
+                                    time_unix_nano=1644650584292683044,
+                                    observed_time_unix_nano=1644650584292683044,
+                                    trace_id=_encode_trace_id(
+                                        212592107417388365804938480559624925566
+                                    ),
+                                    span_id=_encode_span_id(
+                                        6077757853989569466,
+                                    ),
+                                    flags=int(TraceFlags(0x01)),
+                                    severity_text="INFO",
+                                    severity_number=SeverityNumber.INFO.value,
+                                    body=_encode_value(
+                                        "Test export of extended attributes"
+                                    ),
+                                    attributes=_encode_attributes(
+                                        {
+                                            "extended": {
+                                                "sequence": [
+                                                    {
+                                                        "inner": "mapping",
+                                                        "none": None,
+                                                    }
+                                                ]
+                                            }
+                                        },
+                                        allow_null=True,
+                                    ),
+                                ),
+                            ],
+                        ),
                     ],
                 ),
             ]