Skip to content

Commit 8c1001a

Browse files
Copilotkillme2008
Copilot
and
killme2008
authored
docs: update cluster_info table schema with resource usage columns (#2191)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: killme2008 <14142+killme2008@users.noreply.github.com>
1 parent ff91e40 commit 8c1001a

File tree

2 files changed

+74
-62
lines changed

2 files changed

+74
-62
lines changed

‎docs/reference/sql/information-schema/cluster-info.md‎

Lines changed: 37 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,24 @@ DESC TABLE CLUSTER_INFO;
1717
The output is as follows:
1818

1919
```sql
20-
+--------------+----------------------+------+------+---------+---------------+
21-
| Column | Type | Key | Null | Default | Semantic Type |
22-
+--------------+----------------------+------+------+---------+---------------+
23-
| peer_id | Int64 | | NO | | FIELD |
24-
| peer_type | String | | NO | | FIELD |
25-
| peer_addr | String | | YES | | FIELD |
26-
| cpus | UInt32 | | NO | | FIELD |
27-
| memory_bytes | UInt64 | | NO | | FIELD |
28-
| version | String | | NO | | FIELD |
29-
| git_commit | String | | NO | | FIELD |
30-
| start_time | TimestampMillisecond | | YES | | FIELD |
31-
| uptime | String | | YES | | FIELD |
32-
| active_time | String | | YES | | FIELD |
33-
| node_status | String | | YES | | FIELD |
34-
+--------------+----------------------+------+------+---------+---------------+
20+
+-----------------------+----------------------+------+------+---------+---------------+
21+
| Column | Type | Key | Null | Default | Semantic Type |
22+
+-----------------------+----------------------+------+------+---------+---------------+
23+
| peer_id | Int64 | | NO | | FIELD |
24+
| peer_type | String | | NO | | FIELD |
25+
| peer_addr | String | | YES | | FIELD |
26+
| peer_hostname | String | | YES | | FIELD |
27+
| total_cpu_millicores | Int64 | | NO | | FIELD |
28+
| total_memory_bytes | Int64 | | NO | | FIELD |
29+
| cpu_usage_millicores | Int64 | | NO | | FIELD |
30+
| memory_usage_bytes | Int64 | | NO | | FIELD |
31+
| version | String | | NO | | FIELD |
32+
| git_commit | String | | NO | | FIELD |
33+
| start_time | TimestampMillisecond | | YES | | FIELD |
34+
| uptime | String | | YES | | FIELD |
35+
| active_time | String | | YES | | FIELD |
36+
| node_status | String | | YES | | FIELD |
37+
+-----------------------+----------------------+------+------+---------+---------------+
3538
```
3639

3740

@@ -40,8 +43,11 @@ The columns in table:
4043
* `peer_id`: the server id of the node. It's always `0` for standalone mode and `-1` for frontends because it doesn't make sense in such cases.
4144
* `peer_type`: the node type, `METASRV`,`FRONTEND`, or `DATANODE` for distributed clusters and `STANDALONE` for standalone deployments.
4245
* `peer_addr`: the GRPC server address of the node. It's always empty for standalone deployments.
43-
* `cpus`: the number of CPUs of the node.
44-
* `memory_bytes`: the memory size of the node.
46+
* `peer_hostname`: the hostname of the peer.
47+
* `total_cpu_millicores`: the total CPU millicores of the node.
48+
* `total_memory_bytes`: the total memory bytes of the node.
49+
* `cpu_usage_millicores`: the CPU usage millicores of the node. This only works in a containerized environment (cgroup v2).
50+
* `memory_usage_bytes`: the memory usage bytes of the node. This only works in a containerized environment (cgroup v2).
4551
* `version`: The build version of the node, such as `0.7.2` etc.
4652
* `git_commit`: The build git commit of the node.
4753
* `start_time`: The node start time.
@@ -58,25 +64,25 @@ SELECT * FROM CLUSTER_INFO;
5864
An example output in standalone deployments:
5965

6066
```sql
61-
+---------+------------+-----------+------+--------------+---------+-----------+----------------------------+--------+-------------+-------------+
62-
| peer_id | peer_type | peer_addr | cpus | memory_bytes | version | git_commit| start_time | uptime | active_time | node_status |
63-
+---------+------------+-----------+------+--------------+---------+-----------+----------------------------+--------+-------------+-------------+
64-
| 0 | STANDALONE | | 16 | 17179869184 | 0.7.2 | 86ab3d9 | 2024-04-30T06:40:02.074 | 18ms | | NULL |
65-
+---------+------------+-----------+------+--------------+---------+-----------+----------------------------+--------+-------------+-------------+
67+
+---------+------------+-----------+---------------+----------------------+--------------------+----------------------+--------------------+---------+-----------+----------------------------+--------+-------------+-------------+
68+
| peer_id | peer_type | peer_addr | peer_hostname | total_cpu_millicores | total_memory_bytes | cpu_usage_millicores | memory_usage_bytes | version | git_commit| start_time | uptime | active_time | node_status |
69+
+---------+------------+-----------+---------------+----------------------+--------------------+----------------------+--------------------+---------+-----------+----------------------------+--------+-------------+-------------+
70+
| 0 | STANDALONE | | | 16000 | 17179869184 | 0 | 0 | 0.7.2 | 86ab3d9 | 2024-04-30T06:40:02.074 | 18ms | | NULL |
71+
+---------+------------+-----------+---------------+----------------------+--------------------+----------------------+--------------------+---------+-----------+----------------------------+--------+-------------+-------------+
6672
```
6773

6874
Another example is from a distributed cluster that has three Datanodes, one Frontend, and one Metasrv.
6975

7076
```sql
71-
+---------+-----------+----------------+------+--------------+---------+-----------+----------------------------+----------+-------------+-------------------------------------------------------------------+
72-
| peer_id | peer_type | peer_addr | cpus | memory_bytes | version | git_commit| start_time | uptime | active_time | node_status |
73-
+---------+-----------+----------------+------+--------------+---------+-----------+----------------------------+----------+-------------+-------------------------------------------------------------------+
74-
| 1 | DATANODE | 127.0.0.1:4101 | 16 | 17179869184 | 0.7.2 | 86ab3d9 | 2024-04-30T06:40:04.791 | 4s 478ms | 1s 467ms | {"workloads":["hybrid"],"leader_regions":46,"follower_regions":0} |
75-
| 2 | DATANODE | 127.0.0.1:4102 | 16 | 17179869184 | 0.7.2 | 86ab3d9 | 2024-04-30T06:40:06.098 | 3s 171ms | 162ms | {"workloads":["hybrid"],"leader_regions":46,"follower_regions":0} |
76-
| 3 | DATANODE | 127.0.0.1:4103 | 16 | 17179869184 | 0.7.2 | 86ab3d9 | 2024-04-30T06:40:07.425 | 1s 844ms | 1s 839ms | {"workloads":["hybrid"],"leader_regions":46,"follower_regions":0} |
77-
| -1 | FRONTEND | 127.0.0.1:4001 | 16 | 17179869184 | 0.7.2 | 86ab3d9 | 2024-04-30T06:40:08.815 | 454ms | 47ms | NULL |
78-
| 0 | METASRV | 127.0.0.1:3002 | 16 | 17179869184 | unknown | unknown | | | | {"is_leader":true} |
79-
+---------+-----------+----------------+------+--------------+---------+-----------+----------------------------+----------+-------------+-------------------------------------------------------------------+
77+
+---------+-----------+----------------+-------------------------------------+----------------------+--------------------+----------------------+--------------------+---------+-----------+----------------------------+----------+-------------+-------------------------------------------------------------------+
78+
| peer_id | peer_type | peer_addr | peer_hostname | total_cpu_millicores | total_memory_bytes | cpu_usage_millicores | memory_usage_bytes | version | git_commit| start_time | uptime | active_time | node_status |
79+
+---------+-----------+----------------+-------------------------------------+----------------------+--------------------+----------------------+--------------------+---------+-----------+----------------------------+----------+-------------+-------------------------------------------------------------------+
80+
| 1 | DATANODE | 127.0.0.1:4101 | mycluster-datanode-0 | 1000 | 1073741824 | 1 | 34570240 | 0.7.2 | 86ab3d9 | 2024-04-30T06:40:04.791 | 4s 478ms | 1s 467ms | {"workloads":["hybrid"],"leader_regions":46,"follower_regions":0} |
81+
| 2 | DATANODE | 127.0.0.1:4102 | mycluster-datanode-1 | 1000 | 1073741824 | 1 | 38170624 | 0.7.2 | 86ab3d9 | 2024-04-30T06:40:06.098 | 3s 171ms | 162ms | {"workloads":["hybrid"],"leader_regions":46,"follower_regions":0} |
82+
| 3 | DATANODE | 127.0.0.1:4103 | mycluster-datanode-2 | 1000 | 1073741824 | 1 | 37085184 | 0.7.2 | 86ab3d9 | 2024-04-30T06:40:07.425 | 1s 844ms | 1s 839ms | {"workloads":["hybrid"],"leader_regions":46,"follower_regions":0} |
83+
| -1 | FRONTEND | 127.0.0.1:4001 | mycluster-frontend-6c5d4bcf78-m7jtx | 1000 | 1073741824 | 1 | 45465600 | 0.7.2 | 86ab3d9 | 2024-04-30T06:40:08.815 | 454ms | 47ms | NULL |
84+
| 0 | METASRV | 127.0.0.1:3002 | mycluster-meta-54bd44bd94-g8dzm | 1000 | 1073741824 | 0 | 28368896 | unknown | unknown | | | | {"is_leader":true} |
85+
+---------+-----------+----------------+-------------------------------------+----------------------+--------------------+----------------------+--------------------+---------+-----------+----------------------------+----------+-------------+-------------------------------------------------------------------+
8086
```
8187

8288

0 commit comments

Comments
 (0)