On this page 
Warning:
As of October 4, 2019, CockroachDB v2.0 is no longer supported. For more details, refer to the Release Support Policy.
To view details for each node in the cluster, use the cockroach node command with the appropriate subcommands and flags.
New in v1.1: The cockroach node command is also used in the process of decommissioning nodes for permanent removal. See Remove Nodes for more details.
Subcommands
| Subcommand | Usage |
|---|---|
ls |
List the ID of each node in the cluster, excluding those that have been decommissioned and are offline. |
status |
View the status of one or all nodes, excluding nodes that have been decommissioned and taken offline. Depending on flags used, this can include details about range/replicas, disk usage, and decommissioning progress. |
decommission |
New in v1.1: Decommission nodes for permanent removal. See Remove Nodes for more details. |
recommission |
New in v1.1: Recommission nodes that were accidentally decommissioned. See Recommission Nodes for more details. |
Synopsis
# 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
Flags
All node subcommands support the following general-use and logging flags.
General
| Flag | Description |
|---|---|
--format |
How to display table rows printed to the standard output. Possible values: tsv, csv, pretty, records, sql, html.Default: tsv |
The node ls subcommand also supports the following general flags:
| Flag | Description |
|---|---|
--timeout |
New in v2.0: Set the duration of time that the subcommand is allowed to run before it returns an error and prints partial information. The timeout is specified with a suffix of s for seconds, m for minutes, and h for hours. If this flag is not set, the subcommand may hang. |
The node status subcommand also supports the following general flags:
| Flag | Description |
|---|---|
--all |
Show all node details. |
--decommission |
Show node decommissioning details. |
--ranges |
Show node details for ranges and replicas. |
--stats |
Show node disk usage details. |
--timeout |
New in v2.0: Set the duration of time that the subcommand is allowed to run before it returns an error and prints partial information. The timeout is specified with a suffix of s for seconds, m for minutes, and h for hours. If this flag is not set, the subcommand may hang. |
The node decommission subcommand also supports the following general flag:
| Flag | Description |
|---|---|
--wait |
When to return to the client. Possible values: all, none.If all, the command returns to the client only after all specified nodes are fully decommissioned. If any specified nodes are offline, the command will not return to the client until those nodes are back online.If none, the command does not wait for decommissioning to finish; it returns to the client after starting the decommissioning process on all specified nodes that are online. Any specified nodes that are offline will automatically be marked as decommissioned; if they come back online, the cluster will recognize this status and will not rebalance data to the nodes.Default: all |
Client Connection
| Flag | Description |
|---|---|
--host |
The server host to connect to. This can be the address of any node in the cluster. Env Variable: COCKROACH_HOSTDefault: localhost |
--port-p |
The server port to connect to. Env Variable: COCKROACH_PORTDefault: 26257 |
--user-u |
The SQL user that will own the client session. Env Variable: COCKROACH_USERDefault: root |
--insecure |
Use an insecure connection. Env Variable: COCKROACH_INSECUREDefault: false |
--certs-dir |
The path to the certificate directory containing the CA and client certificates and client key. Env Variable: COCKROACH_CERTS_DIRDefault: ${HOME}/.cockroach-certs/ |
--url |
A connection URL to use instead of the other arguments. Env Variable: COCKROACH_URLDefault: no URL |
See Client Connection Parameters for more details.
Logging
By default, the node command logs errors to stderr.
If you need to troubleshoot this command's behavior, you can change its logging behavior.
Response
The cockroach node subcommands return the following fields for each node.
node ls
| Field | Description |
|---|---|
id |
The ID of the node. |
node status
| Field | Description |
|---|---|
id |
The ID of the node. Required flag: None |
address |
The address of the node. Required flag: None |
build |
The version of CockroachDB running on the node. If the binary was built from source, this will be the SHA hash of the commit used. Required flag: None |
updated_at |
The date and time when the node last recorded the information displayed in this command's output. When healthy, a new status should be recorded every 10 seconds or so, but when unhealthy this command's stats may be much older. Required flag: None |
started_at |
The date and time when the node was started. Required flag: None |
replicas_leaders |
The number of range replicas on the node that are the Raft leader for their range. See replicas_leaseholders below for more details.Required flag: --ranges or --all |
replicas_leaseholders |
The number of range replicas on the node that are the leaseholder for their range. A "leaseholder" replica handles all read requests for a range and directs write requests to the range's Raft leader (usually the same replica as the leaseholder). Required flag: --ranges or --all |
ranges |
The number of ranges that have replicas on the node. Required flag: --ranges or --all |
ranges_unavailable |
The number of unavailable ranges that have replicas on the node. Required flag: --ranges or --all |
ranges_underreplicated |
The number of underreplicated ranges that have replicas on the node. Required flag: --ranges or --all |
live_bytes |
The amount of live data used by both applications and the CockroachDB system. This excludes historical and deleted data. Required flag: --stats or --all |
key_bytes |
The amount of live and non-live data from keys in the key-value storage layer. This does not include data used by the CockroachDB system. Required flag: --stats or --all |
value_bytes |
The amount of live and non-live data from values in the key-value storage layer. This does not include data used by the CockroachDB system. Required flag: --stats or --all |
intent_bytes |
The amount of non-live data associated with uncommitted (or recently-committed) transactions. Required flag: --stats or --all |
system_bytes |
The amount of data used just by the CockroachDB system. Required flag: --stats or --all |
is_live |
If true, the node is currently live.Required flag: None |
gossiped_replicas |
The number of replicas on the node that are active members of a range. After decommissioning, this should be 0. Required flag: --decommission or --all |
is_decommissioning |
If true, the node is marked for decommissioning. See Remove Nodes for more details.Required flag: --decommission or --all |
is_draining |
If true, the range replicas and range leases are being moved off the node. This happens when a live node is being decommissioned. See Remove Nodes for more details.Required flag: --decommission or --all |
node decommission
| Field | Description |
|---|---|
id |
The ID of the node. |
is_live |
If true, the node is live. |
gossiped_replicas |
The number of replicas on the node that are active members of a range. After decommissioning, this should be 0. |
is_decommissioning |
If true, the node is marked for decommissioning. See Remove Nodes for more details. |
is_draining |
If true, the range replicas and range leases are being moved off the node. This happens when a live node is being decommissioned. See Remove Nodes for more details. |
node recommission
| Field | Description |
|---|---|
id |
The ID of the node. |
is_live |
If true, the node is live. |
gossiped_replicas |
The number of replicas on the node that are active members of a range. After decommissioning, this should be 0. |
is_decommissioning |
If true, the node is marked for decommissioning. See Remove Nodes for more details. |
is_draining |
If true, the range replicas and range leases are being moved off the node. This happens when a live node is being decommissioned. See Remove Nodes for more details. |
Examples
List node IDs
$ cockroach node ls --insecure
+----+
| id |
+----+
| 1 |
| 2 |
| 3 |
| 4 |
| 5 |
+----+
Show the status of a single node
$ 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)
Show the status of all nodes
$ 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)
Decommission nodes
See Remove Nodes
Recommission nodes
See Also
Was this helpful?
