Support conversion of non-string

LogRecord.attributes values and non-dictionary
LogRecord.body.

Author: DylanRussell

opentelemetry-exporter-gcp-logging/src/opentelemetry/exporter/cloud_logging/__init__.py

@@ -14,9 +14,10 @@
 from __future__ import annotations
 
 import datetime
+import json
 import logging
 import urllib.parse
-from typing import Optional, Sequence
+from typing import Any, Optional, Sequence
 
 import google.auth
 from google.api.monitored_resource_pb2 import MonitoredResource  # type: ignore
@@ -91,6 +92,16 @@
 }
 
 
+def convert_any_value_to_string(value: Any) -> str:
+    t = type(value)
+    if t is bool or t is int or t is float or t is str:
+        return str(value)
+    if t is list or t is tuple:
+        return json.dumps(value)
+    logging.warning(f"Unknown type {t} found, cannot convert to string.")
+    return ""
+
+
 class CloudLoggingExporter(LogExporter):
     def __init__(
         self,
@@ -171,11 +182,29 @@ def export(self, batch: Sequence[LogData]):
                 log_entry.severity = SEVERITY_MAPPING[  # type: ignore[assignment]
                     log_record.severity_number.value  # type: ignore[index]
                 ]
-            log_entry.labels = {k: str(v) for k, v in attributes.items()}
+            log_entry.labels = {
+                k: convert_any_value_to_string(v)
+                for k, v in attributes.items()
+            }
             if type(log_record.body) is dict:
                 s = Struct()
                 s.update(log_record.body)
                 log_entry.json_payload = s
+            elif type(log_record.body) is bytes:
+                json_str = log_record.body.decode("utf8")
+                json_dict = json.loads(json_str)
+                if type(json_dict) is dict:
+                    s = Struct()
+                    s.update(json_dict)
+                    log_entry.json_payload = s
+                else:
+                    logging.warning(
+                        f"LogRecord.body was bytes type and json.loads turned body into type {type(json_dict)}, expected a dictionary."
+                    )
+            else:
+                log_entry.text_payload = convert_any_value_to_string(
+                    log_record.body
+                )
             log_entries.append(log_entry)
 
         self._write_log_entries(log_entries)

opentelemetry-exporter-gcp-logging/tests/__snapshots__/test_cloud_logging/test_convert_non_json_dict_bytes.json

@@ -0,0 +1,18 @@
+[
+  {
+    "entries": [
+      {
+        "logName": "projects/fakeproject/logs/test",
+        "resource": {
+          "labels": {
+            "location": "global",
+            "namespace": "",
+            "node_id": ""
+          },
+          "type": "generic_node"
+        },
+        "timestamp": "2025-01-15T21:25:10.997977393Z"
+      }
+    ]
+  }
+]

opentelemetry-exporter-gcp-logging/tests/__snapshots__/test_cloud_logging/test_convert_otlp.json renamed to opentelemetry-exporter-gcp-logging/tests/__snapshots__/test_cloud_logging/test_convert_otlp_dict_body.json

@@ -0,0 +1,35 @@
+[
+  {
+    "entries": [
+      {
+        "jsonPayload": {
+          "Classe": [
+            "Email addresses",
+            "Passwords"
+          ],
+          "CreationDate": "2012-05-05",
+          "Date": "2016-05-21T21:35:40Z",
+          "Link": "http://some_link.com",
+          "LogoType": "png",
+          "Ref": 164611595.0
+        },
+        "labels": {
+          "boolArray": "[true, false, true, true]",
+          "float": "25.43231",
+          "int": "25",
+          "intArray": "[21, 18, 23, 17]"
+        },
+        "logName": "projects/fakeproject/logs/test",
+        "resource": {
+          "labels": {
+            "location": "global",
+            "namespace": "",
+            "node_id": ""
+          },
+          "type": "generic_node"
+        },
+        "timestamp": "2025-01-15T21:25:10.997977393Z"
+      }
+    ]
+  }
+]

opentelemetry-exporter-gcp-logging/tests/__snapshots__/test_cloud_logging/test_convert_otlp_various_different_types_in_attrs_and_bytes_body.json

@@ -0,0 +1,19 @@
+[
+  {
+    "entries": [
+      {
+        "logName": "projects/fakeproject/logs/test",
+        "resource": {
+          "labels": {
+            "location": "global",
+            "namespace": "",
+            "node_id": ""
+          },
+          "type": "generic_node"
+        },
+        "textPayload": "True",
+        "timestamp": "2025-01-15T21:25:10.997977393Z"
+      }
+    ]
+  }
+]

opentelemetry-exporter-gcp-logging/tests/__snapshots__/test_cloud_logging/test_convert_various_types_of_bodies[bool].json

@@ -0,0 +1,19 @@
+[
+  {
+    "entries": [
+      {
+        "logName": "projects/fakeproject/logs/test",
+        "resource": {
+          "labels": {
+            "location": "global",
+            "namespace": "",
+            "node_id": ""
+          },
+          "type": "generic_node"
+        },
+        "textPayload": "A text body",
+        "timestamp": "2025-01-15T21:25:10.997977393Z"
+      }
+    ]
+  }
+]

opentelemetry-exporter-gcp-logging/tests/__snapshots__/test_cloud_logging/test_convert_various_types_of_bodies[str].json

@@ -26,8 +26,9 @@
 Be sure to review the changes.
 """
 import re
-from typing import List
+from typing import List, Union
 
+import pytest
 from fixtures.cloud_logging_fake import CloudLoggingFake, WriteLogEntriesCall
 from google.auth.credentials import AnonymousCredentials
 from google.cloud.logging_v2.services.logging_service_v2 import (
@@ -43,7 +44,7 @@
 PROJECT_ID = "fakeproject"
 
 
-def test_invalid_otlp_entries_raise_warnings(caplog) -> None:
+def test_too_large_log_raises_warning(caplog) -> None:
     client = LoggingServiceV2Client(credentials=AnonymousCredentials())
     no_default_logname = CloudLoggingExporter(
         project_id=PROJECT_ID, client=client
@@ -52,6 +53,7 @@ def test_invalid_otlp_entries_raise_warnings(caplog) -> None:
         [
             LogData(
                 log_record=LogRecord(
+                    body="abc",
                     resource=Resource({}),
                     attributes={str(i): "i" * 10000 for i in range(1000)},
                 ),
@@ -63,39 +65,34 @@ def test_invalid_otlp_entries_raise_warnings(caplog) -> None:
     assert "exceeds Cloud Logging's maximum limit of 256000.\n" in caplog.text
 
 
-def test_convert_otlp(
+def test_convert_otlp_dict_body(
     cloudloggingfake: CloudLoggingFake,
     snapshot_writelogentrycalls: List[WriteLogEntriesCall],
 ) -> None:
-    # Create a new LogRecord object
-    log_record = LogRecord(
-        timestamp=1736976310997977393,
-        severity_number=SeverityNumber(20),
-        trace_id=25,
-        span_id=22,
-        attributes={
-            "gen_ai.system": "openai",
-            "event.name": "gen_ai.system.message",
-        },
-        body={
-            "kvlistValue": {
-                "values": [
-                    {
-                        "key": "content",
-                        "value": {
-                            "stringValue": "You're a helpful assistant."
-                        },
-                    }
-                ]
-            }
-        },
-        # Not sure why I'm getting  AttributeError: 'NoneType' object has no attribute 'attributes' when unset.
-        resource=Resource({}),
-    )
-
     log_data = [
         LogData(
-            log_record=log_record,
+            log_record=LogRecord(
+                timestamp=1736976310997977393,
+                severity_number=SeverityNumber(20),
+                trace_id=25,
+                span_id=22,
+                attributes={
+                    "gen_ai.system": "openai",
+                    "event.name": "gen_ai.system.message",
+                },
+                body={
+                    "kvlistValue": {
+                        "values": [
+                            {
+                                "key": "content",
+                                "value": {
+                                    "stringValue": "You're a helpful assistant."
+                                },
+                            }
+                        ]
+                    }
+                },
+            ),
             instrumentation_scope=InstrumentationScope("test"),
         )
     ]
@@ -109,3 +106,70 @@ def test_convert_otlp(
             )
             is not None
         )
+
+
+def test_convert_otlp_various_different_types_in_attrs_and_bytes_body(
+    cloudloggingfake: CloudLoggingFake,
+    snapshot_writelogentrycalls: List[WriteLogEntriesCall],
+) -> None:
+    log_data = [
+        LogData(
+            log_record=LogRecord(
+                timestamp=1736976310997977393,
+                attributes={
+                    "int": 25,
+                    "float": 25.43231,
+                    "intArray": [21, 18, 23, 17],
+                    "boolArray": [True, False, True, True],
+                },
+                body=b'{"Date": "2016-05-21T21:35:40Z", "CreationDate": "2012-05-05", "LogoType": "png", "Ref": 164611595, "Classe": ["Email addresses", "Passwords"],"Link":"http://some_link.com"}',
+            ),
+            instrumentation_scope=InstrumentationScope("test"),
+        )
+    ]
+    cloudloggingfake.exporter.export(log_data)
+    assert cloudloggingfake.get_calls() == snapshot_writelogentrycalls
+
+
+def test_convert_non_json_dict_bytes(
+    cloudloggingfake: CloudLoggingFake,
+    snapshot_writelogentrycalls: List[WriteLogEntriesCall],
+    caplog,
+) -> None:
+    log_data = [
+        LogData(
+            log_record=LogRecord(
+                timestamp=1736976310997977393,
+                body=b"123",
+            ),
+            instrumentation_scope=InstrumentationScope("test"),
+        )
+    ]
+    cloudloggingfake.exporter.export(log_data)
+    assert cloudloggingfake.get_calls() == snapshot_writelogentrycalls
+    assert (
+        "LogRecord.body was bytes type and json.loads turned body into type <class 'int'>, expected a dictionary"
+        in caplog.text
+    )
+
+
+@pytest.mark.parametrize(
+    "body",
+    [pytest.param("A text body", id="str"), pytest.param(True, id="bool")],
+)
+def test_convert_various_types_of_bodies(
+    cloudloggingfake: CloudLoggingFake,
+    snapshot_writelogentrycalls: List[WriteLogEntriesCall],
+    body: Union[str, bool],
+) -> None:
+    log_data = [
+        LogData(
+            log_record=LogRecord(
+                timestamp=1736976310997977393,
+                body=body,
+            ),
+            instrumentation_scope=InstrumentationScope("test"),
+        )
+    ]
+    cloudloggingfake.exporter.export(log_data)
+    assert cloudloggingfake.get_calls() == snapshot_writelogentrycalls