[mongo] Properly handle the null value of waiting_for_latch in operat…

…ion sampling (DataDog#17997)
bhargavnariyanicrest · Aug 5, 2024 · f2b17e7 · f2b17e7
1 parent 8d3d9fa
commit f2b17e7
Show file tree

Hide file tree

Showing 8 changed files with 28 additions and 11 deletions.
diff --git a/mongo/changelog.d/17997.fixed b/mongo/changelog.d/17997.fixed
@@ -0,0 +1 @@
+Fix the default null value for waiting_for_latch in operation sampling. When an operation is not waiting for latch, waiting_for_latch should be an empty dict instead of boolean False.
diff --git a/mongo/datadog_checks/mongo/dbm/operation_samples.py b/mongo/datadog_checks/mongo/dbm/operation_samples.py
@@ -368,7 +368,7 @@ def _get_operation_stats(self, operation: dict) -> OperationSampleOperationStats
             "waiting_for_flow_control": operation.get("waitingForFlowControl", False),  # bool
             "flow_control_stats": self._format_key_name(operation.get("flowControlStats", {})),  # dict
             # Latches
-            "waiting_for_latch": operation.get("waitingForLatch", False),  # bool
+            "waiting_for_latch": self._format_key_name(operation.get("waitingForLatch", {})),  # dict
             # cursor
             "cursor": self._get_operation_cursor(operation),  # dict
         }

diff --git a/mongo/datadog_checks/mongo/dbm/types.py b/mongo/datadog_checks/mongo/dbm/types.py
@@ -2,7 +2,7 @@
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
 
-from typing import List, Optional, TypedDict
+from typing import Dict, List, Optional, TypedDict
 
 
 class OperationSampleClientDriver(TypedDict, total=False):
@@ -106,9 +106,9 @@ class OperationSampleOperationStatsFlowControlStats(TypedDict, total=False):
 
 
 class OperationSampleOperationStatsWaitingForLatch(TypedDict, total=False):
-    timestamp: str
-    captureName: str
-    backtrace: List[str]
+    timestamp: Optional[Dict[str, str]]
+    capture_name: Optional[str]
+    backtrace: Optional[List[str]]
 
 
 class OperationSampleOperationStatsCursor(TypedDict, total=False):

diff --git a/mongo/tests/fixtures/$currentOp-standalone b/mongo/tests/fixtures/$currentOp-standalone
@@ -118,6 +118,12 @@
             }
         },
         "waitingForFlowControl": false,
-        "flowControlStats": {}
+        "flowControlStats": {},
+        "waitingForLatch": {
+            "timestamp": {
+                "$date": "2024-05-16T18:06:38.419Z"
+            },
+            "captureName": "FutureResolution"
+        }
     }
 ]
diff --git a/mongo/tests/results/opeartion-activities-mongos.json b/mongo/tests/results/opeartion-activities-mongos.json
@@ -54,7 +54,7 @@
                 },
                 "waiting_for_flow_control": false,
                 "flow_control_stats": {},
-                "waiting_for_latch": false,
+                "waiting_for_latch": {},
                 "type": "op",
                 "op": "query",
                 "shard": "shard04",
@@ -119,7 +119,7 @@
                 },
                 "waiting_for_flow_control": false,
                 "flow_control_stats": {},
-                "waiting_for_latch": false,
+                "waiting_for_latch": {},
                 "cursor": {
                     "cursor_id": 7153547462305880513,
                     "created_date": "2024-06-13T20:50:10.806000",

diff --git a/mongo/tests/results/opeartion-activities-standalone.json b/mongo/tests/results/opeartion-activities-standalone.json
@@ -47,7 +47,12 @@
                 },
                 "waiting_for_flow_control": false,
                 "flow_control_stats": {},
-                "waiting_for_latch": false,
+                "waiting_for_latch": {
+                    "timestamp": {
+                        "$date": "2024-05-16T18:06:38.419Z"
+                    },
+                    "capture_name": "FutureResolution"
+                },
                 "type": "op",
                 "op": "query",
                 "shard": null,

diff --git a/mongo/tests/results/operation-samples-mongos.json b/mongo/tests/results/operation-samples-mongos.json
@@ -750,7 +750,7 @@
             },
             "waiting_for_flow_control": false,
             "flow_control_stats": {},
-            "waiting_for_latch": false,
+            "waiting_for_latch": {},
             "type": "op",
             "op": "query",
             "shard": "shard04",

diff --git a/mongo/tests/results/operation-samples-standalone.json b/mongo/tests/results/operation-samples-standalone.json
@@ -168,7 +168,12 @@
             },
             "waiting_for_flow_control": false,
             "flow_control_stats": {},
-            "waiting_for_latch": false,
+            "waiting_for_latch": {
+                "timestamp": {
+                    "$date": "2024-05-16T18:06:38.419Z"
+                },
+                "capture_name": "FutureResolution"
+            },
             "type": "op",
             "op": "query",
             "shard": null,
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Fix the default null value for waiting_for_latch in operation sampling. When an operation is not waiting for latch, waiting_for_latch should be an empty dict instead of boolean False.