mirror of
https://github.com/jazzband/django-celery-monitor.git
synced 2026-03-16 22:00:24 +00:00
47 lines
1.8 KiB
Text
47 lines
1.8 KiB
Text
:Version: 1.0.0
|
|
:Web: http://django-celery-monitor.readthedocs.io/
|
|
:Download: http://pypi.python.org/pypi/django-celery-monitor
|
|
:Source: http://github.com/jezdez/django-celery-monitor
|
|
:Keywords: django, celery, events, monitoring
|
|
|
|
About
|
|
=====
|
|
|
|
This extension enables you to monitor Celery tasks and workers.
|
|
|
|
It defines two models (``django_celery_monitor.models.WorkerState`` and
|
|
``django_celery_monitor.models.TaskState``) used to store worker and task states
|
|
and you can query this database table like any other Django model.
|
|
It provides a Camera class (``django_celery_monitor.camera.Camera``) to be
|
|
used with the Celery events command line tool to automatically populate the
|
|
two models with the current state of the Celery workers and tasks.
|
|
|
|
Configuration
|
|
=============
|
|
|
|
There are a few settings that regulate how long the task monitor should keep
|
|
state entries in the database. Either of the three should be a
|
|
``datetime.timedelta`` value or ``None``.
|
|
|
|
- ``monitor_task_success_expires`` -- Defaults to ``timedelta(days=1)`` (1 day)
|
|
|
|
The period of time to retain monitoring information about tasks with a
|
|
``SUCCESS`` result.
|
|
|
|
- ``monitor_task_error_expires`` -- Defaults to ``timedelta(days=3)`` (3 days)
|
|
|
|
The period of time to retain monitoring information about tasks with an
|
|
errornous result (one of the following event states: ``RETRY``, ``FAILURE``,
|
|
``REVOKED``.
|
|
|
|
- ``monitor_task_pending_expires`` -- Defaults to ``timedelta(days=5)`` (5 days)
|
|
|
|
The period of time to retain monitoring information about tasks with a
|
|
pending result (one of the following event states: ``PENDING``, ``RECEIVED``,
|
|
``STARTED``, ``REJECTED``, ``RETRY``.
|
|
|
|
In your Celery configuration simply set them to override the defaults, e.g.::
|
|
|
|
from datetime import timedelta
|
|
|
|
monitor_task_success_expires = timedelta(days=7)
|