peshming/README.md

peshming

It's a prometheus exporter pinging hosts in the background. It's been inspired by meshping, but instead of managing targets using a redis db this is using a simple config file. In addition, this tool allows to set a ping frequency per target.

The name peshming is intended as a placeholder until someone comes up with something better.

Usage:

$ peshming --help
peshming 0.2.3
Jan Christian Grünhage <jan.christian@gruenhage.xyz>
Pings configured hosts in a configurable intervals and exposes metrics for prometheus.

USAGE:
    peshming [FLAGS] <config>

FLAGS:
    -h, --help       Prints help information
    -v, --verbose    Be verbose (you can add this up to 4 times for more logs).
                     By default, only errors are logged, so no output is a good thing.
    -V, --version    Prints version information

ARGS:
    <config>    Set config file

For configuration options, see the included sample config file.

Endpoints:

There's two endpoints available:

• /metrics, which serves the metrics
• /health, which should always return a 200 status code

Packaging Notes

If you're packaging peshming, you might be interested in the env vars PESHMING_MAN_DIR and PESHMING_COMPLETIONS_DIR, which when set, will cause cargo to generate a man page and shell completions to the folder passed in those variables.