django-celery-monitor 的安装和配置教程

项目基础介绍

django-celery-monitor 是一个开源项目，它允许用户监控 Celery 任务和工作者（workers）。该项目定义了两个模型 WorkerState 和 TaskState 来存储工作者和任务的状态，用户可以像操作其他 Django 模型一样查询这些数据库表。此外，它还提供了一个 Camera 类，与 Celery 事件命令行工具配合使用，自动将当前 Celery 工作者和任务的状态填充到这两个模型中。

该项目主要使用 Python 编程语言。

项目使用的关键技术和框架

• Django: 一个高级的 Python Web 框架，它鼓励快速开发和干净、实用的设计。
• Celery: 一个异步任务队列/作业队列，基于分布式消息传递进行工作。

准备工作

在开始安装 django-celery-monitor 之前，请确保您的系统中已经安装了以下软件：

• Python (建议版本 3.6 或更高)
• Django (建议版本 2.2 或更高)
• Celery (建议版本 4.0 或更高)
• pip (Python 包管理器)

此外，您还需要一个 Django 项目，因为 django-celery-monitor 是作为 Django 项目的一部分进行安装和使用的。

安装步骤

1. 安装 django-celery-monitor 库：

   在您的终端或命令提示符中运行以下命令：

   pip install django_celery_monitor
   

2. 将 django_celery_monitor 添加到您的 Django 项目的 settings.py 文件中的 INSTALLED_APPS 列表中：

   INSTALLED_APPS = (
       # ...
       'django_celery_monitor',
       # ...
   )
   

   注意，模块名称中只有下划线，没有破折号。

3. 执行数据库迁移来创建 Celery 数据库表：

   在您的终端或命令提示符中运行以下命令：

   python manage.py migrate celery_monitor
   

4. 在 Django 管理界面中查找 "Celery Monitor" 部分，您应该能够看到监控的数据。

5. 启动监控过程：

   为了启用对当前任务和工作者状态的快照，您需要运行 Celery 事件命令，并使用 django_celery_monitor.camera.Camera 类：

   celery -A proj events -l info --camera django_celery_monitor.camera.Camera --frequency=2.0
   

   对于可用的命令行选项的完整列表，请运行：

   celery events --help
   

6. 配置监控数据保留期限（可选）：

   在您的 Celery 配置中，您可以设置以下三个配置项，以确定监控信息在数据库中保留的时间。每个配置项都可以是 datetime.timedelta 值或 None。

   • monitor_task_success_expires：默认为 timedelta(days=1)（1 天），用于设置保留成功任务信息的时间。
   • monitor_task_error_expires：默认为 timedelta(days=3)（3 天），用于设置保留错误任务信息的时间。
   • monitor_task_pending_expires：默认为 timedelta(days=5)（5 天），用于设置保留挂起任务信息的时间。

   例如，要修改成功任务的保留时间为 7 天，可以在 Celery 配置中添加以下代码：

   from datetime import timedelta
   monitor_task_success_expires = timedelta(days=7)
   

完成以上步骤后，您就成功安装并配置了 django-celery-monitor。现在您可以监控您的 Celery 任务和工作者了。