https://github.com/cafebazaar/healthz

A Status Reporter Golang Library
https://github.com/cafebazaar/healthz

golang health-check

Last synced: 2 months ago
JSON representation

A Status Reporter Golang Library

• Host: GitHub
• URL: https://github.com/cafebazaar/healthz
• Owner: cafebazaar
• License: mit
• Created: 2017-05-13T15:44:34.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2018-04-03T22:55:00.000Z (about 7 years ago)
• Last Synced: 2025-03-26T18:06:42.629Z (3 months ago)
• Topics: golang, health-check
• Language: Go
• Homepage:
• Size: 153 KB
• Stars: 5
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Healthz

[![Build Status](https://travis-ci.org/cafebazaar/healthz.svg)](https://travis-ci.org/cafebazaar/healthz) [![GoDoc](https://godoc.org/github.com/cafebazaar/healthz?status.svg)](https://godoc.org/github.com/cafebazaar/healthz)

![Screenshot of HTML Report - Healthz](https://github.com/cafebazaar/healthz/raw/master/demo/Healthz.png)

## Examples

  * [healthz.NewHandler()](https://godoc.org/github.com/cafebazaar/healthz#example-NewHandler)

## Features

* Overall Health Calculation using Subcomponents' Severity and Health Levels

* HTML Report

* JSON Report

* [Kubernetes Liveness and Readiness](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/)

  * Reports the service as *live* when the overall health is over `Error`

  * Reports the service as *ready* when the overall health is at least on `Normal`

## TODO

* gRPC Report