Skip to content

Latest commit

 

History

History
40 lines (25 loc) · 1.49 KB

README.md

File metadata and controls

40 lines (25 loc) · 1.49 KB

Healthchecker

GitHub go.mod Go version Go Report Card Liberapay patrons ko-fi

Simplistic Go utility that does a HTTP HEAD check to see if a server app is alive. Ideal for in distroless containers.

All it does (and likely will ever do) is:

  • Send HTTP HEAD request to a specified URL;
  • On return of HTTP status code 200, exit with value 0;
  • Else exit with value 1;

Usage

  • Build it yourself or download a pre-built release.
  • Point it to your server's URL.

Examples

On the commandline:

./healthchecker http://127.0.0.1:8080/api/v1/status

or in a Dockerfile:

HEALTHCHECK --interval=5s --timeout=5s --retries=3 \
    CMD ["/healthchecker", "http://127.0.0.1:8080/api/v1/status"]

Support

Source code and issues: https://github.com/mvdkleijn/healthchecker

Licensing

Healthchecker is made available under the MPL-2.0 license. The full details are available from the LICENSE file.