release notes + format

Signed-off-by: Eliott Bouhana <eliott.bouhana@datadoghq.com>
DataDog · Aug 13, 2024 · 53ef913 · 53ef913
1 parent 382a42b
commit 53ef913
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 26 deletions.
diff --git a/ddapm_test_agent/trace.py b/ddapm_test_agent/trace.py
@@ -130,13 +130,19 @@ def verify_span(d: Any) -> Span:
             assert isinstance(d["meta_struct"], dict)
             for k, v in d["meta_struct"].items():
                 assert isinstance(k, str), f"Expected key 'meta_struct.{k}' to be of type: 'str', got: {type(k)}"
-                assert isinstance(v, bytes), f"Expected msgpack'd value of key 'meta_struct.{k}' to be of type: 'bytes', got: {type(v)}"
+                assert isinstance(
+                    v, bytes
+                ), f"Expected msgpack'd value of key 'meta_struct.{k}' to be of type: 'bytes', got: {type(v)}"
             # Decode meta_struct msgpack values
-            decoded_meta_struct = { key: msgpack.unpackb(val_bytes) for key, val_bytes in d["meta_struct"].items() }
+            decoded_meta_struct = {key: msgpack.unpackb(val_bytes) for key, val_bytes in d["meta_struct"].items()}
             for k, val in decoded_meta_struct.items():
-                assert isinstance(val, dict), f"Expected msgpack decoded value of key 'meta_struct.{k}' to be of type: 'dict', got: {type(val)}"
+                assert isinstance(
+                    val, dict
+                ), f"Expected msgpack decoded value of key 'meta_struct.{k}' to be of type: 'dict', got: {type(val)}"
                 for inner_k in val:
-                    assert isinstance(inner_k, str), f"Expected key 'meta_struct.{k}.{inner_k}' to be of type: 'str', got: {type(inner_k)}"
+                    assert isinstance(
+                        inner_k, str
+                    ), f"Expected key 'meta_struct.{k}.{inner_k}' to be of type: 'str', got: {type(inner_k)}"
             d["meta_struct"] = decoded_meta_struct
         if "metrics" in d:
             assert isinstance(d["metrics"], dict)

diff --git a/releasenotes/notes/meta-struct-2cce08475cb05470.yaml b/releasenotes/notes/meta-struct-2cce08475cb05470.yaml
@@ -0,0 +1,6 @@
+---
+features:
+  - |
+    Add support for parsing the `meta_struct` field in traces. This field just like the `meta` field map but the values
+    are arbitrary inner msgpack-encoded values. When the `meta_struct` field is present, its inner messages will be
+    parsed and added to the trace as a dictionary.
diff --git a/tests/test_trace.py b/tests/test_trace.py
@@ -91,34 +91,34 @@ def test_decode_v04(content_type, payload):
             ),
         ),
         (
-                "application/msgpack",
-                msgpack.packb(
+            "application/msgpack",
+            msgpack.packb(
+                [
                     [
-                        [
-                            {
-                                "name": "span",
-                                "span_id": 1234,
-                                "trace_id": 321,
-                                "meta_struct": ["this is not a dict"],
-                            }
-                        ]
+                        {
+                            "name": "span",
+                            "span_id": 1234,
+                            "trace_id": 321,
+                            "meta_struct": ["this is not a dict"],
+                        }
                     ]
-                ),
+                ]
+            ),
         ),
         (
-                "application/msgpack",
-                msgpack.packb(
+            "application/msgpack",
+            msgpack.packb(
+                [
                     [
-                        [
-                            {
-                                "name": "span",
-                                "span_id": 1234,
-                                "trace_id": 321,
-                                "meta_struct": {"key": msgpack.packb(["this is not a dict"])},
-                            }
-                        ]
+                        {
+                            "name": "span",
+                            "span_id": 1234,
+                            "trace_id": 321,
+                            "meta_struct": {"key": msgpack.packb(["this is not a dict"])},
+                        }
                     ]
-                ),
+                ]
+            ),
         ),
     ],
 )