This package provides an HTTP handler that returns information about the health status of the application. If the application is healthy and all the registered check pass, it returns a 200 OK HTTP status, otherwise, it fails with a 503 Service Unavailable. All responses contain a JSON encoded payload with information about the runtime system, current checks statuses and some configurable metadata.
package main
import (
"errors"
"net/http"
"time"
"github.com/MEDIGO/go-healthz"
)
const version = "1.0.0"
func main() {
healthz.Set("version", version)
healthz.Register("important_check", time.Second*5, func() error {
return errors.New("fail fail fail")
})
http.Handle("/healthz", healthz.Handler())
http.ListenAndServe(":8000", nil)
}$ http GET localhost:8000/healthz
HTTP/1.1 503 Service Unavailable
Content-Length: 317
Content-Type: application/json
Date: Fri, 23 Sep 2016 08:55:16 GMT
{
"status": "Unavailable",
"time": "2016-09-23T10:55:16.781538256 02:00",
"since": "2016-09-23T10:55:14.268149643 02:00",
"metadata": {
"version": "1.0.0"
},
"failures": {
"important_check": "fail fail fail"
},
"runtime": {
"alloc_bytes": 314048,
"arch": "amd64",
"goroutines_count": 4,
"heap_objects_count": 4575,
"os": "darwin",
"total_alloc_bytes": 314048,
"version": "go1.7"
}
}
Copyright © 2016 MEDIGO GmbH.
go-healthz is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.