跳转到主要内容

为django-alive提供额外的健康检查

项目描述

PyPI version Build status

django-alive-checks是一个Django应用程序,为您的Django项目提供额外的健康检查。这些检查旨在与django-alive包一起工作,但包括不能作为django-alive本身一部分的依赖项。

安装

您可以使用以下命令安装基本包:

pip install django-alive-checks

如果您想包含对Elasticsearch的支持,可以使用以下命令安装:

pip install django-alive-checks[elasticsearch]

与django-alive的集成

要将check_elasticsearch函数与您的django-alive检查集成,您可以将它添加到健康检查配置中

# settings.py

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

其中ES_SETTINGS包含传递给elsaticsearch.Elasticsearch的设置。

测试

要为此项目运行测试

python -m unittest discover

测试覆盖以下场景

  • 成功连接到Elasticsearch。

  • 连接到Elasticsearch失败。

  • 连接尝试期间的异常。

  • 处理elasticsearch包不存在的情况。

贡献

欢迎贡献!如果您遇到任何问题,有改进的想法或想添加更多检查,请随意打开一个问题或提交一个拉取请求。

许可证

此项目受MIT许可证许可。有关更多详细信息,请参阅LICENSE文件。

致谢

感谢Django和Elasticsearch社区对其持续支持和开发使此项目成为可能的相关库。

项目详情


下载文件

下载适用于您平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源代码分布

django_alive_checks-0.2.tar.gz (4.8 kB 查看哈希值)

上传时间 源代码

构建分布

django_alive_checks-0.2-py3-none-any.whl (5.0 kB 查看哈希值)

上传时间 Python 3

支持者