Skip to content

Commit

Permalink
Add 'Health endpoint' section to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Juanmcuello committed Apr 18, 2017
1 parent 75d47d3 commit 9375a90
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Expand Up @@ -22,15 +22,16 @@ Documentation
* [SSL Support](/doc/ssl.md)
* [Deploy to Heroku](/doc/heroku.md)
* [Using Nginx as reverse proxy](/doc/nginx.md)
* [Cheking number of current connections](/doc/connections.md)
* [Checking number of current connections](/doc/connections.md)
* [Testing and contributing](/doc/testing.md)
* [Health endpoint](/doc/health.md)

Pusher
------

[Pusher][pusher] is a great service, very well documented and with excellent
support. Consider using it on production.

[pusher]: http://pusher.com
[pusher]: https://pusher.com
[goliath]: https://github.com/postrank-labs/goliath/
[slanger]: https://github.com/stevegraham/slanger
18 changes: 18 additions & 0 deletions doc/health.md
@@ -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.

0 comments on commit 9375a90

Please sign in to comment.