Handle flattening errors more gracefully.

Author: michaelsafyan

instrumentation-genai/opentelemetry-instrumentation-google-genai/src/opentelemetry/instrumentation/google_genai/dict_util.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-
+import logging
 import json
 from typing import Any, Callable, Dict, Optional, Sequence, Set, Tuple, Union
 
@@ -26,6 +26,9 @@
 FlattenedDict = Dict[str, FlattenedValue]
 
 
+_logger = logging.getLogger(__name__)
+
+
 def _concat_key(prefix: Optional[str], suffix: str):
     if not prefix:
         return suffix
@@ -136,15 +139,13 @@ def _flatten_compound_value(
             flatten_functions=flatten_functions,
         )
     if _from_json:
-        raise ValueError(
-            f"Cannot flatten value with key {key}; value: {value}"
-        )
+        _logger.debug("Cannot flatten value with key %s; value: %s", key, value)
+        return {}
     try:
         json_string = json.dumps(value)
-    except TypeError as exc:
-        raise ValueError(
-            f"Cannot flatten value with key {key}; value: {value}. Not JSON serializable."
-        ) from exc
+    except TypeError:
+        _logger.debug("Cannot flatten value with key %s; value: %s. Not JSON serializable.", key, value)
+        return {}
     json_value = json.loads(json_string)
     return _flatten_value(
         key,

instrumentation-genai/opentelemetry-instrumentation-google-genai/tests/utils/test_dict_util.py

@@ -12,9 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import pytest
 from pydantic import BaseModel
-
 from opentelemetry.instrumentation.google_genai import dict_util
 
 
@@ -209,12 +207,30 @@ def test_flatten_with_mixed_structures():
 
 
 def test_flatten_with_complex_object_not_json_serializable():
-    with pytest.raises(ValueError):
-        dict_util.flatten_dict(
+    result = dict_util.flatten_dict(
             {
                 "cannot_serialize_directly": NotJsonSerializable(),
             }
         )
+    assert result is not None
+    assert isinstance(result, dict)
+    assert len(result) == 0
+
+
+def test_flatten_good_with_non_serializable_complex_object():
+    result = dict_util.flatten_dict(
+            {
+                "foo": {
+                    "bar": "blah",
+                    "baz": 5,
+                },
+                "cannot_serialize_directly": NotJsonSerializable(),
+            }
+        )
+    assert result == {
+        "foo.bar": "blah",
+        "foo.baz": 5,
+    }
 
 
 def test_flatten_with_complex_object_not_json_serializable_and_custom_flatten_func():