healthchecks-rs/monitor/README.md
Harsh Shandilya 6b6fbd55c9
all: update README
Signed-off-by: Harsh Shandilya <me@msfjarvis.dev>
2020-11-23 15:47:19 +05:30

24 lines
538 B
Markdown

# monitor
Simple binary that's designed to execute arbitrary tasks and notify a provided healthchecks.io check about their status.
## Usage
### Execute a shell command
```shell
HEALTHCHECKS_CHECK_ID=<check_id> healthchecks-monitor -X "sleep 10"
```
### Track execution time at healthchecks.io
```shell
HEALTHCHECKS_CHECK_ID=<check_id> healthchecks-monitor -tX "sleep 10"
```
### Use a custom user agent for reporting
```shell
HEALTHCHECKS_USERAGENT=crontab HEALTHCHECKS_CHECK_ID=<check_id> healthchecks-monitor -tX "sleep 10"
```