Skip to content

Commit 8965435

Browse files
authored
doc: add new flags to README (#15)
Add --worker count and --workload-duration as CLI parameters Add --guess flag for abbreviated test runs
1 parent 9edaf27 commit 8965435

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

README.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,21 @@
1010
blobcheck s3 [flags]
1111
```
1212

13-
### Flags
14-
15-
```
16-
-h, --help help for s3
17-
```
18-
1913
### Global Flags
2014

21-
```
22-
--db string PostgreSQL connection URL
23-
(default "postgresql://root@localhost:26257?sslmode=disable")
24-
--endpoint string http endpoint, if uri is not specified
25-
--path string destination path (e.g. bucket/folder), if uri is not specified
26-
--uri string in the [scheme]://[host]/[path]?[parameters] format
27-
--verbose increase logging verbosity to debug
15+
```text
16+
--db string PostgreSQL connection URL (default "postgresql://root@localhost:26257?sslmode=disable")
17+
--endpoint string http endpoint
18+
--guess perform a short test to guess suggested parameters:
19+
it only require access to the bucket;
20+
it does not try to run a full backup/restore cycle
21+
in the CockroachDB cluster.
22+
-h, --help help for blobcheck
23+
--path string destination path (e.g. bucket/folder)
24+
--uri string S3 URI
25+
-v, --verbosity count increase logging verbosity to debug
26+
--workers int number of concurrent workers (default 5)
27+
--workload-duration duration duration of the workload (default 5s)
2828
```
2929

3030
### Credentials
@@ -72,8 +72,9 @@ blobcheck s3 --uri 's3://mybucket/cluster1_backup?AWS_ACCESS_KEY_ID=..&AWS_SECRE
7272
├──────┬────────────┬─────────────┬────────┤
7373
│ node │ read speed │ write speed │ status │
7474
├──────┼────────────┼─────────────┼────────┤
75-
│ 1 │ 100MB/s │ 50MB/s │ OK │
76-
│ 2 │ 200MB/s │ 100MB/s │ OK │
75+
│ 1 │ 103MB/s │ 51MB/s │ OK │
76+
│ 2 │ 101MB/s │ 50MB/s │ OK │
77+
| 3 │ 100MB/s │ 49MB/s │ OK │
7778
└──────┴────────────┴─────────────┴────────┘
7879
```
7980

0 commit comments

Comments
 (0)