{"repo":"alexliesenfeld/health","free":true,"listed":false,"github":"https://github.com/alexliesenfeld/health","clone":"git clone https://github.com/alexliesenfeld/health.git","description":"A simple and flexible health check library for Go.","language":"Go","stars":836,"topics":["golang","health","microservice","kubernetes","docker","health-check","hacktoberfest"],"license":"MIT","category":"deployment-docker-iac","readme_excerpt":"Health A simple and flexible health check library for Go. Documentation · Report Bug · Request Feature Table of Contents 1. Getting started 1. Synchronous vs. Asynchronous Checks 1. Caching 1. Listening to Status Changes 1. Middleware and Interceptors 1. Compatibility With Other Libraries 1. License Getting Started This library provides a http.Handler that acts as a health endpoint. It can be used by cloud infrastructure or other services to determine the availability of an application. Rather than simply returning a response with HTTP status code 200, this library allows building health checks that test the availability of all required dependencies. The HTTP response contains the aggregated health result and details about the health status of each component. Install go get github.com/alexliesenfeld/health Example Because our search component is down, the request curl http://localhost:3000/health would yield a response with HTTP status code 503 (Service Unavailable) , and the following JSON response body: This example shows all features of this library. Synchronous vs. Asynchronous Checks With \"synchronous\" health checks we mean that every HTTP request initiates a health check and waits until all check functions complete before returning an aggregated health result. You can configure synchronous checks using the WithCheck configuration option (see example above). Synchronous checks can be sufficient for smaller applications but might not scale well for more involved applicati","default_branch":null,"files":null,"tree":[],"storefront":"/r/alexliesenfeld","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/alexliesenfeld/health/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}