A rust rewrite of biggraphte's bgutil.
Go to file
2021-02-24 23:57:41 +01:00
src Set cassandra servers with args or env var. 2021-02-24 23:57:41 +01:00
.gitignore first commit 2021-02-20 17:25:07 +01:00
Cargo.lock Adding write & delete commands. 2021-02-21 22:04:23 +01:00
Cargo.toml Adding write & delete commands. 2021-02-21 22:04:23 +01:00
README.md Updating documentation. 2021-02-24 21:43:31 +01:00

bgutil-rs

bgutil-rs is a rewrite of biggraphite's bgutil tool.

You might find more information on wiki.

Build

Don't forget to download & install cassandra-cpp & libuv.

Run

$ cargo build
    Finished dev [unoptimized + debuginfo] target(s) in 0.04s

$ cargo run -- --help
bgutil-rs 

USAGE:
    bgutil-rs <SUBCOMMAND>

SUBCOMMANDS:
    clean     Stats
    delete    Delete metric(s)
    help      Prints this message or the help of the given subcommand(s)
    info      Information about a metric
    list      List metrics with given pattern
    read      Read a metric contents
    stats     Stats
    write     Write a metric and its value

Info

$ cargo run -- info --help
bgutil-rs-info 
Information about a metric

USAGE:
    bgutil-rs info <metric>

ARGS:
    <metric>    the metric

Example:

$ cargo run -- info observability.testaroo.up
observability.testaroo.up {"aggregator": "average", "retention": "11520*60s:720*3600s:730*86400s", "carbon_xfilesfactor": "0.500000"}

Read

bgutil-rs-read
Read a metric contents

USAGE:
    bgutil-rs read [OPTIONS] <metric>

OPTIONS:
        --stage <stage>
        --time-end <time-end>
        --time-start <time-start>

ARGS:
    <metric>    metric to get values

Example:

$ cargo run -- read observability.testaroo.up --stage "11520*60s" --time-start 1613257200 --time-end 1613343600
1613319120;0.0
1613319180;0.0
1613319240;1.0
1613319300;1.0
1613319360;1.0
1613319420;1.0
1613319480;1.0
1613319540;1.0
...

List

$ cargo run -- list --help
bgutil-rs-list
List metrics with given pattern

USAGE:
    bgutil-rs list <glob>

ARGS:
    <glob>

Example:

$ cargo run -- list observability.*.up
d observability.testaroo.up
m observability.testaroo.up {"retention": "11520*60s:720*3600s:730*86400s", "aggregator": "average", "carbon_xfilesfactor": "0.500000"}

$ time cargo run -- list observability.test*.go*
d observability.testaroo.go_memstats_next_gc_bytes
d observability.testaroo.go_memstats_mallocs_total
...
m observability.testaroo.go_memstats_next_gc_bytes {"aggregator": "average", "carbon_xfilesfactor": "0.500000", "retention": "11520*60s:720*3600s:730*86400s"}
m observability.testaroo.go_memstats_mallocs_total {"aggregator": "average", "retention": "11520*60s:720*3600s:730*86400s", "carbon_xfilesfactor": "0.500000"}
...

Write

$ 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

$ cargo run -- delete --help
bgutil-rs-delete
Delete metric(s)

USAGE:
    bgutil-rs delete [FLAGS] <metric>

FLAGS:
        --recursive

ARGS:
    <metric>

Clean

$ cargo run -- clean --help
bgutil-rs-clean 
Stats

USAGE:
    bgutil-rs clean [FLAGS] [OPTIONS]

FLAGS:
        --clean-directories
        --clean-metrics

OPTIONS:
        --end-key <end-key>
        --start-key <start-key>

Todo

  • command: read
    • human timestamps (but unix timestamps are ok)
  • command: list
    • Missing pattern matching like {abc,def}, **, [0-99]
  • command: write
    • Arguments handling
  • command: delete
    • with recursive
  • command: clean
    • progress bar
  • ...