Go to file
Jan Christian Grünhage 3079c0095b
chore: update copyright headers
2022-07-25 09:33:06 +02:00
src chore: update copyright headers 2022-07-25 09:33:06 +02:00
.gitignore feat: add shell completions and man page generation 2022-04-02 21:43:21 +02:00
.gitlab-ci.yml Add .gitlab-ci.yml 2019-02-06 18:38:09 +00:00
CHANGELOG.md chore: bump version to 0.5.1 2022-04-03 01:53:03 +02:00
Cargo.lock chore: bump version to 0.5.1 2022-04-03 01:53:03 +02:00
Cargo.toml chore: bump version to 0.5.1 2022-04-03 01:53:03 +02:00
LICENSE Add LICENSE 2019-02-05 10:33:05 +00:00
README.md feat: add shell completions and man page generation 2022-04-02 21:43:21 +02:00
build.rs chore: update copyright headers 2022-07-25 09:33:06 +02:00
config.toml.sample feat: allow configuring timeout 2022-03-17 11:13:32 +01:00

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.