SERVER-98720: Add missing redact() calls to query logs (#33183)

HanaPearlman · MongoDB Bot · commit c8034bbd4ed4 · 2025-04-09T20:59:24.000Z
GitOrigin-RevId: 2d57d2ecc560faa5da609936c4159fe5f64915b6
diff --git a/src/mongo/db/commands/distinct.cpp b/src/mongo/db/commands/distinct.cpp
@@ -341,7 +341,7 @@ class DistinctCommand : public BasicCommand {
                           "Plan executor error during distinct command",
                           "error"_attr = exception.toStatus(),
                           "stats"_attr = redact(stats),
-                          "cmd"_attr = cmdObj);
+                          "cmd"_attr = redact(cmdObj));
 
             exception.addContext("Executor error during distinct command");
             throw;
diff --git a/src/mongo/db/commands/find_cmd.cpp b/src/mongo/db/commands/find_cmd.cpp
@@ -666,7 +666,7 @@ class FindCmd final : public Command {
                               "Plan executor error during find command",
                               "error"_attr = exception.toStatus(),
                               "stats"_attr = redact(stats),
-                              "cmd"_attr = cmdObj);
+                              "cmd"_attr = redact(cmdObj));
 
                 exception.addContext("Executor error during find command");
                 throw;
diff --git a/src/mongo/db/commands/getmore_cmd.cpp b/src/mongo/db/commands/getmore_cmd.cpp
@@ -441,7 +441,7 @@ class GetMoreCmd final : public Command {
                               "getMore command executor error",
                               "error"_attr = exception.toStatus(),
                               "stats"_attr = redact(stats),
-                              "cmd"_attr = cmd.toBSON({}));
+                              "cmd"_attr = redact(cmd.toBSON({})));
 
                 exception.addContext("Executor error during getMore");
                 throw;
diff --git a/src/mongo/db/commands/run_aggregate.cpp b/src/mongo/db/commands/run_aggregate.cpp
@@ -231,7 +231,7 @@ bool handleCursorCommand(OperationContext* opCtx,
                           "Aggregate command executor error",
                           "error"_attr = exception.toStatus(),
                           "stats"_attr = redact(stats),
-                          "cmd"_attr = cmdObj);
+                          "cmd"_attr = redact(cmdObj));
 
             exception.addContext("PlanExecutor error during aggregation");
             throw;
diff --git a/src/mongo/db/query/classic_stage_builder.cpp b/src/mongo/db/query/classic_stage_builder.cpp
@@ -428,7 +428,8 @@ std::unique_ptr<PlanStage> ClassicStageBuilder::build(const QuerySolutionNode* r
         case STAGE_SENTINEL:
         case STAGE_COLUMN_SCAN:
         case STAGE_UPDATE: {
-            LOGV2_WARNING(4615604, "Can't build exec tree for node", "node"_attr = *root);
+            LOGV2_WARNING(
+                4615604, "Can't build exec tree for node", "node"_attr = redact(root->toString()));
         }
     }
 
diff --git a/src/mongo/db/query/expression_index.cpp b/src/mongo/db/query/expression_index.cpp
@@ -182,7 +182,7 @@ void ExpressionMapping::S2CellIdsToIntervals(const std::vector<S2CellId>& interv
     if (!oilOut->isValidFor(1)) {
         LOGV2(6029801,
               "invalid OrderedIntervalList",
-              "orderedIntervalList"_attr = oilOut->toString(false));
+              "orderedIntervalList"_attr = redact(oilOut->toString(false)));
         MONGO_UNREACHABLE;
     }
 }
@@ -231,7 +231,7 @@ void ExpressionMapping::S2CellIdsToIntervalsWithParents(const std::vector<S2Cell
     if (!oilOut->isValidFor(1)) {
         LOGV2(6029802,
               "invalid OrderedIntervalList",
-              "orderedIntervalList"_attr = oilOut->toString(false));
+              "orderedIntervalList"_attr = redact(oilOut->toString(false)));
         MONGO_UNREACHABLE;
     }
 }
diff --git a/src/mongo/db/query/plan_enumerator.cpp b/src/mongo/db/query/plan_enumerator.cpp
@@ -384,7 +384,7 @@ unique_ptr<MatchExpression> PlanEnumerator::getNext() {
     tagForSort(tree.get());
 
     _root->resetTag();
-    LOGV2_DEBUG(20943, 5, "Enumerator: memo just before moving", "memo"_attr = dumpMemo());
+    LOGV2_DEBUG(20943, 5, "Enumerator: memo just before moving", "memo"_attr = redact(dumpMemo()));
     _done = nextMemo(memoIDForNode(_root));
     return tree;
 }
diff --git a/src/mongo/db/query/plan_executor_factory.cpp b/src/mongo/db/query/plan_executor_factory.cpp
@@ -139,8 +139,8 @@ StatusWith<std::unique_ptr<PlanExecutor, PlanExecutor::Deleter>> make(
     LOGV2_DEBUG(4822860,
                 5,
                 "SBE plan",
-                "slots"_attr = data.debugString(),
-                "stages"_attr = sbe::DebugPrinter{}.print(*rootStage));
+                "slots"_attr = redact(data.debugString()),
+                "stages"_attr = redact(sbe::DebugPrinter{}.print(*rootStage)));
 
     return {{new PlanExecutorSBE(
                  opCtx,
@@ -173,8 +173,8 @@ StatusWith<std::unique_ptr<PlanExecutor, PlanExecutor::Deleter>> make(
     LOGV2_DEBUG(4822861,
                 5,
                 "SBE plan",
-                "slots"_attr = candidates.winner().data.stageData.debugString(),
-                "stages"_attr = sbe::DebugPrinter{}.print(*candidates.winner().root));
+                "slots"_attr = redact(candidates.winner().data.stageData.debugString()),
+                "stages"_attr = redact(sbe::DebugPrinter{}.print(*candidates.winner().root)));
 
     return {{new PlanExecutorSBE(opCtx,
                                  std::move(cq),
diff --git a/src/mongo/db/query/planner_ixselect.cpp b/src/mongo/db/query/planner_ixselect.cpp
@@ -659,7 +659,7 @@ bool QueryPlannerIXSelect::_compatible(const BSONElement& keyPatternElt,
     } else {
         LOGV2_WARNING(20954,
                       "Unknown indexing for given node and field",
-                      "node"_attr = node->debugString(),
+                      "node"_attr = redact(node->debugString()),
                       "field"_attr = keyPatternElt.toString());
         MONGO_verify(0);
     }
diff --git a/src/mongo/db/query/query_stats/query_stats.cpp b/src/mongo/db/query/query_stats/query_stats.cpp
@@ -301,7 +301,7 @@ void registerRequest(OperationContext* opCtx,
                     "Error encountered when creating the Query Stats store key. Metrics will not "
                     "be collected for this command",
                     "status"_attr = status,
-                    "command"_attr = cmdObj);
+                    "command"_attr = redact(cmdObj));
         if (kDebugBuild || internalQueryStatsErrorsAreCommandFatal.load()) {
             // uassert rather than tassert so that we avoid creating fatal failures on queries that
             // were going to fail anyway, but trigger the error here first. A query that ONLY fails
diff --git a/src/mongo/db/query/sbe_stage_builder_index_scan.cpp b/src/mongo/db/query/sbe_stage_builder_index_scan.cpp
@@ -770,8 +770,8 @@ IndexIntervals makeIntervalsFromIndexBounds(const IndexBounds& bounds,
         LOGV2_DEBUG(4742906,
                     5,
                     "Generated interval [lowKey, highKey]",
-                    "lowKey"_attr = lowKey,
-                    "highKey"_attr = highKey);
+                    "lowKey"_attr = redact(lowKey),
+                    "highKey"_attr = redact(highKey));
         // Note that 'makeKeyFromBSONKeyForSeek()' is intended to compute the "start" key for an
         // index scan. The logic for computing a "discriminator" for an "end" key is reversed, which
         // is why we use 'makeKeyStringFromBSONKey()' to manually specify the discriminator for the
diff --git a/src/mongo/db/query/stats/stats_cache_loader_impl.cpp b/src/mongo/db/query/stats/stats_cache_loader_impl.cpp
@@ -49,7 +49,7 @@ SemiFuture<StatsCacheVal> StatsCacheLoaderImpl::getStats(OperationContext* opCtx
 
     FindCommandRequest findRequest{statsNss};
     BSONObj filter = BSON("_id" << statsPath.second);
-    LOGV2_DEBUG(7085600, 1, "findRequest filter", "filter"_attr = filter.toString());
+    LOGV2_DEBUG(7085600, 1, "findRequest filter", "filter"_attr = redact(filter.toString()));
     findRequest.setFilter(filter.getOwned());
 
     try {

Original file line number	Diff line number	Diff line change
`@@ -428,7 +428,8 @@ std::unique_ptr<PlanStage> ClassicStageBuilder::build(const QuerySolutionNode* r`
`428`	`428`	`case STAGE_SENTINEL:`
`429`	`429`	`case STAGE_COLUMN_SCAN:`
`430`	`430`	`case STAGE_UPDATE: {`
`431`		`- LOGV2_WARNING(4615604, "Can't build exec tree for node", "node"_attr = *root);`
	`431`	`+ LOGV2_WARNING(`
	`432`	`+ 4615604, "Can't build exec tree for node", "node"_attr = redact(root->toString()));`
`432`	`433`	`}`
`433`	`434`	`}`
`434`	`435`
Original file line number	Diff line number	Diff line change
`@@ -182,7 +182,7 @@ void ExpressionMapping::S2CellIdsToIntervals(const std::vector<S2CellId>& interv`
`182`	`182`	`if (!oilOut->isValidFor(1)) {`
`183`	`183`	`LOGV2(6029801,`
`184`	`184`	`"invalid OrderedIntervalList",`
`185`		`- "orderedIntervalList"_attr = oilOut->toString(false));`
	`185`	`+ "orderedIntervalList"_attr = redact(oilOut->toString(false)));`
`186`	`186`	`MONGO_UNREACHABLE;`
`187`	`187`	`}`
`188`	`188`	`}`
`@@ -231,7 +231,7 @@ void ExpressionMapping::S2CellIdsToIntervalsWithParents(const std::vector<S2Cell`
`231`	`231`	`if (!oilOut->isValidFor(1)) {`
`232`	`232`	`LOGV2(6029802,`
`233`	`233`	`"invalid OrderedIntervalList",`
`234`		`- "orderedIntervalList"_attr = oilOut->toString(false));`
	`234`	`+ "orderedIntervalList"_attr = redact(oilOut->toString(false)));`
`235`	`235`	`MONGO_UNREACHABLE;`
`236`	`236`	`}`
`237`	`237`	`}`
Original file line number	Diff line number	Diff line change
`@@ -384,7 +384,7 @@ unique_ptr<MatchExpression> PlanEnumerator::getNext() {`
`384`	`384`	`tagForSort(tree.get());`
`385`	`385`
`386`	`386`	`_root->resetTag();`
`387`		`- LOGV2_DEBUG(20943, 5, "Enumerator: memo just before moving", "memo"_attr = dumpMemo());`
	`387`	`+ LOGV2_DEBUG(20943, 5, "Enumerator: memo just before moving", "memo"_attr = redact(dumpMemo()));`
`388`	`388`	`_done = nextMemo(memoIDForNode(_root));`
`389`	`389`	`return tree;`
`390`	`390`	`}`
Original file line number	Diff line number	Diff line change
`@@ -659,7 +659,7 @@ bool QueryPlannerIXSelect::_compatible(const BSONElement& keyPatternElt,`
`659`	`659`	`} else {`
`660`	`660`	`LOGV2_WARNING(20954,`
`661`	`661`	`"Unknown indexing for given node and field",`
`662`		`- "node"_attr = node->debugString(),`
	`662`	`+ "node"_attr = redact(node->debugString()),`
`663`	`663`	`"field"_attr = keyPatternElt.toString());`
`664`	`664`	`MONGO_verify(0);`
`665`	`665`	`}`