Skip to main content
PyPI version Build status

django-alive-checks is a Django application that provides additional health checks for your Django projects. These checks are designed to work with the django-alive package but include dependencies that cannot be part of django-alive itself.

Installation

You can install the base package with:

pip install django-alive-checks

If you want to include support for Elasticsearch, install with:

pip install django-alive-checks[elasticsearch]

Integration with django-alive

To integrate the check_elasticsearch function with your django-alive checks, you can add it to your health checks configuration:

# settings.py

ALIVE_CHECKS = [
    ...
    ("alive_checks.checks.check_elasticsearch", {"settings": ES_SETTINGS}),
]

Where the ES_SETTINGS contains settings that you pass to elsaticsearch.Elasticsearch.

Testing

To run the tests for this project:

python -m unittest discover

The tests cover the following scenarios:

  • Successful connection to Elasticsearch.

  • Failed connection to Elasticsearch.

  • Exceptions during connection attempts.

  • Handling the absence of the elasticsearch package.

Contributing

Contributions are welcome! If you encounter any issues, have ideas for improvements, or want to add more checks, feel free to open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Acknowledgments

Thanks to the Django and Elasticsearch communities for their continued support and development of the libraries that make this project possible.

Release files for django-alive-checks 0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-alive-checks 0.2
File Size Uploaded
django_alive_checks-0.2.tar.gz 4.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for django-alive-checks 0.2
File Interpreter ABI Platform
django_alive_checks-0.2-py3-none-any.whl Python 3 none any Details

Total release size: 9.8 kB

Release files / django_alive_checks-0.2.tar.gz

Download URL django_alive_checks-0.2.tar.gz
Size 4.8 kB
Tags Source
SHA-256 checksum
How to use checksums
d887429312f4c68f34435bd67cfa6daf3fa259f41acc149dbd21c7f4594ef50d
BLAKE2b-256 checksum
How to use checksums
1d56fdb82664b2284a8d326635f07d7b280a734230483ce36a3fa597410cc88c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.9

Release files / django_alive_checks-0.2-py3-none-any.whl

Download URL django_alive_checks-0.2-py3-none-any.whl
Size 5.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
aa7787011e8aa0576319a41ce7dcb9e5ae8b4c81db507183f76126ea9b7c1a1d
BLAKE2b-256 checksum
How to use checksums
38b694874699aae217dbac85c8ee133eaae031343131d7cb74cfdcfd83d6e1a6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.9

Release history Release notifications | RSS feed

This release

0.2 This release

2 release files

0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page