https://github.com/mvdkleijn/healthchecker

Simplistic Go app that does a HTTP HEAD check to see if a server app is alive. Ideal for in distroless containers.
https://github.com/mvdkleijn/healthchecker

distroless distroless-docker go golang health-check healthcheck http server tool

Last synced: over 1 year ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/mvdkleijn/healthchecker
• Owner: mvdkleijn
• License: mpl-2.0
• Created: 2023-06-02T13:13:14.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-13T10:44:53.000Z (over 2 years ago)
• Last Synced: 2025-01-18T19:43:20.347Z (over 1 year ago)
• Topics: distroless, distroless-docker, go, golang, health-check, healthcheck, http, server, tool
• Language: Go
• Homepage: https://github.com/mvdkleijn/healthchecker
• Size: 34.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
# Healthchecker

![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/mvdkleijn/healthchecker?style=for-the-badge) [![Go Report Card](https://goreportcard.com/badge/github.com/mvdkleijn/healthchecker?style=for-the-badge)](https://goreportcard.com/report/github.com/mvdkleijn/healthchecker) [![Liberapay patrons](https://img.shields.io/liberapay/patrons/mvdkleijn?style=for-the-badge)](https://liberapay.com/mvdkleijn/) [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/O4O7H6C73)

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

- Go versions, see: https://endoflife.date/go

- Architectures: amd64, arm64 on Windows and Linux

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

## Licensing

Healthchecker is made available under the [MPL-2.0](https://choosealicense.com/licenses/mpl-2.0/)

license. The full details are available from the [LICENSE](/LICENSE) file.