Merge branch 'main' into logname_change

Author: DylanRussell

.gitignore

@@ -146,3 +146,6 @@ cython_debug/
 # Sphinx
 _build/
 _autosummary/
+
+# Ephemeral Databases
+*.db

e2e-test-server/e2e_test_server/scenarios.py

@@ -22,9 +22,7 @@
 from opentelemetry.propagators.cloud_trace_propagator import (
     CloudTraceFormatPropagator,
 )
-from opentelemetry.resourcedetector.gcp_resource_detector._detector import (
-    GoogleCloudResourceDetector,
-)
+from opentelemetry.resourcedetector.gcp_resource_detector import GoogleCloudResourceDetector
 from opentelemetry.sdk.trace import TracerProvider
 from opentelemetry.sdk.trace.export import BatchSpanProcessor
 from opentelemetry.sdk.trace.sampling import ALWAYS_ON

opentelemetry-exporter-gcp-logging/CHANGELOG.md

@@ -2,8 +2,10 @@
 
 ## Unreleased
 
-Added support for when `bytes` or `list['bytes']` is in `LogRecord.body` and
-body is of type Mapping. Update opentelemetry-api/sdk dependencies to 1.3.
+- Added support for when a `Mapping[str, bytes]` or `Mapping[str, List[bytes]]` is in `LogRecord.body`.
+- Added support for when a `Mapping[str, List[Mapping]]` is in `LogRecord.body`.
+- Do not call `logging.warning` when `LogRecord.body` is of None type, instead leave `LogEntry.payload` empty.
+- Update opentelemetry-api/sdk dependencies to 1.3.
 
 The suffix part of `LogEntry.log_name` will be the `LogRecord.event_name` when
 that is present and the `gcp.log_name` attribute is not.

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

@@ -112,9 +112,6 @@ def _convert_any_value_to_string(value: Any) -> str:
         return str(value)
     if isinstance(value, (list, tuple)):
         return json.dumps(value)
-    logging.warning(
-        "Unknown value %s found, cannot convert to string.", type(value)
-    )
     return ""
 
 
@@ -132,9 +129,19 @@ def _sanitized_body(
             # Should not be possible for a non-bytes value to be present. AnyValue requires Sequence be of one type, and above
             # we verified the first value is type bytes.
             new_body[key] = [
-                base64.b64encode(v).decode()
+                base64.b64encode(v).decode() if isinstance(v, bytes) else v
                 for v in value
-                if isinstance(v, bytes)
+            ]
+        elif (
+            isinstance(value, Sequence)
+            and len(value) > 0
+            and isinstance(value[0], Mapping)
+        ):
+            # Should not be possible for a non-mapping value to be present. AnyValue requires Sequence be of one type, and above
+            # we verified the first value is type mapping.
+            new_body[key] = [
+                _sanitized_body(x) if isinstance(x, Mapping) else x
+                for x in value
             ]
         elif isinstance(value, bytes):
             new_body[key] = base64.b64encode(value).decode()
@@ -148,8 +155,15 @@ def _sanitized_body(
 def _set_payload_in_log_entry(log_entry: LogEntry, body: AnyValue):
     struct = Struct()
     if isinstance(body, Mapping):
-        struct.update(_sanitized_body(body))
-        log_entry.json_payload = struct
+        sanitized = _sanitized_body(body)
+        try:
+            struct.update(sanitized)
+            log_entry.json_payload = struct
+        except Exception as exc:  # pylint: disable=broad-except
+            logging.exception(
+                "Error mapping LogRecord.body to Struct, will write log with empty body: %s",
+                exc,
+            )
     elif isinstance(body, bytes):
         json_str = body.decode("utf-8", errors="replace")
         json_dict = json.loads(json_str)
@@ -158,7 +172,7 @@ def _set_payload_in_log_entry(log_entry: LogEntry, body: AnyValue):
             log_entry.json_payload = struct
         else:
             log_entry.text_payload = base64.b64encode(body).decode()
-    else:
+    elif body is not None:
         log_entry.text_payload = _convert_any_value_to_string(body)
 
 

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

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

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

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

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

@@ -0,0 +1,26 @@
+[
+  {
+    "entries": [
+      {
+        "jsonPayload": {
+          "my_dict": [
+            {
+              "key": "Ynl0ZXM="
+            }
+          ]
+        },
+        "logName": "projects/fakeproject/logs/test",
+        "resource": {
+          "labels": {
+            "location": "global",
+            "namespace": "",
+            "node_id": ""
+          },
+          "type": "generic_node"
+        },
+        "timestamp": "2025-01-15T21:25:10.997977393Z"
+      }
+    ],
+    "partialSuccess": true
+  }
+]

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

@@ -0,0 +1,27 @@
+[
+  {
+    "entries": [
+      {
+        "jsonPayload": {
+          "my_dict": [
+            true,
+            "str",
+            1.0,
+            0.234
+          ]
+        },
+        "logName": "projects/fakeproject/logs/test",
+        "resource": {
+          "labels": {
+            "location": "global",
+            "namespace": "",
+            "node_id": ""
+          },
+          "type": "generic_node"
+        },
+        "timestamp": "2025-01-15T21:25:10.997977393Z"
+      }
+    ],
+    "partialSuccess": true
+  }
+]

opentelemetry-exporter-gcp-logging/tests/test_cloud_logging.py

@@ -26,7 +26,7 @@
 Be sure to review the changes.
 """
 import re
-from typing import List, Union
+from typing import List, Mapping, Union
 
 import pytest
 from fixtures.cloud_logging_fake import CloudLoggingFake, WriteLogEntriesCall
@@ -156,12 +156,25 @@ def test_convert_non_json_dict_bytes(
 
 @pytest.mark.parametrize(
     "body",
-    [pytest.param("A text body", id="str"), pytest.param(True, id="bool")],
+    [
+        pytest.param("A text body", id="str"),
+        pytest.param(True, id="bool"),
+        pytest.param(None, id="None"),
+        pytest.param(
+            {"my_dict": [{"key": b"bytes"}]}, id="list_of_dicts_with_bytes"
+        ),
+        pytest.param(
+            {"my_dict": [True, False, False, True]}, id="list_of_bools"
+        ),
+        pytest.param(
+            {"my_dict": [True, "str", 1, 0.234]}, id="list_of_mixed_sequence"
+        ),
+    ],
 )
 def test_convert_various_types_of_bodies(
     cloudloggingfake: CloudLoggingFake,
     snapshot_writelogentrycalls: List[WriteLogEntriesCall],
-    body: Union[str, bool],
+    body: Union[str, bool, None, Mapping],
 ) -> None:
     log_data = [
         LogData(

opentelemetry-resourcedetector-gcp/CHANGELOG.md

@@ -2,7 +2,12 @@
 
 ## Unreleased
 
-Update opentelemetry-api/sdk dependencies to 1.3.
+- Update opentelemetry-api/sdk dependencies to 1.3.
+
+- This is a breaking change which moves our official recource detector from `opentelemetry.resourcedetector.gcp_resource_detector._detector`
+into `opentelemetry.resourcedetector.gcp_resource_detector` and deletes the outdated duplicate resource detector
+which used to be there. Use `from opentelemetry.resourcedetector.gcp_resource_detector import GoogleCloudResourceDetector`
+to import it. See ([#389](https://github.com/GoogleCloudPlatform/opentelemetry-operations-python/pull/389)) for details.
 
 ## Version 1.9.0a0