health

Health

Health is a minimal package for implementing health checking for services built in Go.

Quick Start

package main

import (
  "net/http"

  "github.com/moorara/health"
)

func main() {
  logger := &Logger{}
  dbClient := NewClient("db-client")
  queueClient := NewClient("queue-client")

  health.SetLogger(logger)
  health.RegisterChecker(dbClient, queueClient)

  logger.Infof("Listening on port 8080 ...")
  http.Handle("/health", health.HandlerFunc())
  http.ListenAndServe(":8080", nil)
}

You can find the complete example here.

Behaviour

Here is how the handler returned from HandlerFunc() behaves:

1. A new context with a timeout will be derived from the request context.
2. The CheckHealth() method of all registered Checkers will be called each in a new goroutine.
   • If at least one of the check fails, the handler responds with 503 status code.
   • Only the failed checks will be logged (if logging enabled).