Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update tutorial for endpoint status check. #846

Merged
merged 1 commit into from
May 14, 2024
Merged

update tutorial for endpoint status check. #846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 66 additions & 1 deletion content/en/docs/v3.5/tutorials/how-to-check-cluster-status.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,61 @@ description: Guide to checking etcd cluster status
weight: 1000
---

## Prerequisites

Specify the initial cluster configuration for each machine:
* Install [`etcd` and `etcdctl`](https://etcd.io/docs/v3.6/install/)

## Check Overall Status

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

```bash
etcdctl endpoint status (--endpoints=$ENDPOINTS|--cluster)
```

### Options

```bash
--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:

```bash
etcdctl endpoint health (--endpoints=$ENDPOINTS|--cluster)
```

### Options

```bash
--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:

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

### Options

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

## Options inherited from parent commands

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

### Examples

```shell
etcdctl --write-out=table --endpoints=$ENDPOINTS endpoint status
Expand All @@ -26,3 +79,15 @@ etcdctl --endpoints=$ENDPOINTS endpoint health
10.240.0.19:2379 is healthy: successfully committed proposal: took = 3.767967ms
10.240.0.18:2379 is healthy: successfully committed proposal: took = 4.025451ms
```

```shell
etcdctl --cluster endpoint hashkv --write-out=table

+------------------+------------+---------------+
| ENDPOINT | HASH | HASH REVISION |
+------------------+------------+---------------+
| 10.240.0.17:2379 | 3892279174 | 3 |
| 10.240.0.18:2379 | 3892279174 | 3 |
| 10.240.0.19:2379 | 3892279174 | 3 |
+------------------+------------+---------------+
```
67 changes: 66 additions & 1 deletion content/en/docs/v3.6/tutorials/how-to-check-cluster-status.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,61 @@ description: Guide to checking etcd cluster status
weight: 1000
---

## Prerequisites

Specify the initial cluster configuration for each machine:
* Install [`etcd` and `etcdctl`](https://etcd.io/docs/v3.6/install/)

## Check Overall Status

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

```bash
etcdctl endpoint status (--endpoints=$ENDPOINTS|--cluster)
```

### Options

```bash
--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:

```bash
etcdctl endpoint health (--endpoints=$ENDPOINTS|--cluster)
```

### Options

```bash
--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:

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

### Options

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

## Options inherited from parent commands

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

### Examples

```shell
etcdctl --write-out=table --endpoints=$ENDPOINTS endpoint status
Expand All @@ -26,3 +79,15 @@ etcdctl --endpoints=$ENDPOINTS endpoint health
10.240.0.19:2379 is healthy: successfully committed proposal: took = 3.767967ms
10.240.0.18:2379 is healthy: successfully committed proposal: took = 4.025451ms
```

```shell
etcdctl --cluster endpoint hashkv --write-out=table

+------------------+------------+---------------+
| ENDPOINT | HASH | HASH REVISION |
+------------------+------------+---------------+
| 10.240.0.17:2379 | 3892279174 | 3 |
| 10.240.0.18:2379 | 3892279174 | 3 |
| 10.240.0.19:2379 | 3892279174 | 3 |
+------------------+------------+---------------+
```