django-watchman 1.5.0

django-watchman exposes a status endpoint for your backing services

django-watchman

django-watchman exposes a status endpoint for your backing services like databases, caches, etc.

Documentation

The full documentation is at django-watchman.readthedocs.io.

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.

Quickstart

1. Install django-watchman:

   pip install django-watchman
   

   Or with uv:

   uv add django-watchman
   

2. Add watchman to your INSTALLED_APPS setting:

   INSTALLED_APPS = (
       ...
       'watchman',
   )
   

3. Include the watchman URLconf in your project urls.py:

   re_path(r'^watchman/', include('watchman.urls')),
   

4. Start the development server and visit http://127.0.0.1:8000/watchman/ to get a JSON response of your backing service statuses:

   {
       "databases": [
           {
               "default": {
                   "ok": true
               }
           }
       ],
       "caches": [
           {
               "default": {
                   "ok": true
               }
           }
       ],
       "storage": {"ok": true}
   }
   

License

BSD-3-Clause