kristy

README

kristy

Kristy is a baby-sitter for your processes. It reports errors to HealthChecks.io and Slack as needed to ensure no cron job falls through the cracks.

Installation

First install Go.

If you just want to install the binary to your current directory and don't care about the source code, run

GOBIN=$(pwd) go install github.com/spotlightpa/kristy@latest

Screenshots

$ kristy -h
kristy v0.21.6 - a baby-sitter for your cron jobs

Kristy tells HealthChecks.io how your cronjobs are doing. If it can't reach
HealthChecks.io, it falls back to warning Slack that something went wrong.

Usage:

        kristy [options] <command to babysit>

Options may be also passed as environmental variables prefixed with KRISTY_.

Options:
  -healthcheck UUID
        UUID for HealthChecks.io job
  -retries int
        how many times to retry failed commands
  -silent
        don't log debug output
  -slack URL
        Slack hook URL
  -timeout duration
        timeout for HTTP requests (default 10s)

$ KRISTY_HEALTHCHECK='x' KRISTY_SLACK='https://none.example/' kristy gronk
kristy 2021/03/03 19:57:22 starting
kristy 2021/03/03 19:57:23 done
Error: 4 errors:
      error 1: could not start process: exec: "gronk": executable file not found in $PATH
        error 2: problem sending start signal to Healthchecks.io: unexpected status: 404 Not Found
        error 3: problem sending status to Healthchecks.io: unexpected status: 404 Not Found
        error 4: problem sending message to Slack: Post "https://none.example/": dial tcp: lookup none.example: no such host

$ KRISTY_HEALTHCHECK='x' KRISTY_SLACK='https://none.example/' kristy ls
kristy 2021/03/03 12:34:03 starting
LICENSE
README.md
go.mod
go.sum
healthchecksio
main.go
sitter
kristy 2021/03/03 12:34:04 done
Error: 2 errors:
        error 1: problem sending start signal to Healthchecks.io: unexpected status: 404 Not Found
        error 2: problem sending status to Healthchecks.io: unexpected status: 404 Not Found

$ KRISTY_HEALTHCHECK='x' KRISTY_SLACK='https://none.example/' kristy -retries 3 gronk
kristy 2021/03/16 15:26:03 starting
kristy 2021/03/16 15:26:03 command returned 1; waiting 1s for retry
kristy 2021/03/16 15:26:04 retrying command; 3 retries remaining
kristy 2021/03/16 15:26:04 command returned 1; waiting 3s for retry
kristy 2021/03/16 15:26:07 retrying command; 2 retries remaining
kristy 2021/03/16 15:26:07 command returned 1; waiting 9s for retry
kristy 2021/03/16 15:26:16 retrying command; 1 retries remaining
kristy 2021/03/16 15:26:16 done
Error: 4 errors:
        error 1: could not start process: exec: "gronk": executable file not found in $PATH
        error 2: problem sending start signal to Healthchecks.io: unexpected status: 404 Not Found
        error 3: problem sending status to Healthchecks.io: unexpected status: 404 Not Found
        error 4: problem sending message to Slack: Post "https://none.example/": dial tcp: lookup none.example: no such host