Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add 'Health endpoint' section to README.md
- Loading branch information
1 parent
75d47d3
commit 9375a90
Showing
2 changed files
with
21 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
Health endpoint | ||
--------------- | ||
|
||
Garufa provides an endpoint (/healthz) for checking the health of the server, | ||
which responses with a 204 status code to GET and HEAD requests: | ||
|
||
```console | ||
$ curl -i http://garufa.example.com:8000/healthz | ||
HTTP/1.1 204 No Content | ||
Content-Type: text/html | ||
Content-Length: 0 | ||
Server: Goliath | ||
Date: Tue, 18 Apr 2017 00:37:43 GMT | ||
|
||
``` | ||
This endpoint is particularly useful when sitting many Garufa servers behind a | ||
load balancer. The load balancer can use this endpoint for checking the health | ||
of each server and remove it from the cluster when is not available. |