How to check Cluster status

Guide to checking etcd cluster status

Prerequisites

Check Overall Status

endpoint status to check the overall status of each endpoint specified in --endpoints flag:

1. etcdctl endpoint status (--endpoints=$ENDPOINTS|--cluster)

Options

1. --cluster[=false]: use all endpoints from the cluster member list

Check Health

endpoint health to check the healthiness of each endpoint specified in --endpoints flag:

1. etcdctl endpoint health (--endpoints=$ENDPOINTS|--cluster)

Options

1. --cluster[=false]: use all endpoints from the cluster member list

Check KV Hash

endpoint hashkv to check the KV history hash of each endpoint specified in --endpoints flag:

1. etcdctl endpoint hashkv (--endpoints=$ENDPOINTS|--cluster) [rev=$REV]

Options

1. --cluster[=false]: use all endpoints from the cluster member list
2. --rev=0: maximum revision to hash (default: latest revision)

Options inherited from parent commands

1. --endpoints="127.0.0.1:2379": gRPC endpoints
2. -w, --write-out="simple": set the output format (fields, json, protobuf, simple, table)

Examples

1. etcdctl --write-out=table --endpoints=$ENDPOINTS endpoint status

3. +------------------+------------------+---------+---------+-----------+------------+-----------+------------+--------------------+--------+
4. |    ENDPOINT      |        ID        | VERSION | DB SIZE | IS LEADER | IS LEARNER | RAFT TERM | RAFT INDEX | RAFT APPLIED INDEX | ERRORS |
5. +------------------+------------------+---------+---------+-----------+------------+-----------+------------+--------------------+--------+
6. | 10.240.0.17:2379 | 4917a7ab173fabe7 |  3.5.0  |   45 kB |      true |      false |         4 |      16726 |              16726 |        |
7. | 10.240.0.18:2379 | 59796ba9cd1bcd72 |  3.5.0  |   45 kB |     false |      false |         4 |      16726 |              16726 |        |
8. | 10.240.0.19:2379 | 94df724b66343e6c |  3.5.0  |   45 kB |     false |      false |         4 |      16726 |              16726 |        |
9. +------------------+------------------+---------+---------+-----------+------------+-----------+------------+--------------------+--------|

1. etcdctl --endpoints=$ENDPOINTS endpoint health

3. 10.240.0.17:2379 is healthy: successfully committed proposal: took = 3.345431ms
4. 10.240.0.19:2379 is healthy: successfully committed proposal: took = 3.767967ms
5. 10.240.0.18:2379 is healthy: successfully committed proposal: took = 4.025451ms

1. etcdctl --cluster endpoint hashkv  --write-out=table

3. +------------------+------------+---------------+
4. |     ENDPOINT     |    HASH    | HASH REVISION |
5. +------------------+------------+---------------+
6. | 10.240.0.17:2379 | 3892279174 |             3 |
7. | 10.240.0.18:2379 | 3892279174 |             3 |
8. | 10.240.0.19:2379 | 3892279174 |             3 |
9. +------------------+------------+---------------+

Last modified June 24, 2025: etcd-website: reorganised tutorials to tasks (b5f1df7)