1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
|
Getting started
===============
To use :pypi:`django-celery-results` with your project you need to follow these steps:
#. Install the :pypi:`django-celery-results` library:
.. code-block:: console
$ pip install django-celery-results
#. Add ``django_celery_results`` to ``INSTALLED_APPS`` in your
Django project's :file:`settings.py`::
INSTALLED_APPS = (
...,
'django_celery_results',
)
Note that there is no dash in the module name, only underscores.
#. Create the Celery database tables by performing a database migrations:
.. code-block:: console
$ python manage.py migrate django_celery_results
#. Configure Celery to use the :pypi:`django-celery-results` backend.
Assuming you are using Django's :file:`settings.py` to also configure
Celery, add the following settings:
.. code-block:: python
CELERY_RESULT_BACKEND = 'django-db'
For the cache backend you can use:
.. code-block:: python
CELERY_CACHE_BACKEND = 'django-cache'
We can also use the cache defined in the CACHES setting in django.
.. code-block:: python
# celery setting.
CELERY_CACHE_BACKEND = 'default'
# django setting.
CACHES = {
'default': {
'BACKEND': 'django.core.cache.backends.db.DatabaseCache',
'LOCATION': 'my_cache_table',
}
}
If you want to include extended information about your tasks remember to enable the :setting:`result_extended` setting.
.. code-block:: python
CELERY_RESULT_EXTENDED = True
If you want to track the execution duration of your tasks (by comparing `date_started` and `date_done` in TaskResult), enable the :setting:`track_started` setting.
.. code-block:: python
CELERY_TASK_TRACK_STARTED = True
For example, if you write [additional codes](https://github.com/celery/django-celery-results/issues/286#issuecomment-1789094153) to record when a task becomes PENDING, you can calculate the waiting time in the queue or the actual processing time of the worker.
.. code-block:: python
task_result = TaskResult.objects.get(task_id='xxx')
waiting_time = task_result.date_started - task_result.date_created
processing_time = task_result.date_done - task_result.date_started
total_time = task_result.date_done - task_result.date_created
print(f'result: {waiting_time=}, {processing_time=}, {total_time=}')
|
