原始网页:https://www.cockroachlabs.com/docs/stable/view-node-details.html


用户可以执行cockroach node,指定相应的子命令和Flags,查看集群每个节点的统计信息。

(New in v1.1) 该命令也能够用于退役节点,详见退役节点

概要

# List the IDs of active and inactive nodes:
cockroach node ls <flags>

# Show status details for active and inactive nodes:
cockroach node status <flags>

# Show status and range/replica details for active and inactive nodes:
cockroach node status --ranges <flags>

# Show status and disk usage details for active and inactive nodes:
cockroach node status --stats <flags>

# Show status and decommissioning details for active and inactive nodes:
cockroach node status --decommission <flags>

# Show complete status details for active and inactive nodes:
cockroach node status --all <flags>

# Show status details for a specific node:
cockroach node status <node ID> <flags>

# Decommission nodes:
cockroach node decommission <node IDs> <flags>

# Recommission nodes:
cockroach node recommission <node IDs> <flags>

# View help:
cockroach node --help
cockroach node ls --help
cockroach node status --help
cockroach node decommission --help
cockroach node recommission --help

子命令

子命令 简介
ls 列出集群每个节点的ID,不包含退役节点和下线节点。
status 查看一个或所有节点的状况,不包含退役节点和下线节点。若指定相应的更加具体的Flag,则可以显示出Range副本、硬盘使用情况、退役进度等细节。
decommission (New in v1.1)
用于退役节点,不再使用该节点。详见退役节点
recommission (New in v1.1)
使退役的节点再度服役,详见服役节点

Flags

通用

Flag 简介
--format 将表数据输出到标准输出时的内容格式,可选:tsvcsvprettyrecordssqlhtml

默认:tsv

子命令node ls

Flag 简介
--timeout (New in v2.0)子命令允许执行的时间,缺少该Flag可能导致命令挂起。运行过程中若出现错误则提前结束。指定的字符串中s代表秒,m代表分,h代表小时。

子命令node status

Flag 简介
--all 显示所有节点信息
--decommission 显示退役节点信息
--ranges 显示Range副本信息
--stats 显示节点硬盘使用情况
--timeout (New in v2.0)子命令允许执行的时间,缺少该Flag可能导致命令挂起。运行过程中若出现错误则提前结束。Flag指定的字符串中s代表秒,m代表分,h代表小时。

子命令node decommission

Flag 简介
--wait 执行命令返回的时机

若指定为all,则该命令只有在所有指定的节点退役完成后返回。如果某个节点失联,则该命令会一直等待该节点重新加入集群。

若指定为none,则该命令在所有指定的线上节点退役完成后返回。如果某个节点失联,则集群自动标记该节点为退役节点,即使该节点后续重新加入集群,也不再将range副本分发到该节点上。

默认all

客户端连接

Flag 简介
--host 指定服务器ip地址,可以是集群的任意节点。

环境变量COCKROACH_HOST
默认localhost
--port
-p
指定服务器端口

环境变量COCKROACH_PORT
默认26257
--user
-u
指定SQL用户

环境变量COCKROACH_USER
默认root
--insecure 使用非安全模式的连接

环境变量COCKROACH_INSECURE
默认false
--certs-dir 指定存放着CA证书和客户端证书密钥的目录

环境变量COCKROACH_CERTS_DIR
默认${HOME}/.cockroach-certs/
--url CockroachDB的connection URL地址

环境变量COCKROACH_URL
默认:no URL

更多细节可以查看:客户端连接参数

NOTE: --user指定的用户需要具备备份数据相关的表的SELECT语句权限。

日志

cockroach node默认输出日志错误到stderr,更丰富的日志功能可查看:日志行为

响应内容

cockroach node返回以下内容:

子命令node ls

参数项 简介
id 节点ID

子命令node status

参数项 简介
id 节点ID

必要的Flag:
address 节点的地址

必要的Flag:
build 当前节点运行的CockroachDB版本。若该CockroachDB程序由源码编译生成,则显示对应版本的SHA哈希值。

必要的Flag:
updated_at 统计该命令输出内容对应的统计信息的时刻。正常情况下集群每10秒钟更新统计信息。

必要的Flag:
started_at 该节点启动的时间

必要的Flag:
replicas_leaders 该节点上作为Raft Leader的Range副本数量。

必要的Flag:--ranges--all
replicas_leaseholders 该节点上带有Range租约的Range副本数量,拥有Range租约的副本将处理所有读请求,同时将写请求路由到对应Range的Raft Leader所在的节点。通常同一个Range的租约和Raft Leader在同一个节点上。

必要的Flag:--ranges--all
ranges 节点上Range副本数量

必要的Flag:--ranges--all
ranges_unavailable 节点上不可用的Range副本数量。

必要的Flag:--ranges--all
ranges_underreplicated 节点上未完成复制的Rnage副本数量。

必要的Flag:--ranges--all
live_bytes 节点上应用数据和CockroachDB系统数据的实时数据量,不包括历史数据和已经删除的数据。

必要的Flag:--stats--all
key_bytes 节点上基于键值存储层所有KEYS值的数据量,包含实时或非实时数据,不包括CockroachDB系统数据。

必要的Flag:--stats--all
value_bytes 节点上基于键值存储层所有VALUES值的数据量,包含实时或非实时数据,不包括CockroachDB系统数据。

必要的Flag:--stats--all
intent_bytes 未提交(或是最近提交)事务涉及的非实时数据的数据量。

必要的Flag:--stats--all
system_bytes CockroachDB系统数据的数据量

必要的Flag:--stats--all
is_live 节点是否存活。

必要的Flag:
gossiped_replicas 节点上gossip副本数量。对于退役节点该值应为0

必要的Flag:--decommission--all
is_decommissioning 节点是否为退役节点,详见退役节点

必要的Flag:--decommission--all
is_draining 节点是否正在退役,该节点处于将Range副本和Range租约迁移到其他节点的过程当中,详见退役节点

必要的Flag:--decommission--all

子命令node decommission

参数项 简介
id 节点ID
is_live 节点是否存活。
gossiped_replicas 节点上gossip副本数量。对于退役节点该值应为0
is_decommissioning 节点是否为退役节点,详见退役节点
is_draining 节点是否正在退役,该节点处于将Range副本和Range租约迁移到其他节点的过程当中,详见退役节点

子命令node recommission

参数项 简介
id 节点ID
is_live 节点是否存活
gossiped_replicas 节点上gossip副本数量。对于退役节点该值应为0
is_decommissioning 节点是否为退役节点,详见退役节点
is_draining 节点是否正在退役,该节点处于将Range副本和Range租约迁移到其他节点的过程当中,详见退役节点

示例

列举所有节点

cockroach node ls --insecure

+----+
| id |
+----+
|  1 |
|  2 |
|  3 |
|  4 |
|  5 |
+----+

显示特定节点的状态

cockroach node status 1 --insecure

+----+-----------------------+---------+---------------------+---------------------+---------+
| id |        address        |  build  |     updated_at      |     started_at      | is_live |
+----+-----------------------+---------+---------------------+---------------------+---------+
|  1 | 165.227.60.76:26257   | 91a299d | 2017-09-07 18:16:03 | 2017-09-07 16:30:13 | true    |
+----+-----------------------+---------+---------------------+---------------------+---------+
(1 row)

显示所有节点状态

cockroach node status --insecure

+----+-----------------------+---------+---------------------+---------------------+---------+
| id |        address        |  build  |     updated_at      |     started_at      | is_live |
+----+-----------------------+---------+---------------------+---------------------+---------+
|  1 | 165.227.60.76:26257   | 91a299d | 2017-09-07 18:16:03 | 2017-09-07 16:30:13 | true    |
|  2 | 192.241.239.201:26257 | 91a299d | 2017-09-07 18:16:05 | 2017-09-07 16:30:45 | true    |
|  3 | 67.207.91.36:26257    | 91a299d | 2017-09-07 18:16:06 | 2017-09-07 16:31:06 | true    |
|  4 | 138.197.12.74:26257   | 91a299d | 2017-09-07 18:16:03 | 2017-09-07 16:44:23 | true    |
|  5 | 174.138.50.192:26257  | 91a299d | 2017-09-07 18:10:07 | 2017-09-07 17:12:57 | false   |
+----+-----------------------+---------+---------------------+---------------------+---------+
(5 rows)

退役节点

查看退役节点

服役节点

查看服役节点