https://github.com/mitodl/django-server-status

Monitor server status for health checks.
https://github.com/mitodl/django-server-status

django

Last synced: 6 days ago
JSON representation

Monitor server status for health checks.

• Host: GitHub
• URL: https://github.com/mitodl/django-server-status
• Owner: mitodl
• License: agpl-3.0
• Created: 2016-01-14T21:38:00.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-10-20T13:38:08.000Z (about 1 year ago)
• Last Synced: 2024-12-08T18:08:09.606Z (16 days ago)
• Topics: django
• Language: Python
• Size: 75.2 KB
• Stars: 8
• Watchers: 31
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
django-server-status

====================

Monitor server status with a healthcheck. Supports Django 1.10, 1.11 and 2.0.

Installation

------------

To get the latest stable release from PyPi

.. code-block:: bash

    pip install django-server-status

To get the latest commit from GitHub

.. code-block:: bash

    pip install -e git+git://github.com/mitodl/django-server-status.git#egg=django-server-status

Add a stanza like this to your settings. Current supported services are 'REDIS', 'ELASTIC_SEARCH', 'POSTGRES', 'CELERY'.

.. code-block:: python

    HEALTH_CHECK = ['REDIS', 'ELASTIC_SEARCH', 'POSTGRES']

Add ``server_status`` to your ``INSTALLED_APPS``

.. code-block:: python

    INSTALLED_APPS = (

        ...,

        'server_status',

    )

Add the ``server_status`` URLs to your ``urls.py``

.. code-block:: python

    urlpatterns = [

        ...

        url(r'^status/', include('server_status.urls')),

    ]

Release Notes

-------------

0.3: Added status_all property to the status results JSON.

0.2: Support for celery validation.

0.1.1: Included tests

0.1: Initial Release