Add short json task string for debug tool use (#6904)

Summary: We will use this short json string method for prestissimo debug use Pull Request resolved: #6904 Reviewed By: amitkdutta, tanjialiang Differential Revision: D49942464 Pulled By: xiaoxmeng fbshipit-source-id: 849ea62f7e36983d4ed66babcf3e6712bb7b8e65
facebookincubator · Oct 5, 2023 · 812f858 · 812f858
1 parent 57c2385
commit 812f858
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/velox/exec/Task.cpp b/velox/exec/Task.cpp
@@ -1964,6 +1964,21 @@ std::string Task::toString() const {
   return out.str();
 }
 
+std::string Task::toShortJsonString() const {
+  std::lock_guard<std::mutex> l(mutex_);
+  folly::dynamic obj = folly::dynamic::object;
+  obj["shortId"] = shortId(taskId_);
+  obj["id"] = taskId_;
+  obj["state"] = taskStateString(state_);
+  obj["numRunningDrivers"] = numRunningDrivers_;
+  obj["numTotalDrivers_"] = numTotalDrivers_;
+  obj["numFinishedDrivers"] = numFinishedDrivers_;
+  obj["numThreads"] = numThreads_;
+  obj["terminateRequested_"] = std::to_string(terminateRequested_);
+  obj["pauseRequested_"] = std::to_string(pauseRequested_);
+  return folly::toPrettyJson(obj);
+}
+
 std::string Task::toJsonString() const {
   std::lock_guard<std::mutex> l(mutex_);
   folly::dynamic obj = folly::dynamic::object;

diff --git a/velox/exec/Task.h b/velox/exec/Task.h
@@ -77,6 +77,8 @@ class Task : public std::enable_shared_from_this<Task> {
 
   std::string toJsonString() const;
 
+  std::string toShortJsonString() const;
+
   /// Returns universally unique identifier of the task.
   const std::string& uuid() const {
     return uuid_;

diff --git a/velox/exec/tests/TaskTest.cpp b/velox/exec/tests/TaskTest.cpp
@@ -519,6 +519,15 @@ TEST_F(TaskTest, wrongPlanNodeForSplit) {
       0,
       std::make_shared<core::QueryCtx>(driverExecutor_.get()));
 
+  ASSERT_EQ(
+      task->toString(), "{Task task-1 (task-1)Plan: -- Project\n\n drivers:\n");
+  ASSERT_EQ(
+      task->toJsonString(),
+      "{\n  \"concurrentSplitGroups\": 1,\n  \"drivers\": {},\n  \"exchangeClientByPlanNode\": {},\n  \"groupedPartitionedOutput\": false,\n  \"id\": \"task-1\",\n  \"noMoreOutputBuffers\": false,\n  \"numDriversPerSplitGroup\": 0,\n  \"numDriversUngrouped\": 0,\n  \"numFinishedDrivers\": 0,\n  \"numRunningDrivers\": 0,\n  \"numRunningSplitGroups\": 0,\n  \"numThreads\": 0,\n  \"numTotalDrivers_\": 0,\n  \"onThreadSince\": \"0\",\n  \"partitionedOutputConsumed\": false,\n  \"plan\": \"-- Project\\n\",\n  \"shortId\": \"task-1\",\n  \"state\": \"Running\",\n  \"terminateRequested_\": \"0\"\n}");
+  ASSERT_EQ(
+      task->toShortJsonString(),
+      "{\n  \"id\": \"task-1\",\n  \"numFinishedDrivers\": 0,\n  \"numRunningDrivers\": 0,\n  \"numThreads\": 0,\n  \"numTotalDrivers_\": 0,\n  \"pauseRequested_\": \"0\",\n  \"shortId\": \"task-1\",\n  \"state\": \"Running\",\n  \"terminateRequested_\": \"0\"\n}");
+
   // Add split for the source node.
   task->addSplit("0", exec::Split(folly::copy(connectorSplit)));