heartbeet/README.md

20 lines
584 B
Markdown
Raw Permalink Normal View History

2019-08-31 12:23:02 -04:00
# heartbeet - Health Check utility for hosts
This utility is mainly for sending "is up" notification to Graphite server.
## Environment Variables
* PROJECT_NAME: Name of project which is included in metric name
* RUN_MODE: This is usually the environment which it ran in, usually prod/stage/test/dev
* GRAPHITE_KEY: This key is used as prefix if needed.
* GRAPHITE_ADDRESS: Address of graphite carbon, e.g. `127.0.0.1:2003`
## Run
Just run with required environment variables
```bash
$ GRAPHITE_ADDRESS=graphitehost.local:2003 RUN_MODE=stage PROJECT_NAME=nginx ./heartbeet
```