django_celery_monitor 1.1.2

关于

此扩展使您能够监控Celery任务和工作进程。

它定义了两个模型（django_celery_monitor.models.WorkerState 和 django_celery_monitor.models.TaskState），用于存储工作状态和任务状态，您可以使用与任何其他 Django 模型相同的方式查询这个数据库表。它提供了一个 Camera 类（django_celery_monitor.camera.Camera），可用于与 Celery 命令行工具配合使用，以自动填充 Celery 工作和任务的当前状态。

历史

该包是 Celery 4 兼容的 Django 管理监控功能的移植版本，该功能曾包含在旧的 django-celery 包中，该包仅与 Celery < 4.0 兼容。django-celery 的其他部分作为 django-celery-beat（数据库支持的周期性任务）和 django-celery-results（Django 的 Celery 结果后端）发布。

安装

您可以通过 Python 包索引（PyPI）或从源代码安装 django_celery_monitor。

要使用 pip 安装：

$ pip install -U django_celery_monitor

使用

要在此项目中使用此功能，您需要遵循以下步骤

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 django_celery_monitor

4. 转到您的网站的 Django 管理界面，查找“Celery 监控”部分。

开始监控过程

要启用对任务和工作状态的当前状态的快照，您需要运行带有适当的 camera 类 django_celery_monitor.camera.Camera 的 Celery 事件命令

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

有关可用的完整命令行选项列表，请参阅

$ celery events --help

配置

有一些设置可以调节任务监控在数据库中保持状态条目的时间长度。其中任何一个都应该是 datetime.timedelta 值或 None。

• monitor_task_success_expires – 默认为 timedelta(days=1)（1 天）

  保留关于成功结果的监控信息的时间长度。

• monitor_task_error_expires – 默认为 timedelta(days=3)（3 天）

  保留有关错误结果的监控信息的时间长度（以下事件状态之一：RETRY、FAILURE、REVOKED）。

• monitor_task_pending_expires – 默认为 timedelta(days=5)（5 天）

  保留有关挂起结果的监控信息的时间长度（以下事件状态之一：PENDING、RECEIVED、STARTED、REJECTED、RETRY）。

在您的 Celery 配置中，只需将它们设置为覆盖默认值即可，例如。

from datetime import timedelta

monitor_task_success_expires = timedelta(days=7)