Current state: Under Discussion
ISSUE:
PRs:
Keywords: metric
Proxy
Released:
...
- Pros: Reduce the duplicated work that all coordinators implement the same logic.
- Cons:
- Introduce the dependency between etcd and Proxy.
- Not easy to get resource usage of nodes, such as memory usage, cpu usage and etc.
How to use GetMetrics
interface?
Detailed Implementation of Plan 1
Every component in Milvus should have an interface GetMetrics to expose their metrics. As the user access layer, Proxy connects to other coordinators directly, such as RootCoord, DataCoord, QueryCoord and IndexCoord. Taking QueryCoord as an example, how could Proxy get topology metrics between QueryCoord and Query Nodes? The answer is that Proxy get these metrics from QueryCoord. QueryCoord manages all the Query Nodes, so the metrics of Query Nodes can be easily reported to QueryCoord and then QueryCoord an summary these metrics to Proxy.
We should add GetMetrics interface to rpc service of coordinator and related node:
Code Block |
---|
service QueryCoord {
rpc GetMetrics(milvus.GetMetricsRequest) returns (milvus.GetMetricsResponse) {}
}
service QueryNode {
rpc GetMetrics(milvus.GetMetricsRequest) returns (milvus.GetMetricsResponse) {}
} |
How to use GetMetrics
interface?
The request
and response
are both of jsonic format string. Below are some examples, for some special response, I The request
and response
are both of jsonic format string. Below are some examples, for some special response, I will explain how they are organized.
System Info
request:
{
"metric_type": "system_info"
}
response:
": "system_info"
}
response:
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "nodes_info": [ { "identifier": 1, // unique in the list of nodes_info "name": "root coordinator", "hardware_info": { "ip": "192.168.1.1", "cpu_core_count": 2, "cpu_core_usage": "10%", "memory": "13124124", // in bytes "memory_usage": "234123", // in bytes "disk": "234123", // in bytes "disk_usage": "123123", // in bytes }, "system_info": { "system_version": "rc2 a3c662c7b", "deploy_mode": "cluster", }, "system_configurations": { "maxPartitionNum": 4096, "timeTickInterval": 200 }, "created_time": "2021-04-13 08:41:34.51+00", "updated_time": "2021-04-13 08:41:34.51+00", "type": "coordinator", "connected": [] }, { "identifier": 2, "name": "data coordinator", "hardware_info": { "ip": "192.168.1.1", "cpu_core_count": 2, "cpu_core_usage": "10%", "memory": "13124124", // in bytes "memory_usage": "234123", // in bytes "disk": "234123", // in bytes "disk_usage": "123123", // in bytes }, "system_info": { "system_version": "rc2 a3c662c7b", "deploy_mode": "cluster", }, "system_configurations": { "maxPartitionNum": 4096, "timeTickInterval": 200 }, "created_time": "2021-04-13 08:41:34.51+00", "updated_time": "2021-04-13 08:41:34.51+00", "type": "coordinator", "connected": [ { "parent": 1, "method": "manage" } ] }, { "identifier": 3, "name": "proxy", "hardware_info": { "ip": "192.168.1.1", "cpu_core_count": 2, "cpu_core_usage": "10%", "memory": "13124124", // in bytes "memory_usage": "234123", // in bytes "disk": "234123", // in bytes "disk_usage": "123123", // in bytes }, "system_info": { "system_version": "rc2 a3c662c7b", "deploy_mode": "cluster", }, "system_configurations": { "maxPartitionNum": 4096, "timeTickInterval": 200 }, "created_time": "2021-04-13 08:41:34.51+00", "updated_time": "2021-04-13 08:41:34.51+00", "type": "proxy", "connected": [ { "parent": 1, "method": "notification" }, { "parent": 2, "method": "notification" } ] }, { "identifier": 4, "name": "data node 1", "hardware_info": { "ip": "192.168.1.1", "cpu_core_count": 2, "cpu_core_usage": "10%", "memory": "13124124", // in bytes "memory_usage": "234123", // in bytes "disk": "234123", // in bytes "disk_usage": "123123", // in bytes }, "system_info": { "system_version": "rc2 a3c662c7b", "deploy_mode": "cluster", }, "system_configurations": { "maxPartitionNum": 4096, "timeTickInterval": 200 }, "created_time": "2021-04-13 08:41:34.51+00", "updated_time": "2021-04-13 08:41:34.51+00", "type": "data node", "connected": [ { "parent": 2, "method": "manage" } ] }, { "identifier": 5, "name": "data node 2", "hardware_info": { "ip": "192.168.1.1", "cpu_core_count": 2, "cpu_core_usage": "10%", "memory": "13124124", // in bytes "memory_usage": "234123", // in bytes "disk": "234123", // in bytes "disk_usage": "123123", // in bytes }, "system_info": { "system_version": "rc2 a3c662c7b", "deploy_mode": "cluster", }, "system_configurations": { "maxPartitionNum": 4096, "timeTickInterval": 200 }, "created_time": "2021-04-13 08:41:34.51+00", "updated_time": "2021-04-13 08:41:34.51+00", "type": "data node", "connected": [ { "parent": 2, "method": "manage" } ] } ] } |
In order to show the connection topology of Milvus, we have the nodes_info
in response. nodes_info
is a list and every item in list indicates a node in Milvus cluster. Every item has a identifier which is unique in nodes_info
. The identifier can be used in connected
content, for example, proxy has connected to root coordinator and data coordinator, so the connected
content is [1, 2]
, 1 is the identifier of root coordinator, 2 is the identifier of data coordinator.
...