go-health

README

Health Monitoring Pattern

This repository solves the health monitoring pattern in go.

Background

To understand the background please have a read of Health Endpoint Monitoring pattern.

Rationale

You might be asking yourself why create another health solution as there seems to be a few. You are right these are the ones I could find.

• docker/go-healthcheck
• InVisionApp/go-health
• etherlabsio/healthcheck
• heptiolabs/healthcheck
• hellofresh/health-go

So you are free to use any of these awesome solutions, though I had some requirements that I wanted met. These are as follows:

• The solution has to be asynchronous so that we don't DOS our dependencies (some of these solutions have this)
• The solution is free from other dependencies.
• Flexible enough to be able to implement any transport that is needed.
• Not to provide an opinionated way to do heath monitoring across transports.

Types

The types of monitoring that we want others to build is as follows:

• White/Black box health
• Liveliness/Readiness
• Health Check API

Usage

To get going please add the dependency, as follows:

go get github.com/alexfalkowski/go-health

To uses it, please look at this example:

package main

import (
    "time"

    "github.com/alexfalkowski/go-health/checker"
    "github.com/alexfalkowski/go-health/server"
)

func main() {
    timeout := 5 * time.Second
    s := server.NewServer()

    cc := checker.NewHTTPChecker("https://httpstat.us/200", timeout)
    hr := server.NewRegistration("http", 0, cc)
    tc := checker.NewTCPChecker("httpstat.us:80", timeout)
    tr := server.NewRegistration("tcp", 0, tc)

    if err := s.Register(hr, tr); err != nil {
        panic(err)
    }

    ob, err := s.Observe("http", "tcp")
    if err != nil {
        panic(err)
    }

    if err := s.Start(); err != nil {
        panic(err)
    }

    defer s.Stop()

    ob.Error() // This will update with errors. If nil everything is OK.
}