Skip to content

Latest commit

 

History

History
31 lines (23 loc) · 1.25 KB

README.md

File metadata and controls

31 lines (23 loc) · 1.25 KB

Healthcheck

This is a really simple tool to perform a healthcheck. For now the only implemented protocol is http, but it's possible to extend to others protocols.

If you're asking yourself why do you need that? If you say yes for any of these question:

  • You have a really tiny docker image (from scratch or alpine) and you don't want to install curl for example.
  • You don't want to develop your own health command line.
  • You want a easy way to add healthcheck to your services.

To make your life easy we already have staticaly pre-compiled releases, to start to use add the following commands to your Dockerfile:

ENV HEALTHCHECK_VERSION 1.1.0
ENV HEALTHCHECK_URL https://github.com/gioxtech/healthcheck/releases/download/v${HEALTHCHECK_VERSION}/healthcheck-${HEALTHCHECK_VERSION}
RUN wget ${HEALTHCHECK_URL} -O /usr/bin/healthcheck && \
    chmod +x /usr/bin/healthcheck

HEALTHCHECK --start-period=15s --interval=15s --timeout=1s --retries=6 CMD healthcheck -http-addr http://localhost/health

Building

$ docker \
    run \
    --rm \
    -v `pwd`:/go/src/github.com/gioxtech/healthcheck golang:1.14-alpine \
    go build \
    -o /go/src/github.com/gioxtech/healthcheck/healthcheck-1.1.0 /go/src/github.com/gioxtech/healthcheck