[mongo] new query plancache and sort stage metrics (#18513)

* new query plancache and sort stage metrics * add changelog * update metadata
DataDog · Sep 5, 2024 · 32687a4 · 32687a4
1 parent 75adce4
commit 32687a4
Show file tree

Hide file tree

Showing 5 changed files with 89 additions and 0 deletions.
diff --git a/mongo/changelog.d/18513.added b/mongo/changelog.d/18513.added
@@ -0,0 +1,8 @@
+Add new metrics for MongoDB query plan cache (requires MongoDB 7.0+) and sort stages (requires MongoDB 6.2+):
+- mongodb.metrics.query.plancache.classic.hitsps
+- mongodb.metrics.query.plancache.classic.missesps
+- mongodb.metrics.query.plancache.sbe.hitsps
+- mongodb.metrics.query.plancache.sbe.missesps
+- mongodb.metrics.query.sort.spilltodiskps
+- mongodb.metrics.query.sort.totalbytessortedps
+- mongodb.metrics.query.sort.totalkeyssortedps
diff --git a/mongo/datadog_checks/mongo/metrics.py b/mongo/datadog_checks/mongo/metrics.py
@@ -71,6 +71,13 @@
     "metrics.operation.idhack": RATE,
     "metrics.operation.scanAndOrder": RATE,
     "metrics.operation.writeConflicts": RATE,
+    "metrics.query.sort.spillToDisk": RATE,
+    "metrics.query.sort.totalBytesSorted": RATE,
+    "metrics.query.sort.totalKeysSorted": RATE,
+    "metrics.query.planCache.classic.hits": RATE,
+    "metrics.query.planCache.classic.misses": RATE,
+    "metrics.query.planCache.sbe.hits": RATE,
+    "metrics.query.planCache.sbe.misses": RATE,
     "metrics.queryExecutor.scanned": RATE,
     "metrics.queryExecutor.scannedObjects": RATE,
     "metrics.record.moves": RATE,

diff --git a/mongo/metadata.csv b/mongo/metadata.csv
@@ -160,6 +160,13 @@ mongodb.metrics.operation.fastmodps,gauge,,operation,second,Number of update ope
 mongodb.metrics.operation.idhackps,gauge,,query,second,Number of queries per second that contain the _id field.,0,mongodb,operation idhack ps,,
 mongodb.metrics.operation.scanandorderps,gauge,,query,second,Number of queries per second that return sorted numbers that cannot perform the sort operation using an index.,0,mongodb,operation scanandorder ps,,
 mongodb.metrics.operation.writeconflictsps,gauge,,event,second,Number of times per second that write concern operations has encounter a conflict.,0,mongodb,write conflict,,
+mongodb.metrics.query.plancache.classic.hitsps,gauge,,operation,second,Number of times per second the query planner accesses the classic plan cache and finds a cached plan (requires MongoDB 7.0 and above).,0,mongodb,query plancache classic hits ps,,
+mongodb.metrics.query.plancache.classic.missesps,gauge,,operation,second,Number of times per second the query planner accesses the classic plan cache and does not find a cached plan (requires MongoDB 7.0 and above).,0,mongodb,query plancache classic misses ps,,
+mongodb.metrics.query.plancache.sbe.hitsps,gauge,,operation,second,Number of times per second the query planner accesses the slot-based execution engine plan cache and finds a cached plan (requires MongoDB 7.0 and above).,0,mongodb,query plancache sbe hits ps,,
+mongodb.metrics.query.plancache.sbe.missesps,gauge,,operation,second,Number of times per second the query planner accesses the slot-based execution engine plan cache and does not find a cached plan (requires MongoDB 7.0 and above).,0,mongodb,query plancache sbe misses ps,,
+mongodb.metrics.query.sort.spilltodiskps,gauge,,operation,second,The total number of writes per second to disk caused by sort stages (requires MongoDB 6.2 and above).,0,mongodb,sort spill to disk ps,,
+mongodb.metrics.query.sort.totalbytessortedps,gauge,,byte,second,The total amount of sorted data in bytes per second (requires MongoDB 6.2 and above).,0,mongodb,sort total bytes sorted ps,,
+mongodb.metrics.query.sort.totalkeyssortedps,gauge,,key,second,The total number of keys used in sorts per second (requires MongoDB 6.2 and above).,0,mongodb,sort total keys sorted ps,,
 mongodb.metrics.queryexecutor.scannedobjectsps,gauge,,operation,second,Number of documents scanned per second during queries and query-plan evaluation.,0,mongodb,queryexecutor scanned object ps,,
 mongodb.metrics.queryexecutor.scannedps,gauge,,operation,second,Number of index items scanned per second during queries and query-plan evaluation.,0,mongodb,queryexecutor scanned ps,,
 mongodb.metrics.record.movesps,gauge,,operation,second,Number of times per second documents move within the on-disk representation of the MongoDB data set.,0,mongodb,record moves ps,,

diff --git a/mongo/tests/fixtures/serverStatus b/mongo/tests/fixtures/serverStatus
@@ -921,6 +921,17 @@
             "fastmod": 12,
             "idhack": 13
         },
+        "query": {
+            "planCache": {
+              "classic": { "hits": 13041302, "misses": 1023350 },
+              "sbe": { "hits": 444, "misses": 878 }
+            },
+            "sort": {
+              "spillToDisk": 18,
+              "totalBytesSorted": 4808797953,
+              "totalKeysSorted": 14394599
+            }
+        },
         "queryExecutor": {
             "scanned": 46,
             "scannedObjects": 97

diff --git a/mongo/tests/results/metrics-serverStatus.json b/mongo/tests/results/metrics-serverStatus.json
@@ -399,6 +399,62 @@
             "server:mongodb://testUser2:*****@localhost:27017/test"
         ]
     },
+    {
+        "name": "mongodb.metrics.query.plancache.classic.hitsps",
+        "type": 1,
+        "value": 13041302.0,
+        "tags": [
+            "server:mongodb://testUser2:*****@localhost:27017/test"
+        ]
+    },
+    {
+        "name": "mongodb.metrics.query.plancache.classic.missesps",
+        "type": 1,
+        "value": 1023350.0,
+        "tags": [
+            "server:mongodb://testUser2:*****@localhost:27017/test"
+        ]
+    },
+    {
+        "name": "mongodb.metrics.query.plancache.sbe.hitsps",
+        "type": 1,
+        "value": 444.0,
+        "tags": [
+            "server:mongodb://testUser2:*****@localhost:27017/test"
+        ]
+    },
+    {
+        "name": "mongodb.metrics.query.plancache.sbe.missesps",
+        "type": 1,
+        "value": 878.0,
+        "tags": [
+            "server:mongodb://testUser2:*****@localhost:27017/test"
+        ]
+    },
+    {
+        "name": "mongodb.metrics.query.sort.spilltodiskps",
+        "type": 1,
+        "value": 18.0,
+        "tags": [
+            "server:mongodb://testUser2:*****@localhost:27017/test"
+        ]
+    },
+    {
+        "name": "mongodb.metrics.query.sort.totalbytessortedps",
+        "type": 1,
+        "value": 4808797953.0,
+        "tags": [
+            "server:mongodb://testUser2:*****@localhost:27017/test"
+        ]
+    },
+    {
+        "name": "mongodb.metrics.query.sort.totalkeyssortedps",
+        "type": 1,
+        "value": 14394599.0,
+        "tags": [
+            "server:mongodb://testUser2:*****@localhost:27017/test"
+        ]
+    },
     {
         "name": "mongodb.metrics.queryexecutor.scannedps",
         "type": 1,