From d74438853551ceb4c20bc55517ea3142a152788b Mon Sep 17 00:00:00 2001
From: Zhengda Lu <zhengda.lu@datadoghq.com>
Date: Wed, 18 Sep 2024 10:04:57 -0400
Subject: [PATCH] add comments to metrics to indicate which collector it comes
 from (#18611)

---
 mongo/datadog_checks/mongo/metrics.py | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/mongo/datadog_checks/mongo/metrics.py b/mongo/datadog_checks/mongo/metrics.py
index 146cd07263387..f60a532481141 100644
--- a/mongo/datadog_checks/mongo/metrics.py
+++ b/mongo/datadog_checks/mongo/metrics.py
@@ -10,6 +10,7 @@
 Core metrics collected by default.
 """
 BASE_METRICS = {
+    # server_status collector
     "asserts.msg": RATE,
     "asserts.regular": RATE,
     "asserts.rollovers": RATE,
@@ -125,14 +126,17 @@
     "opcountersRepl.insert": RATE,
     "opcountersRepl.query": RATE,
     "opcountersRepl.update": RATE,
+    # replication_info collector
     "oplog.logSizeMB": GAUGE,
     "oplog.usedSizeMB": GAUGE,
     "oplog.timeDiff": GAUGE,
+    # replica collector
     "replSet.health": GAUGE,
     "replSet.replicationLag": GAUGE,
     "replSet.state": GAUGE,
     "replSet.votes": GAUGE,
     "replSet.voteFraction": GAUGE,
+    # db_stats collector
     "stats.avgObjSize": GAUGE,
     "stats.collections": GAUGE,
     "stats.dataSize": GAUGE,
@@ -150,8 +154,10 @@
     "stats.fsUsedSize": GAUGE,
     "stats.fsTotalSize": GAUGE,
     "stats.views": GAUGE,
+    # session_stats collector
     "sessions.count": GAUGE,
     "uptime": GAUGE,
+    # host_info collector
     "system.memSizeMB": (GAUGE, "system.mem.total"),  # total amount of system memory
     "system.memLimitMB": (GAUGE, "system.mem.limit"),  # memory usage limit
     "system.numCores": (GAUGE, "system.cpu.cores"),  # number of CPU cores
@@ -186,7 +192,8 @@
 https://docs.mongodb.org/manual/reference/command/serverStatus/#serverStatus.metrics.commands
 """
 COMMANDS_METRICS = {
-    # Required version >
+    # Required version > 3.0.0
+    # server_status collector
     "metrics.commands.count.failed": RATE,
     "metrics.commands.count.total": GAUGE,
     "metrics.commands.createIndexes.failed": RATE,
@@ -210,6 +217,7 @@
 https://docs.mongodb.org/manual/reference/command/serverStatus/#server-status-locks
 """
 LOCKS_METRICS = {
+    # server_status collector
     "locks.Collection.acquireCount.R": RATE,
     "locks.Collection.acquireCount.r": RATE,
     "locks.Collection.acquireCount.W": RATE,
@@ -262,6 +270,7 @@
 TCMalloc memory allocator report.
 """
 TCMALLOC_METRICS = {
+    # server_status collector
     "tcmalloc.generic.current_allocated_bytes": GAUGE,
     "tcmalloc.generic.heap_size": GAUGE,
     "tcmalloc.tcmalloc.aggressive_memory_decommit": GAUGE,
@@ -279,6 +288,7 @@
 WiredTiger storage engine.
 """
 WIREDTIGER_METRICS = {
+    # server_status collector
     "wiredTiger.cache.bytes currently in the cache": (GAUGE, "wiredTiger.cache.bytes_currently_in_cache"),
     "wiredTiger.cache.bytes read into cache": GAUGE,
     "wiredTiger.cache.bytes written from cache": GAUGE,
@@ -315,6 +325,7 @@
 https://docs.mongodb.org/v3.0/reference/command/top/
 """
 TOP_METRICS = {
+    # top collector
     "commands.count": RATE,
     "commands.time": GAUGE,
     "getmore.count": RATE,
@@ -337,6 +348,7 @@
 
 COLLECTION_METRICS = {
     # collection storage stats
+    # coll_stats collector
     'collection.size': GAUGE,
     'collection.avgObjSize': GAUGE,
     'collection.count': GAUGE,
@@ -365,6 +377,7 @@
 }
 
 SHARDED_DATA_DISTRIBUTION_METRICS = {
+    # sharded_data_distribution collector
     'numOrphanedDocs': (GAUGE, 'sharded_data_distribution.num_orphaned_docs'),
     'numOwnedDocuments': (GAUGE, 'sharded_data_distribution.num_owned_documents'),
     'ownedSizeBytes': (GAUGE, 'sharded_data_distribution.owned_size_bytes'),
@@ -372,6 +385,7 @@
 }
 
 INDEX_METRICS = {
+    # index stats collector
     'indexes.accesses.ops': RATE,
 }