Skip to content

Commit

Permalink
Document WATCHMAN_ERROR_CODE in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mwarkentin committed Oct 3, 2015
1 parent deb13c0 commit 42b7d35
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Testimonials
------------

We're in love with django-watchman. External monitoring is a vital part of our service offering. Using django-watchman we can introspect the infrastructure of an application via a secure URL. It's very well written and easy to extend. We've recommended it to many of our clients already.

— Hany Fahim, CEO, `VM Farms <https://vmfarms.com/>`_.

Quickstart
Expand Down Expand Up @@ -136,8 +136,8 @@ querystring should be run, eg::

curl -XGET http://127.0.0.1:8080/watchman/?skip=watchman.checks.email

Django management command (new in ``django-watchman 0.5``)
**********************************************************
Django management command
*************************

You can also run your checks without starting the webserver and making requests.
This can be useful for testing your configuration before enabling a server,
Expand Down Expand Up @@ -174,6 +174,16 @@ Use ``-h`` to see a full list of options::

python manage.py watchman -h

Custom response code
********************

By default, watchman will return a ``200`` HTTP response code, even if there's a
failing check. You can specify a different response code for failing checks
using the ``WATCHMAN_ERROR_CODE`` setting::

WATCHMAN_ERROR_CODE = 500


Available checks
----------------

Expand Down

0 comments on commit 42b7d35

Please sign in to comment.