Updating documentation.

This commit is contained in:
Patrick MARIE 2021-02-21 22:08:45 +01:00
parent de38b241ca
commit 9199c05173

View File

@ -17,10 +17,12 @@ USAGE:
bgutil-rs <SUBCOMMAND> bgutil-rs <SUBCOMMAND>
SUBCOMMANDS: SUBCOMMANDS:
delete Delete metric(s)
help Prints this message or the help of the given subcommand(s) help Prints this message or the help of the given subcommand(s)
info Information about a metric info Information about a metric
list List metrics with given pattern list List metrics with given pattern
read Read a metric contents read Read a metric contents
write Write a metric and its value
``` ```
### Info ### Info
@ -107,6 +109,43 @@ m observability.testaroo.go_memstats_mallocs_total {"aggregator": "average", "re
... ...
``` ```
### Write
```sh
$ cargo run -- write --help
bgutil-rs-write
Write a metric and its value
USAGE:
bgutil-rs write [OPTIONS] <metric> <value>
OPTIONS:
--retention <retention>
-t, --timestamp <timestamp>
ARGS:
<metric>
<value>
```
### Delete
```sh
$ cargo run -- delete --help
bgutil-rs-delete
Delete metric(s)
USAGE:
bgutil-rs delete [FLAGS] <metric>
FLAGS:
--recursive
ARGS:
<metric>
```
## Todo ## Todo
* command: read * command: read