开源项目 `health_check` 使用教程

开源项目 health_check 使用教程

health_checkSimple health check of Rails app for use with uptime checking sites like newrelic and pingdom项目地址:https://gitcode.com/gh_mirrors/he/health_check

1. 项目的目录结构及介绍

health_check/
├── README.md
├── setup.py
├── health_check/
│   ├── __init__.py
│   ├── apps.py
│   ├── checks/
│   │   ├── __init__.py
│   │   ├── cache.py
│   │   ├── db.py
│   │   ├── storage.py
│   │   ├── contrib/
│   │   │   ├── __init__.py
│   │   │   ├── celery.py
│   │   │   ├── migrations.py
│   │   │   ├── psutil.py
│   │   │   ├── rabbitmq.py
│   │   │   ├── redis.py
│   │   │   ├── s3boto3_storage.py
│   │   │   └── ...
│   ├── urls.py
│   └── views.py
└── tests/
    ├── __init__.py
    ├── test_cache.py
    ├── test_db.py
    ├── test_storage.py
    └── ...

目录结构介绍

• health_check/: 项目的主目录。
  • __init__.py: 初始化文件。
  • apps.py: 应用配置文件。
  • checks/: 包含各种健康检查的模块。
    • cache.py: 缓存健康检查。
    • db.py: 数据库健康检查。
    • storage.py: 存储健康检查。
    • contrib/: 包含额外的健康检查模块。
      • celery.py: Celery 健康检查。
      • migrations.py: 迁移健康检查。
      • psutil.py: 磁盘和内存利用率健康检查。
      • rabbitmq.py: RabbitMQ 健康检查。
      • redis.py: Redis 健康检查。
      • s3boto3_storage.py: AWS S3 存储健康检查。
  • urls.py: URL 配置文件。
  • views.py: 视图文件。
• tests/: 测试目录，包含各种测试文件。

2. 项目的启动文件介绍

项目的启动文件主要是 urls.py 和 views.py。

urls.py

from django.urls import path, include
from health_check import views

urlpatterns = [
    path('health/', include('health_check.urls')),
]

views.py

from django.http import JsonResponse
from health_check.backends import get_health_check_backends

def health_check(request):
    results = []
    for backend in get_health_check_backends():
        status, message = backend.check_status()
        results.append({
            'name': backend.identifier,
            'status': status,
            'message': message,
        })
    return JsonResponse({'results': results})

3. 项目的配置文件介绍

项目的配置文件主要是 settings.py 和 INSTALLED_APPS。

settings.py

INSTALLED_APPS = [
    ...
    'health_check',
    'health_check.db',
    'health_check.cache',
    'health_check.storage',
    'health_check.contrib.migrations',
    'health_check.contrib.celery',
    'health_check.contrib.psutil',
    'health_check.contrib.rabbitmq',
    'health_check.contrib.redis',
    'health_check.contrib.s3boto3_storage',
    ...
]

HEALTH_CHECK = {
    'DISK_USAGE_MAX': 90,  # percent
    'MEMORY_MIN': 100,     # in MB
}

INSTALLED_APPS

在 INSTALLED_APPS 中添加健康检查相关的应用：

INSTALLED_APPS = [
    ...
    'health_check',
    'health_check.db',
    'health_check.cache',
    'health_check.storage',
    'health_

health_checkSimple health check of Rails app for use with uptime checking sites like newrelic and pingdom项目地址:https://gitcode.com/gh_mirrors/he/health_check