From edcb0bc5e1e375d9345f822cccea53af110a9ac4 Mon Sep 17 00:00:00 2001
From: wxyu <xy.wang@zilliz.com>
Date: Wed, 23 Oct 2019 17:12:36 +0800
Subject: [PATCH] Improvement dump function in scheduler

Former-commit-id: b7c550a7fb4e05c66afa217f435b401d9cae5613
---
 core/src/scheduler/JobMgr.cpp               |  9 ++++++
 core/src/scheduler/JobMgr.h                 |  6 +++-
 core/src/scheduler/ResourceMgr.cpp          | 28 +++++++++--------
 core/src/scheduler/ResourceMgr.h            |  7 +++--
 core/src/scheduler/Scheduler.cpp            | 10 ++++--
 core/src/scheduler/Scheduler.h              | 11 +++----
 core/src/scheduler/TaskTable.cpp            |  6 ++--
 core/src/scheduler/TaskTable.h              |  6 ++--
 core/src/scheduler/interface/interfaces.h   |  2 +-
 core/src/scheduler/job/BuildIndexJob.cpp    |  8 +++++
 core/src/scheduler/job/BuildIndexJob.h      |  3 ++
 core/src/scheduler/job/DeleteJob.cpp        | 10 ++++++
 core/src/scheduler/job/DeleteJob.h          |  3 ++
 core/src/scheduler/job/Job.h                |  4 ++-
 core/src/scheduler/job/SearchJob.cpp        | 10 ++++++
 core/src/scheduler/job/SearchJob.h          |  3 ++
 core/src/scheduler/resource/CpuResource.cpp |  2 +-
 core/src/scheduler/resource/CpuResource.h   |  5 ---
 core/src/scheduler/resource/DiskResource.h  |  5 ---
 core/src/scheduler/resource/GpuResource.cpp |  2 +-
 core/src/scheduler/resource/GpuResource.h   |  5 ---
 core/src/scheduler/resource/Node.cpp        | 22 ++++++++-----
 core/src/scheduler/resource/Node.h          |  7 +++--
 core/src/scheduler/resource/Resource.cpp    | 34 +++++++++++++++++++++
 core/src/scheduler/resource/Resource.h      |  6 ++--
 core/src/scheduler/resource/TestResource.h  |  5 ---
 26 files changed, 148 insertions(+), 71 deletions(-)

diff --git a/core/src/scheduler/JobMgr.cpp b/core/src/scheduler/JobMgr.cpp
index 70f1352a5c..e7b15a8185 100644
--- a/core/src/scheduler/JobMgr.cpp
+++ b/core/src/scheduler/JobMgr.cpp
@@ -49,6 +49,15 @@ JobMgr::Stop() {
     }
 }
 
+json
+JobMgr::Dump() const {
+    json ret{
+        {"running", running_},
+        {"event_queue_length", queue_.size()},
+    };
+    return ret;
+}
+
 void
 JobMgr::Put(const JobPtr& job) {
     {
diff --git a/core/src/scheduler/JobMgr.h b/core/src/scheduler/JobMgr.h
index b4c706d359..fbd6c0ee45 100644
--- a/core/src/scheduler/JobMgr.h
+++ b/core/src/scheduler/JobMgr.h
@@ -28,13 +28,14 @@
 #include <vector>
 
 #include "ResourceMgr.h"
+#include "interface/interfaces.h"
 #include "job/Job.h"
 #include "task/Task.h"
 
 namespace milvus {
 namespace scheduler {
 
-class JobMgr {
+class JobMgr : public interface::dumpable {
  public:
     explicit JobMgr(ResourceMgrPtr res_mgr);
 
@@ -44,6 +45,9 @@ class JobMgr {
     void
     Stop();
 
+    json
+    Dump() const override;
+
  public:
     void
     Put(const JobPtr& job);
diff --git a/core/src/scheduler/ResourceMgr.cpp b/core/src/scheduler/ResourceMgr.cpp
index 6e839062ef..383ad89c4e 100644
--- a/core/src/scheduler/ResourceMgr.cpp
+++ b/core/src/scheduler/ResourceMgr.cpp
@@ -170,16 +170,20 @@ ResourceMgr::GetNumGpuResource() const {
     return num;
 }
 
-std::string
-ResourceMgr::Dump() {
-    std::stringstream ss;
-    ss << "ResourceMgr contains " << resources_.size() << " resources." << std::endl;
-
-    for (auto& res : resources_) {
-        ss << res->Dump();
+json
+ResourceMgr::Dump() const {
+    json resources{};
+    for (auto &res : resources_) {
+        resources.push_back(res->Dump());
     }
-
-    return ss.str();
+    json ret{
+        {"number_of_resource", resources_.size()},
+        {"number_of_disk_resource", disk_resources_.size()},
+        {"number_of_cpu_resource", cpu_resources_.size()},
+        {"number_of_gpu_resource", gpu_resources_.size()},
+        {"resources", resources},
+    };
+    return ret;
 }
 
 std::string
@@ -187,9 +191,9 @@ ResourceMgr::DumpTaskTables() {
     std::stringstream ss;
     ss << ">>>>>>>>>>>>>>>ResourceMgr::DumpTaskTable<<<<<<<<<<<<<<<" << std::endl;
     for (auto& resource : resources_) {
-        ss << resource->Dump() << std::endl;
-        ss << resource->task_table().Dump();
-        ss << resource->Dump() << std::endl << std::endl;
+        ss << resource->name() << std::endl;
+        ss << resource->task_table().Dump().dump();
+        ss << resource->name() << std::endl << std::endl;
     }
     return ss.str();
 }
diff --git a/core/src/scheduler/ResourceMgr.h b/core/src/scheduler/ResourceMgr.h
index 7a8e1ca4ca..4d2361fb3d 100644
--- a/core/src/scheduler/ResourceMgr.h
+++ b/core/src/scheduler/ResourceMgr.h
@@ -25,13 +25,14 @@
 #include <utility>
 #include <vector>
 
+#include "interface/interfaces.h"
 #include "resource/Resource.h"
 #include "utils/Log.h"
 
 namespace milvus {
 namespace scheduler {
 
-class ResourceMgr {
+class ResourceMgr : public interface::dumpable {
  public:
     ResourceMgr() = default;
 
@@ -103,8 +104,8 @@ class ResourceMgr {
 
  public:
     /******** Utility Functions ********/
-    std::string
-    Dump();
+    json
+    Dump() const override;
 
     std::string
     DumpTaskTables();
diff --git a/core/src/scheduler/Scheduler.cpp b/core/src/scheduler/Scheduler.cpp
index 19197b4168..fef5cc1a95 100644
--- a/core/src/scheduler/Scheduler.cpp
+++ b/core/src/scheduler/Scheduler.cpp
@@ -66,9 +66,13 @@ Scheduler::PostEvent(const EventPtr& event) {
     event_cv_.notify_one();
 }
 
-std::string
-Scheduler::Dump() {
-    return std::string();
+json
+Scheduler::Dump() const {
+    json ret{
+        {"running", running_},
+        {"event_queue_length", event_queue_.size()},
+    };
+    return ret;
 }
 
 void
diff --git a/core/src/scheduler/Scheduler.h b/core/src/scheduler/Scheduler.h
index 5b222cc41a..8d9ea83794 100644
--- a/core/src/scheduler/Scheduler.h
+++ b/core/src/scheduler/Scheduler.h
@@ -25,14 +25,14 @@
 #include <unordered_map>
 
 #include "ResourceMgr.h"
+#include "interface/interfaces.h"
 #include "resource/Resource.h"
 #include "utils/Log.h"
 
 namespace milvus {
 namespace scheduler {
 
-// TODO(wxyu): refactor, not friendly to unittest, logical in framework code
-class Scheduler {
+class Scheduler : public interface::dumpable {
  public:
     explicit Scheduler(ResourceMgrWPtr res_mgr);
 
@@ -57,11 +57,8 @@ class Scheduler {
     void
     PostEvent(const EventPtr& event);
 
-    /*
-     * Dump as string;
-     */
-    std::string
-    Dump();
+    json
+    Dump() const override;
 
  private:
     /******** Events ********/
diff --git a/core/src/scheduler/TaskTable.cpp b/core/src/scheduler/TaskTable.cpp
index cad7ce3a74..d0e6c1c38b 100644
--- a/core/src/scheduler/TaskTable.cpp
+++ b/core/src/scheduler/TaskTable.cpp
@@ -53,7 +53,7 @@ ToString(TaskTableItemState state) {
 }
 
 json
-TaskTimestamp::Dump() {
+TaskTimestamp::Dump() const {
     json ret{
         {"start", start},       {"load", load}, {"loaded", loaded}, {"execute", execute},
         {"executed", executed}, {"move", move}, {"moved", moved},   {"finish", finish},
@@ -141,7 +141,7 @@ TaskTableItem::Moved() {
 }
 
 json
-TaskTableItem::Dump() {
+TaskTableItem::Dump() const {
     json ret{
         {"id", id},
         {"task", (int64_t)task.get()},
@@ -263,7 +263,7 @@ TaskTable::Get(uint64_t index) {
 //}
 
 json
-TaskTable::Dump() {
+TaskTable::Dump() const {
     json ret;
     for (auto& item : table_) {
         ret.push_back(item->Dump());
diff --git a/core/src/scheduler/TaskTable.h b/core/src/scheduler/TaskTable.h
index 307528fffb..a9d00043c2 100644
--- a/core/src/scheduler/TaskTable.h
+++ b/core/src/scheduler/TaskTable.h
@@ -54,7 +54,7 @@ struct TaskTimestamp : public interface::dumpable {
     uint64_t finish = 0;
 
     json
-    Dump() override;
+    Dump() const override;
 };
 
 struct TaskTableItem : public interface::dumpable {
@@ -92,7 +92,7 @@ struct TaskTableItem : public interface::dumpable {
     Moved();
 
     json
-    Dump() override;
+    Dump() const override;
 };
 
 using TaskTableItemPtr = std::shared_ptr<TaskTableItem>;
@@ -245,7 +245,7 @@ class TaskTable : public interface::dumpable {
      * Dump;
      */
     json
-    Dump() override;
+    Dump() const override;
 
  private:
     std::uint64_t id_ = 0;
diff --git a/core/src/scheduler/interface/interfaces.h b/core/src/scheduler/interface/interfaces.h
index 68e5af8cdb..9920e4f80a 100644
--- a/core/src/scheduler/interface/interfaces.h
+++ b/core/src/scheduler/interface/interfaces.h
@@ -37,7 +37,7 @@ struct dumpable {
     }
 
     virtual json
-    Dump() = 0;
+    Dump() const = 0;
 };
 
 }  // namespace interface
diff --git a/core/src/scheduler/job/BuildIndexJob.cpp b/core/src/scheduler/job/BuildIndexJob.cpp
index 423121c5fb..39c08b6b51 100644
--- a/core/src/scheduler/job/BuildIndexJob.cpp
+++ b/core/src/scheduler/job/BuildIndexJob.cpp
@@ -54,5 +54,13 @@ BuildIndexJob::BuildIndexDone(size_t to_index_id) {
     SERVER_LOG_DEBUG << "BuildIndexJob " << id() << " finish index file: " << to_index_id;
 }
 
+json
+BuildIndexJob::Dump() const {
+    json ret{
+        {"number_of_to_index_file", to_index_files_.size()},
+    };
+    return ret;
+}
+
 }  // namespace scheduler
 }  // namespace milvus
diff --git a/core/src/scheduler/job/BuildIndexJob.h b/core/src/scheduler/job/BuildIndexJob.h
index b6ca462537..e3450ee048 100644
--- a/core/src/scheduler/job/BuildIndexJob.h
+++ b/core/src/scheduler/job/BuildIndexJob.h
@@ -53,6 +53,9 @@ class BuildIndexJob : public Job {
     void
     BuildIndexDone(size_t to_index_id);
 
+    json
+    Dump() const override;
+
  public:
     Status&
     GetStatus() {
diff --git a/core/src/scheduler/job/DeleteJob.cpp b/core/src/scheduler/job/DeleteJob.cpp
index 96a6bb1817..04a9557177 100644
--- a/core/src/scheduler/job/DeleteJob.cpp
+++ b/core/src/scheduler/job/DeleteJob.cpp
@@ -45,5 +45,15 @@ DeleteJob::ResourceDone() {
     cv_.notify_one();
 }
 
+json
+DeleteJob::Dump() const {
+    json ret{
+        {"table_id", table_id_},
+        {"number_of_resource", num_resource_},
+        {"number_of_done", done_resource},
+    };
+    return ret;
+}
+
 }  // namespace scheduler
 }  // namespace milvus
diff --git a/core/src/scheduler/job/DeleteJob.h b/core/src/scheduler/job/DeleteJob.h
index 4ac48f6913..93e5aa40cc 100644
--- a/core/src/scheduler/job/DeleteJob.h
+++ b/core/src/scheduler/job/DeleteJob.h
@@ -44,6 +44,9 @@ class DeleteJob : public Job {
     void
     ResourceDone();
 
+    json
+    Dump() const override;
+
  public:
     std::string
     table_id() const {
diff --git a/core/src/scheduler/job/Job.h b/core/src/scheduler/job/Job.h
index 5fe645363f..709db8cffc 100644
--- a/core/src/scheduler/job/Job.h
+++ b/core/src/scheduler/job/Job.h
@@ -27,6 +27,8 @@
 #include <unordered_map>
 #include <vector>
 
+#include "scheduler/interface/interfaces.h"
+
 namespace milvus {
 namespace scheduler {
 
@@ -39,7 +41,7 @@ enum class JobType {
 
 using JobId = std::uint64_t;
 
-class Job {
+class Job : public interface::dumpable {
  public:
     inline JobId
     id() const {
diff --git a/core/src/scheduler/job/SearchJob.cpp b/core/src/scheduler/job/SearchJob.cpp
index 518e3111c0..1143e33add 100644
--- a/core/src/scheduler/job/SearchJob.cpp
+++ b/core/src/scheduler/job/SearchJob.cpp
@@ -63,5 +63,15 @@ SearchJob::GetStatus() {
     return status_;
 }
 
+json
+SearchJob::Dump() const {
+    json ret{
+        {"topk", topk_},
+        {"nq", nq_},
+        {"nprobe", nprobe_},
+    };
+    return ret;
+}
+
 }  // namespace scheduler
 }  // namespace milvus
diff --git a/core/src/scheduler/job/SearchJob.h b/core/src/scheduler/job/SearchJob.h
index fb2d87d876..6c2bd7eea9 100644
--- a/core/src/scheduler/job/SearchJob.h
+++ b/core/src/scheduler/job/SearchJob.h
@@ -61,6 +61,9 @@ class SearchJob : public Job {
     Status&
     GetStatus();
 
+    json
+    Dump() const override;
+
  public:
     uint64_t
     topk() const {
diff --git a/core/src/scheduler/resource/CpuResource.cpp b/core/src/scheduler/resource/CpuResource.cpp
index 500737a829..eb43a863cc 100644
--- a/core/src/scheduler/resource/CpuResource.cpp
+++ b/core/src/scheduler/resource/CpuResource.cpp
@@ -24,7 +24,7 @@ namespace scheduler {
 
 std::ostream&
 operator<<(std::ostream& out, const CpuResource& resource) {
-    out << resource.Dump();
+    out << resource.Dump().dump();
     return out;
 }
 
diff --git a/core/src/scheduler/resource/CpuResource.h b/core/src/scheduler/resource/CpuResource.h
index e3e4fc383f..10cd88ea2d 100644
--- a/core/src/scheduler/resource/CpuResource.h
+++ b/core/src/scheduler/resource/CpuResource.h
@@ -28,11 +28,6 @@ class CpuResource : public Resource {
  public:
     explicit CpuResource(std::string name, uint64_t device_id, bool enable_loader, bool enable_executor);
 
-    inline std::string
-    Dump() const override {
-        return "<CpuResource, name=" + name_ + ">";
-    }
-
     friend std::ostream&
     operator<<(std::ostream& out, const CpuResource& resource);
 
diff --git a/core/src/scheduler/resource/DiskResource.h b/core/src/scheduler/resource/DiskResource.h
index 2346cd115a..384e44b4f2 100644
--- a/core/src/scheduler/resource/DiskResource.h
+++ b/core/src/scheduler/resource/DiskResource.h
@@ -28,11 +28,6 @@ class DiskResource : public Resource {
  public:
     explicit DiskResource(std::string name, uint64_t device_id, bool enable_loader, bool enable_executor);
 
-    inline std::string
-    Dump() const override {
-        return "<DiskResource, name=" + name_ + ">";
-    }
-
     friend std::ostream&
     operator<<(std::ostream& out, const DiskResource& resource);
 
diff --git a/core/src/scheduler/resource/GpuResource.cpp b/core/src/scheduler/resource/GpuResource.cpp
index 20ed73e38c..f6363ff01d 100644
--- a/core/src/scheduler/resource/GpuResource.cpp
+++ b/core/src/scheduler/resource/GpuResource.cpp
@@ -22,7 +22,7 @@ namespace scheduler {
 
 std::ostream&
 operator<<(std::ostream& out, const GpuResource& resource) {
-    out << resource.Dump();
+    out << resource.Dump().dump();
     return out;
 }
 
diff --git a/core/src/scheduler/resource/GpuResource.h b/core/src/scheduler/resource/GpuResource.h
index e0df03d5a7..86b3b6658c 100644
--- a/core/src/scheduler/resource/GpuResource.h
+++ b/core/src/scheduler/resource/GpuResource.h
@@ -29,11 +29,6 @@ class GpuResource : public Resource {
  public:
     explicit GpuResource(std::string name, uint64_t device_id, bool enable_loader, bool enable_executor);
 
-    inline std::string
-    Dump() const override {
-        return "<GpuResource, name=" + name_ + ">";
-    }
-
     friend std::ostream&
     operator<<(std::ostream& out, const GpuResource& resource);
 
diff --git a/core/src/scheduler/resource/Node.cpp b/core/src/scheduler/resource/Node.cpp
index 5401c36441..9621c4324e 100644
--- a/core/src/scheduler/resource/Node.cpp
+++ b/core/src/scheduler/resource/Node.cpp
@@ -38,15 +38,21 @@ Node::GetNeighbours() {
     return ret;
 }
 
-std::string
-Node::Dump() {
-    std::stringstream ss;
-    ss << "<Node, id=" << std::to_string(id_) << ">::neighbours:" << std::endl;
-    for (auto& neighbour : neighbours_) {
-        ss << "\t<Neighbour, id=" << std::to_string(neighbour.first);
-        ss << ", connection: " << neighbour.second.connection.Dump() << ">" << std::endl;
+json
+Node::Dump() const {
+    json neighbours;
+    for (auto & neighbour : neighbours_) {
+        json n;
+        n["id"] = neighbour.first;
+        n["connection"] = neighbour.second.connection.Dump();
+        neighbours.push_back(n);
     }
-    return ss.str();
+
+    json ret{
+        {"id", id_},
+        {"neighbours", neighbours},
+    };
+    return ret;
 }
 
 void
diff --git a/core/src/scheduler/resource/Node.h b/core/src/scheduler/resource/Node.h
index 071ee9bab8..4539c8c86a 100644
--- a/core/src/scheduler/resource/Node.h
+++ b/core/src/scheduler/resource/Node.h
@@ -24,6 +24,7 @@
 
 #include "Connection.h"
 #include "scheduler/TaskTable.h"
+#include "scheduler/interface/interfaces.h"
 
 namespace milvus {
 namespace scheduler {
@@ -41,7 +42,7 @@ struct Neighbour {
 };
 
 // TODO(lxj): return type void -> Status
-class Node {
+class Node : public interface::dumpable {
  public:
     Node();
 
@@ -52,8 +53,8 @@ class Node {
     GetNeighbours();
 
  public:
-    std::string
-    Dump();
+    json
+    Dump() const override;
 
  private:
     std::mutex mutex_;
diff --git a/core/src/scheduler/resource/Resource.cpp b/core/src/scheduler/resource/Resource.cpp
index 59fd22b5d6..aac1953845 100644
--- a/core/src/scheduler/resource/Resource.cpp
+++ b/core/src/scheduler/resource/Resource.cpp
@@ -32,6 +32,24 @@ operator<<(std::ostream& out, const Resource& resource) {
     return out;
 }
 
+std::string
+ToString(ResourceType type) {
+    switch (type) {
+        case ResourceType::DISK: {
+            return "DISK";
+        }
+        case ResourceType::CPU: {
+            return "CPU";
+        }
+        case ResourceType::GPU: {
+            return "GPU";
+        }
+        default: {
+            return "UNKNOWN";
+        }
+    }
+}
+
 Resource::Resource(std::string name, ResourceType type, uint64_t device_id, bool enable_loader, bool enable_executor)
     : name_(std::move(name)),
       type_(type),
@@ -89,6 +107,22 @@ Resource::WakeupExecutor() {
     exec_cv_.notify_one();
 }
 
+json
+Resource::Dump() const {
+    json ret{
+        {"device_id", device_id_},
+        {"name", name_},
+        {"type", ToString(type_)},
+        {"task_average_cost", TaskAvgCost()},
+        {"task_total_cost", total_cost_},
+        {"total_tasks", total_task_},
+        {"running", running_},
+        {"enable_loader", enable_loader_},
+        {"enable_executor", enable_executor_},
+    };
+    return ret;
+}
+
 uint64_t
 Resource::NumOfTaskToExec() {
     uint64_t count = 0;
diff --git a/core/src/scheduler/resource/Resource.h b/core/src/scheduler/resource/Resource.h
index c9026f13b6..c797e13de8 100644
--- a/core/src/scheduler/resource/Resource.h
+++ b/core/src/scheduler/resource/Resource.h
@@ -77,10 +77,8 @@ class Resource : public Node, public std::enable_shared_from_this<Resource> {
         subscriber_ = std::move(subscriber);
     }
 
-    inline virtual std::string
-    Dump() const {
-        return "<Resource>";
-    }
+    json
+    Dump() const override;
 
  public:
     inline std::string
diff --git a/core/src/scheduler/resource/TestResource.h b/core/src/scheduler/resource/TestResource.h
index 9bbc5a54d0..4e4e148d6f 100644
--- a/core/src/scheduler/resource/TestResource.h
+++ b/core/src/scheduler/resource/TestResource.h
@@ -29,11 +29,6 @@ class TestResource : public Resource {
  public:
     explicit TestResource(std::string name, uint64_t device_id, bool enable_loader, bool enable_executor);
 
-    inline std::string
-    Dump() const override {
-        return "<TestResource, name=" + name_ + ">";
-    }
-
     friend std::ostream&
     operator<<(std::ostream& out, const TestResource& resource);