Updating documentation.
This commit is contained in:
parent
de38b241ca
commit
9199c05173
47
README.md
47
README.md
@ -17,10 +17,12 @@ USAGE:
|
|||||||
bgutil-rs <SUBCOMMAND>
|
bgutil-rs <SUBCOMMAND>
|
||||||
|
|
||||||
SUBCOMMANDS:
|
SUBCOMMANDS:
|
||||||
help Prints this message or the help of the given subcommand(s)
|
delete Delete metric(s)
|
||||||
info Information about a metric
|
help Prints this message or the help of the given subcommand(s)
|
||||||
list List metrics with given pattern
|
info Information about a metric
|
||||||
read Read a metric contents
|
list List metrics with given pattern
|
||||||
|
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
|
||||||
|
Loading…
Reference in New Issue
Block a user