Skip to content

Commit 6e2bcd6

Browse files
committed
Update example output in readme
Signed-off-by: Benjamin Wang <benjamin.ahrtr@gmail.com>
1 parent 3ea05e1 commit 6e2bcd6

1 file changed

Lines changed: 56 additions & 44 deletions

File tree

README.md

Lines changed: 56 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -121,31 +121,38 @@ $ ./etcd-defrag --endpoints https://127.0.0.1:22379 --cluster --cacert ./ca.crt
121121
```
122122
Output:
123123
```
124-
Validating configuration.
125-
No defragmentation rule provided
126-
Performing health check.
127-
endpoint: https://127.0.0.1:2379, health: true, took: 4.702492ms, error:
128-
endpoint: https://127.0.0.1:22379, health: true, took: 5.017075ms, error:
129-
endpoint: https://127.0.0.1:32379, health: true, took: 4.747068ms, error:
130-
Getting members status
131-
endpoint: https://127.0.0.1:2379, dbSize: 172032, dbSizeInUse: 126976, memberId: 8211f1d0f64f3269, leader: 8211f1d0f64f3269, revision: 10365, term: 2, index: 10425
132-
endpoint: https://127.0.0.1:22379, dbSize: 122880, dbSizeInUse: 122880, memberId: 91bc3c398fb3c146, leader: 8211f1d0f64f3269, revision: 10365, term: 2, index: 10425
133-
endpoint: https://127.0.0.1:32379, dbSize: 122880, dbSizeInUse: 122880, memberId: fd422379fda50e48, leader: 8211f1d0f64f3269, revision: 10365, term: 2, index: 10425
134-
Running compaction until revision: 10365 ... successful
135-
3 endpoint(s) need to be defragmented: [https://127.0.0.1:22379 https://127.0.0.1:32379 https://127.0.0.1:2379]
136-
[Before defragmentation] endpoint: https://127.0.0.1:22379, dbSize: 126976, dbSizeInUse: 90112, memberId: 91bc3c398fb3c146, leader: 8211f1d0f64f3269, revision: 10365, term: 2, index: 10426
137-
Defragmenting endpoint "https://127.0.0.1:22379"
138-
Finished defragmenting etcd endpoint "https://127.0.0.1:22379". took 224.151378ms
139-
[Post defragmentation] endpoint: https://127.0.0.1:22379, dbSize: 90112, dbSizeInUse: 81920, memberId: 91bc3c398fb3c146, leader: 8211f1d0f64f3269, revision: 10365, term: 2, index: 10426
140-
[Before defragmentation] endpoint: https://127.0.0.1:32379, dbSize: 126976, dbSizeInUse: 90112, memberId: fd422379fda50e48, leader: 8211f1d0f64f3269, revision: 10365, term: 2, index: 10426
141-
Defragmenting endpoint "https://127.0.0.1:32379"
142-
Finished defragmenting etcd endpoint "https://127.0.0.1:32379". took 139.138035ms
143-
[Post defragmentation] endpoint: https://127.0.0.1:32379, dbSize: 90112, dbSizeInUse: 81920, memberId: fd422379fda50e48, leader: 8211f1d0f64f3269, revision: 10365, term: 2, index: 10426
144-
[Before defragmentation] endpoint: https://127.0.0.1:2379, dbSize: 172032, dbSizeInUse: 94208, memberId: 8211f1d0f64f3269, leader: 8211f1d0f64f3269, revision: 10365, term: 2, index: 10426
145-
Defragmenting endpoint "https://127.0.0.1:2379"
146-
Finished defragmenting etcd endpoint "https://127.0.0.1:2379". took 135.171807ms
147-
[Post defragmentation] endpoint: https://127.0.0.1:2379, dbSize: 90112, dbSizeInUse: 81920, memberId: 8211f1d0f64f3269, leader: 8211f1d0f64f3269, revision: 10365, term: 2, index: 10426
148-
The defragmentation is successful.
124+
2025/08/23 13:00:04 Validating configuration.
125+
2025/08/23 13:00:04 No defragmentation rule provided
126+
2025/08/23 13:00:04 Performing health check.
127+
2025/08/23 13:00:04 endpoint: https://127.0.0.1:22379, health: true, took: 1.902417ms, error:
128+
2025/08/23 13:00:04 endpoint: https://127.0.0.1:2379, health: true, took: 1.893833ms, error:
129+
2025/08/23 13:00:04 endpoint: https://127.0.0.1:32379, health: true, took: 2.167917ms, error:
130+
2025/08/23 13:00:04 Getting members status
131+
2025/08/23 13:00:04 endpoint: https://127.0.0.1:22379, dbSize: 98304, dbSizeInUse: 98304, memberId: 91bc3c398fb3c146, leader: 91bc3c398fb3c146, revision: 12, term: 2, index: 22
132+
2025/08/23 13:00:04 endpoint: https://127.0.0.1:2379, dbSize: 98304, dbSizeInUse: 98304, memberId: 8211f1d0f64f3269, leader: 91bc3c398fb3c146, revision: 12, term: 2, index: 22
133+
2025/08/23 13:00:04 endpoint: https://127.0.0.1:32379, dbSize: 98304, dbSizeInUse: 98304, memberId: fd422379fda50e48, leader: 91bc3c398fb3c146, revision: 12, term: 2, index: 22
134+
2025/08/23 13:00:04 Running compaction until revision: 12 ...
135+
2025/08/23 13:00:05 successful
136+
2025/08/23 13:00:05 3 endpoint(s) need to be defragmented: [https://127.0.0.1:2379 https://127.0.0.1:32379 https://127.0.0.1:22379]
137+
2025/08/23 13:00:05 [Before defragmentation]
138+
2025/08/23 13:00:05 endpoint: https://127.0.0.1:2379, dbSize: 98304, dbSizeInUse: 98304, memberId: 8211f1d0f64f3269, leader: 91bc3c398fb3c146, revision: 12, term: 2, index: 23
139+
2025/08/23 13:00:05 Defragmenting endpoint "https://127.0.0.1:2379"
140+
2025/08/23 13:00:05 Finished defragmenting etcd endpoint "https://127.0.0.1:2379". took 28.41525ms
141+
2025/08/23 13:00:05 [Post defragmentation]
142+
2025/08/23 13:00:05 endpoint: https://127.0.0.1:2379, dbSize: 98304, dbSizeInUse: 65536, memberId: 8211f1d0f64f3269, leader: 91bc3c398fb3c146, revision: 12, term: 2, index: 23
143+
2025/08/23 13:00:05 [Before defragmentation]
144+
2025/08/23 13:00:05 endpoint: https://127.0.0.1:32379, dbSize: 98304, dbSizeInUse: 98304, memberId: fd422379fda50e48, leader: 91bc3c398fb3c146, revision: 12, term: 2, index: 23
145+
2025/08/23 13:00:05 Defragmenting endpoint "https://127.0.0.1:32379"
146+
2025/08/23 13:00:05 Finished defragmenting etcd endpoint "https://127.0.0.1:32379". took 27.834208ms
147+
2025/08/23 13:00:05 [Post defragmentation]
148+
2025/08/23 13:00:05 endpoint: https://127.0.0.1:32379, dbSize: 98304, dbSizeInUse: 65536, memberId: fd422379fda50e48, leader: 91bc3c398fb3c146, revision: 12, term: 2, index: 23
149+
2025/08/23 13:00:05 [Before defragmentation]
150+
2025/08/23 13:00:05 endpoint: https://127.0.0.1:22379, dbSize: 98304, dbSizeInUse: 98304, memberId: 91bc3c398fb3c146, leader: 91bc3c398fb3c146, revision: 12, term: 2, index: 23
151+
2025/08/23 13:00:05 Defragmenting endpoint "https://127.0.0.1:22379"
152+
2025/08/23 13:00:05 Finished defragmenting etcd endpoint "https://127.0.0.1:22379". took 43.494ms
153+
2025/08/23 13:00:05 [Post defragmentation]
154+
2025/08/23 13:00:05 endpoint: https://127.0.0.1:22379, dbSize: 98304, dbSizeInUse: 65536, memberId: 91bc3c398fb3c146, leader: 91bc3c398fb3c146, revision: 12, term: 2, index: 23
155+
2025/08/23 13:00:05 The defragmentation is successful.
149156
```
150157

151158
Only one endpoint is provided, but it still runs defragmentation on all members in the cluster thanks to the flag `--cluster`.
@@ -195,25 +202,30 @@ $ ./etcd-defrag --endpoints http://127.0.0.1:22379 --cluster --defrag-rule="dbQu
195202

196203
Output:
197204
```
198-
Validating configuration.
199-
Validating the defragmentation rule: dbSize > dbQuota*80/100 || dbSize - dbSizeInUse > 200*1024*1024 ... valid
200-
Performing health check.
201-
endpoint: http://127.0.0.1:2379, health: true, took: 6.993264ms, error:
202-
endpoint: http://127.0.0.1:32379, health: true, took: 7.483368ms, error:
203-
endpoint: http://127.0.0.1:22379, health: true, took: 49.441931ms, error:
204-
Getting members status
205-
endpoint: http://127.0.0.1:2379, dbSize: 131072, dbSizeInUse: 131072, memberId: 8211f1d0f64f3269, leader: 8211f1d0f64f3269, revision: 10964, term: 2, index: 11028
206-
endpoint: http://127.0.0.1:22379, dbSize: 131072, dbSizeInUse: 131072, memberId: 91bc3c398fb3c146, leader: 8211f1d0f64f3269, revision: 10964, term: 2, index: 11028
207-
endpoint: http://127.0.0.1:32379, dbSize: 131072, dbSizeInUse: 131072, memberId: fd422379fda50e48, leader: 8211f1d0f64f3269, revision: 10964, term: 2, index: 11028
208-
Running compaction until revision: 10964 ... successful
209-
3 endpoint(s) need to be defragmented: [http://127.0.0.1:22379 http://127.0.0.1:32379 http://127.0.0.1:2379]
210-
[Before defragmentation] endpoint: http://127.0.0.1:22379, dbSize: 139264, dbSizeInUse: 90112, memberId: 91bc3c398fb3c146, leader: 8211f1d0f64f3269, revision: 10964, term: 2, index: 11029
211-
Evaluation result is false, so skipping endpoint: http://127.0.0.1:22379
212-
[Before defragmentation] endpoint: http://127.0.0.1:32379, dbSize: 139264, dbSizeInUse: 139264, memberId: fd422379fda50e48, leader: 8211f1d0f64f3269, revision: 10964, term: 2, index: 11029
213-
Evaluation result is false, so skipping endpoint: http://127.0.0.1:32379
214-
[Before defragmentation] endpoint: http://127.0.0.1:2379, dbSize: 139264, dbSizeInUse: 90112, memberId: 8211f1d0f64f3269, leader: 8211f1d0f64f3269, revision: 10964, term: 2, index: 11029
215-
Evaluation result is false, so skipping endpoint: http://127.0.0.1:2379
216-
The defragmentation is successful.
205+
2025/08/23 12:55:09 Validating configuration.
206+
2025/08/23 12:55:09 Validating the defragmentation rule: dbQuotaUsage > 0.8 || dbSizeFree > 200*1024*1024 ...
207+
2025/08/23 12:55:09 valid
208+
2025/08/23 12:55:09 Performing health check.
209+
2025/08/23 12:55:09 endpoint: http://127.0.0.1:2379, health: true, took: 2.73825ms, error:
210+
2025/08/23 12:55:09 endpoint: http://127.0.0.1:22379, health: true, took: 2.839ms, error:
211+
2025/08/23 12:55:09 endpoint: http://127.0.0.1:32379, health: true, took: 2.96325ms, error:
212+
2025/08/23 12:55:09 Getting members status
213+
2025/08/23 12:55:09 endpoint: http://127.0.0.1:22379, dbSize: 98304, dbSizeInUse: 98304, memberId: 91bc3c398fb3c146, leader: 8211f1d0f64f3269, revision: 9, term: 4, index: 44
214+
2025/08/23 12:55:09 endpoint: http://127.0.0.1:2379, dbSize: 98304, dbSizeInUse: 98304, memberId: 8211f1d0f64f3269, leader: 8211f1d0f64f3269, revision: 9, term: 4, index: 44
215+
2025/08/23 12:55:09 endpoint: http://127.0.0.1:32379, dbSize: 98304, dbSizeInUse: 98304, memberId: fd422379fda50e48, leader: 8211f1d0f64f3269, revision: 9, term: 4, index: 44
216+
2025/08/23 12:55:09 Running compaction until revision: 9 ...
217+
2025/08/23 12:55:09 successful
218+
2025/08/23 12:55:09 3 endpoint(s) need to be defragmented: [http://127.0.0.1:22379 http://127.0.0.1:32379 http://127.0.0.1:2379]
219+
2025/08/23 12:55:09 [Before defragmentation]
220+
2025/08/23 12:55:09 endpoint: http://127.0.0.1:22379, dbSize: 98304, dbSizeInUse: 98304, memberId: 91bc3c398fb3c146, leader: 8211f1d0f64f3269, revision: 9, term: 4, index: 45
221+
2025/08/23 12:55:09 Evaluation result is false, so skipping endpoint: http://127.0.0.1:22379
222+
2025/08/23 12:55:09 [Before defragmentation]
223+
2025/08/23 12:55:09 endpoint: http://127.0.0.1:32379, dbSize: 98304, dbSizeInUse: 98304, memberId: fd422379fda50e48, leader: 8211f1d0f64f3269, revision: 9, term: 4, index: 45
224+
2025/08/23 12:55:09 Evaluation result is false, so skipping endpoint: http://127.0.0.1:32379
225+
2025/08/23 12:55:09 [Before defragmentation]
226+
2025/08/23 12:55:09 endpoint: http://127.0.0.1:2379, dbSize: 98304, dbSizeInUse: 98304, memberId: 8211f1d0f64f3269, leader: 8211f1d0f64f3269, revision: 9, term: 4, index: 45
227+
2025/08/23 12:55:09 Evaluation result is false, so skipping endpoint: http://127.0.0.1:2379
228+
2025/08/23 12:55:09 The defragmentation is successful.
217229
```
218230

219231
If you want to run defragmentation when both conditions are true, namely the total db size is greater than 80%

0 commit comments

Comments
 (0)