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 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959
|
.. _faq:
============================
Frequently Asked Questions
============================
.. contents::
:local:
.. _faq-general:
General
=======
.. _faq-when-to-use:
What kinds of things should I use Celery for?
---------------------------------------------
**Answer:** `Queue everything and delight everyone`_ is a good article
describing why you'd use a queue in a web context.
.. _`Queue everything and delight everyone`:
https://decafbad.com/blog/2008/07/04/queue-everything-and-delight-everyone
These are some common use cases:
* Running something in the background. For example, to finish the web request
as soon as possible, then update the users page incrementally.
This gives the user the impression of good performance and "snappiness", even
though the real work might actually take some time.
* Running something after the web request has finished.
* Making sure something is done, by executing it asynchronously and using
retries.
* Scheduling periodic work.
And to some degree:
* Distributed computing.
* Parallel execution.
.. _faq-misconceptions:
Misconceptions
==============
.. _faq-loc:
Does Celery really consist of 50.000 lines of code?
---------------------------------------------------
**Answer:** No, this and similarly large numbers have
been reported at various locations.
The numbers as of this writing are:
- core: 7,141 lines of code.
- tests: 14,209 lines.
- backends, contrib, compat utilities: 9,032 lines.
Lines of code isn't a useful metric, so
even if Celery did consist of 50k lines of code you wouldn't
be able to draw any conclusions from such a number.
Does Celery have many dependencies?
-----------------------------------
A common criticism is that Celery uses too many dependencies.
The rationale behind such a fear is hard to imagine, especially considering
code reuse as the established way to combat complexity in modern software
development, and that the cost of adding dependencies is very low now
that package managers like pip and PyPI makes the hassle of installing
and maintaining dependencies a thing of the past.
Celery has replaced several dependencies along the way, and
the current list of dependencies are:
celery
~~~~~~
- :pypi:`kombu`
Kombu is part of the Celery ecosystem and is the library used
to send and receive messages. It's also the library that enables
us to support many different message brokers. It's also used by the
OpenStack project, and many others, validating the choice to separate
it from the Celery code-base.
- :pypi:`billiard`
Billiard is a fork of the Python multiprocessing module containing
many performance and stability improvements. It's an eventual goal
that these improvements will be merged back into Python one day.
It's also used for compatibility with older Python versions
that don't come with the multiprocessing module.
kombu
~~~~~
Kombu depends on the following packages:
- :pypi:`amqp`
The underlying pure-Python amqp client implementation. AMQP being the default
broker this is a natural dependency.
.. note::
To handle the dependencies for popular configuration
choices Celery defines a number of "bundle" packages,
see :ref:`bundles`.
.. _faq-heavyweight:
Is Celery heavy-weight?
-----------------------
Celery poses very little overhead both in memory footprint and
performance.
But please note that the default configuration isn't optimized for time nor
space, see the :ref:`guide-optimizing` guide for more information.
.. _faq-serialization-is-a-choice:
Is Celery dependent on pickle?
------------------------------
**Answer:** No, Celery can support any serialization scheme.
We have built-in support for JSON, YAML, Pickle, and msgpack.
Every task is associated with a content type, so you can even send one task using pickle,
another using JSON.
The default serialization support used to be pickle, but since 4.0 the default
is now JSON. If you require sending complex Python objects as task arguments,
you can use pickle as the serialization format, but see notes in
:ref:`security-serializers`.
If you need to communicate with other languages you should use
a serialization format suited to that task, which pretty much means any
serializer that's not pickle.
You can set a global default serializer, the default serializer for a
particular Task, or even what serializer to use when sending a single task
instance.
.. _faq-is-celery-for-django-only:
Is Celery for Django only?
--------------------------
**Answer:** No, you can use Celery with any framework, web or otherwise.
.. _faq-is-celery-for-rabbitmq-only:
Do I have to use AMQP/RabbitMQ?
-------------------------------
**Answer**: No, although using RabbitMQ is recommended you can also
use Redis, SQS, or Qpid.
See :ref:`brokers` for more information.
Redis as a broker won't perform as well as
an AMQP broker, but the combination RabbitMQ as broker and Redis as a result
store is commonly used. If you have strict reliability requirements you're
encouraged to use RabbitMQ or another AMQP broker. Some transports also use
polling, so they're likely to consume more resources. However, if you for
some reason aren't able to use AMQP, feel free to use these alternatives.
They will probably work fine for most use cases, and note that the above
points are not specific to Celery; If using Redis/database as a queue worked
fine for you before, it probably will now. You can always upgrade later
if you need to.
.. _faq-is-celery-multilingual:
Is Celery multilingual?
------------------------
**Answer:** Yes.
:mod:`~celery.bin.worker` is an implementation of Celery in Python. If the
language has an AMQP client, there shouldn't be much work to create a worker
in your language. A Celery worker is just a program connecting to the broker
to process messages.
Also, there's another way to be language-independent, and that's to use REST
tasks, instead of your tasks being functions, they're URLs. With this
information you can even create simple web servers that enable preloading of
code. Simply expose an endpoint that performs an operation, and create a task
that just performs an HTTP request to that endpoint.
You can also use `Flower's <https://flower.readthedocs.io>`_ `REST API <https://flower.readthedocs.io/en/latest/api.html#post--api-task-async-apply-(.+)>`_ to invoke tasks.
.. _faq-troubleshooting:
Troubleshooting
===============
.. _faq-mysql-deadlocks:
MySQL is throwing deadlock errors, what can I do?
-------------------------------------------------
**Answer:** MySQL has default isolation level set to `REPEATABLE-READ`,
if you don't really need that, set it to `READ-COMMITTED`.
You can do that by adding the following to your :file:`my.cnf`::
[mysqld]
transaction-isolation = READ-COMMITTED
For more information about InnoDB’s transaction model see `MySQL - The InnoDB
Transaction Model and Locking`_ in the MySQL user manual.
(Thanks to Honza Kral and Anton Tsigularov for this solution)
.. _`MySQL - The InnoDB Transaction Model and Locking`: https://dev.mysql.com/doc/refman/5.1/en/innodb-transaction-model.html
.. _faq-worker-hanging:
The worker isn't doing anything, just hanging
---------------------------------------------
**Answer:** See `MySQL is throwing deadlock errors, what can I do?`_,
or `Why is Task.delay/apply\*/the worker just hanging?`_.
.. _faq-results-unreliable:
Task results aren't reliably returning
--------------------------------------
**Answer:** If you're using the database backend for results, and in particular
using MySQL, see `MySQL is throwing deadlock errors, what can I do?`_.
.. _faq-publish-hanging:
Why is Task.delay/apply\*/the worker just hanging?
--------------------------------------------------
**Answer:** There's a bug in some AMQP clients that'll make it hang if
it's not able to authenticate the current user, the password doesn't match or
the user doesn't have access to the virtual host specified. Be sure to check
your broker logs (for RabbitMQ that's :file:`/var/log/rabbitmq/rabbit.log` on
most systems), it usually contains a message describing the reason.
.. _faq-worker-on-freebsd:
Does it work on FreeBSD?
------------------------
**Answer:** Depends;
When using the RabbitMQ (AMQP) and Redis transports it should work
out of the box.
For other transports the compatibility prefork pool is
used and requires a working POSIX semaphore implementation,
this is enabled in FreeBSD by default since FreeBSD 8.x.
For older version of FreeBSD, you have to enable
POSIX semaphores in the kernel and manually recompile billiard.
Luckily, Viktor Petersson has written a tutorial to get you started with
Celery on FreeBSD here:
http://www.playingwithwire.com/2009/10/how-to-get-celeryd-to-work-on-freebsd/
.. _faq-duplicate-key-errors:
I'm having `IntegrityError: Duplicate Key` errors. Why?
---------------------------------------------------------
**Answer:** See `MySQL is throwing deadlock errors, what can I do?`_.
Thanks to :github_user:`@howsthedotcom`.
.. _faq-worker-stops-processing:
Why aren't my tasks processed?
------------------------------
**Answer:** With RabbitMQ you can see how many consumers are currently
receiving tasks by running the following command:
.. code-block:: console
$ rabbitmqctl list_queues -p <myvhost> name messages consumers
Listing queues ...
celery 2891 2
This shows that there's 2891 messages waiting to be processed in the task
queue, and there are two consumers processing them.
One reason that the queue is never emptied could be that you have a stale
worker process taking the messages hostage. This could happen if the worker
wasn't properly shut down.
When a message is received by a worker the broker waits for it to be
acknowledged before marking the message as processed. The broker won't
re-send that message to another consumer until the consumer is shut down
properly.
If you hit this problem you have to kill all workers manually and restart
them:
.. code-block:: console
$ pkill 'celery worker'
$ # - If you don't have pkill use:
$ # ps auxww | awk '/celery worker/ {print $2}' | xargs kill
You may have to wait a while until all workers have finished executing
tasks. If it's still hanging after a long time you can kill them by force
with:
.. code-block:: console
$ pkill -9 'celery worker'
$ # - If you don't have pkill use:
$ # ps auxww | awk '/celery worker/ {print $2}' | xargs kill -9
.. _faq-task-does-not-run:
Why won't my Task run?
----------------------
**Answer:** There might be syntax errors preventing the tasks module being imported.
You can find out if Celery is able to run the task by executing the
task manually:
.. code-block:: python
>>> from myapp.tasks import MyPeriodicTask
>>> MyPeriodicTask.delay()
Watch the workers log file to see if it's able to find the task, or if some
other error is happening.
.. _faq-periodic-task-does-not-run:
Why won't my periodic task run?
-------------------------------
**Answer:** See `Why won't my Task run?`_.
.. _faq-purge-the-queue:
How do I purge all waiting tasks?
---------------------------------
**Answer:** You can use the ``celery purge`` command to purge
all configured task queues:
.. code-block:: console
$ celery -A proj purge
or programmatically:
.. code-block:: pycon
>>> from proj.celery import app
>>> app.control.purge()
1753
If you only want to purge messages from a specific queue
you have to use the AMQP API or the :program:`celery amqp` utility:
.. code-block:: console
$ celery -A proj amqp queue.purge <queue name>
The number 1753 is the number of messages deleted.
You can also start the worker with the
:option:`--purge <celery worker --purge>` option enabled to purge messages
when the worker starts.
.. _faq-messages-left-after-purge:
I've purged messages, but there are still messages left in the queue?
---------------------------------------------------------------------
**Answer:** Tasks are acknowledged (removed from the queue) as soon
as they're actually executed. After the worker has received a task, it will
take some time until it's actually executed, especially if there are a lot
of tasks already waiting for execution. Messages that aren't acknowledged are
held on to by the worker until it closes the connection to the broker (AMQP
server). When that connection is closed (e.g., because the worker was stopped)
the tasks will be re-sent by the broker to the next available worker (or the
same worker when it has been restarted), so to properly purge the queue of
waiting tasks you have to stop all the workers, and then purge the tasks
using :func:`celery.control.purge`.
.. _faq-results:
Results
=======
.. _faq-get-result-by-task-id:
How do I get the result of a task if I have the ID that points there?
----------------------------------------------------------------------
**Answer**: Use `task.AsyncResult`:
.. code-block:: pycon
>>> result = my_task.AsyncResult(task_id)
>>> result.get()
This will give you a :class:`~celery.result.AsyncResult` instance
using the tasks current result backend.
If you need to specify a custom result backend, or you want to use
the current application's default backend you can use
:class:`@AsyncResult`:
.. code-block:: pycon
>>> result = app.AsyncResult(task_id)
>>> result.get()
.. _faq-security:
Security
========
Isn't using `pickle` a security concern?
----------------------------------------
**Answer**: Indeed, since Celery 4.0 the default serializer is now JSON
to make sure people are choosing serializers consciously and aware of this concern.
It's essential that you protect against unauthorized
access to your broker, databases and other services transmitting pickled
data.
Note that this isn't just something you should be aware of with Celery, for
example also Django uses pickle for its cache client.
For the task messages you can set the :setting:`task_serializer`
setting to "json" or "yaml" instead of pickle.
Similarly for task results you can set :setting:`result_serializer`.
For more details of the formats used and the lookup order when
checking what format to use for a task see :ref:`calling-serializers`
Can messages be encrypted?
--------------------------
**Answer**: Some AMQP brokers supports using SSL (including RabbitMQ).
You can enable this using the :setting:`broker_use_ssl` setting.
It's also possible to add additional encryption and security to messages,
if you have a need for this then you should contact the :ref:`mailing-list`.
Is it safe to run :program:`celery worker` as root?
---------------------------------------------------
**Answer**: No!
We're not currently aware of any security issues, but it would
be incredibly naive to assume that they don't exist, so running
the Celery services (:program:`celery worker`, :program:`celery beat`,
:program:`celeryev`, etc) as an unprivileged user is recommended.
.. _faq-brokers:
Brokers
=======
Why is RabbitMQ crashing?
-------------------------
**Answer:** RabbitMQ will crash if it runs out of memory. This will be fixed in a
future release of RabbitMQ. please refer to the RabbitMQ FAQ:
https://www.rabbitmq.com/faq.html#node-runs-out-of-memory
.. note::
This is no longer the case, RabbitMQ versions 2.0 and above
includes a new persister, that's tolerant to out of memory
errors. RabbitMQ 2.1 or higher is recommended for Celery.
If you're still running an older version of RabbitMQ and experience
crashes, then please upgrade!
Misconfiguration of Celery can eventually lead to a crash
on older version of RabbitMQ. Even if it doesn't crash, this
can still consume a lot of resources, so it's
important that you're aware of the common pitfalls.
* Events.
Running :mod:`~celery.bin.worker` with the :option:`-E <celery worker -E>`
option will send messages for events happening inside of the worker.
Events should only be enabled if you have an active monitor consuming them,
or if you purge the event queue periodically.
* AMQP backend results.
When running with the AMQP result backend, every task result will be sent
as a message. If you don't collect these results, they will build up and
RabbitMQ will eventually run out of memory.
This result backend is now deprecated so you shouldn't be using it.
Use either the RPC backend for rpc-style calls, or a persistent backend
if you need multi-consumer access to results.
Results expire after 1 day by default. It may be a good idea
to lower this value by configuring the :setting:`result_expires`
setting.
If you don't use the results for a task, make sure you set the
`ignore_result` option:
.. code-block:: python
@app.task(ignore_result=True)
def mytask():
pass
class MyTask(Task):
ignore_result = True
.. _faq-use-celery-with-stomp:
Can I use Celery with ActiveMQ/STOMP?
-------------------------------------
**Answer**: No. It used to be supported by :pypi:`Carrot` (our old messaging library)
but isn't currently supported in :pypi:`Kombu` (our new messaging library).
.. _faq-non-amqp-missing-features:
What features aren't supported when not using an AMQP broker?
-------------------------------------------------------------
This is an incomplete list of features not available when
using the virtual transports:
* Remote control commands (supported only by Redis).
* Monitoring with events may not work in all virtual transports.
* The `header` and `fanout` exchange types
(`fanout` is supported by Redis).
.. _faq-tasks:
Tasks
=====
.. _faq-tasks-connection-reuse:
How can I reuse the same connection when calling tasks?
-------------------------------------------------------
**Answer**: See the :setting:`broker_pool_limit` setting.
The connection pool is enabled by default since version 2.5.
.. _faq-sudo-subprocess:
:command:`sudo` in a :mod:`subprocess` returns :const:`None`
------------------------------------------------------------
There's a :command:`sudo` configuration option that makes it illegal
for process without a tty to run :command:`sudo`:
.. code-block:: text
Defaults requiretty
If you have this configuration in your :file:`/etc/sudoers` file then
tasks won't be able to call :command:`sudo` when the worker is
running as a daemon. If you want to enable that, then you need to remove
the line from :file:`/etc/sudoers`.
See: http://timelordz.com/wiki/Apache_Sudo_Commands
.. _faq-deletes-unknown-tasks:
Why do workers delete tasks from the queue if they're unable to process them?
-----------------------------------------------------------------------------
**Answer**:
The worker rejects unknown tasks, messages with encoding errors and messages
that don't contain the proper fields (as per the task message protocol).
If it didn't reject them they could be redelivered again and again,
causing a loop.
Recent versions of RabbitMQ has the ability to configure a dead-letter
queue for exchange, so that rejected messages is moved there.
.. _faq-execute-task-by-name:
Can I call a task by name?
-----------------------------
**Answer**: Yes, use :meth:`@send_task`.
You can also call a task by name, from any language,
using an AMQP client:
.. code-block:: python
>>> app.send_task('tasks.add', args=[2, 2], kwargs={})
<AsyncResult: 373550e8-b9a0-4666-bc61-ace01fa4f91d>
To use ``chain``, ``chord`` or ``group`` with tasks called by name,
use the :meth:`@Celery.signature` method:
.. code-block:: python
>>> chain(
... app.signature('tasks.add', args=[2, 2], kwargs={}),
... app.signature('tasks.add', args=[1, 1], kwargs={})
... ).apply_async()
<AsyncResult: e9d52312-c161-46f0-9013-2713e6df812d>
.. _faq-get-current-task-id:
Can I get the task id of the current task?
----------------------------------------------
**Answer**: Yes, the current id and more is available in the task request::
@app.task(bind=True)
def mytask(self):
cache.set(self.request.id, "Running")
For more information see :ref:`task-request-info`.
If you don't have a reference to the task instance you can use
:attr:`app.current_task <@current_task>`:
.. code-block:: python
>>> app.current_task.request.id
But note that this will be any task, be it one executed by the worker, or a
task called directly by that task, or a task called eagerly.
To get the current task being worked on specifically, use
:attr:`app.current_worker_task <@current_worker_task>`:
.. code-block:: python
>>> app.current_worker_task.request.id
.. note::
Both :attr:`~@current_task`, and :attr:`~@current_worker_task` can be
:const:`None`.
.. _faq-custom-task-ids:
Can I specify a custom task_id?
-------------------------------
**Answer**: Yes, use the `task_id` argument to :meth:`Task.apply_async`:
.. code-block:: pycon
>>> task.apply_async(args, kwargs, task_id='…')
Can I use decorators with tasks?
--------------------------------
**Answer**: Yes, but please see note in the sidebar at :ref:`task-basics`.
.. _faq-natural-task-ids:
Can I use natural task ids?
---------------------------
**Answer**: Yes, but make sure it's unique, as the behavior
for two tasks existing with the same id is undefined.
The world will probably not explode, but they can
definitely overwrite each others results.
.. _faq-task-callbacks:
Can I run a task once another task has finished?
------------------------------------------------
**Answer**: Yes, you can safely launch a task inside a task.
A common pattern is to add callbacks to tasks:
.. code-block:: python
from celery.utils.log import get_task_logger
logger = get_task_logger(__name__)
@app.task
def add(x, y):
return x + y
@app.task(ignore_result=True)
def log_result(result):
logger.info("log_result got: %r", result)
Invocation:
.. code-block:: pycon
>>> (add.s(2, 2) | log_result.s()).delay()
See :doc:`userguide/canvas` for more information.
.. _faq-cancel-task:
Can I cancel the execution of a task?
-------------------------------------
**Answer**: Yes, Use :meth:`result.revoke() <celery.result.AsyncResult.revoke>`:
.. code-block:: pycon
>>> result = add.apply_async(args=[2, 2], countdown=120)
>>> result.revoke()
or if you only have the task id:
.. code-block:: pycon
>>> from proj.celery import app
>>> app.control.revoke(task_id)
The latter also support passing a list of task-ids as argument.
.. _faq-node-not-receiving-broadcast-commands:
Why aren't my remote control commands received by all workers?
--------------------------------------------------------------
**Answer**: To receive broadcast remote control commands, every worker node
creates a unique queue name, based on the nodename of the worker.
If you have more than one worker with the same host name, the
control commands will be received in round-robin between them.
To work around this you can explicitly set the nodename for every worker
using the :option:`-n <celery worker -n>` argument to
:mod:`~celery.bin.worker`:
.. code-block:: console
$ celery -A proj worker -n worker1@%h
$ celery -A proj worker -n worker2@%h
where ``%h`` expands into the current hostname.
.. _faq-task-routing:
Can I send some tasks to only some servers?
--------------------------------------------
**Answer:** Yes, you can route tasks to one or more workers,
using different message routing topologies, and a worker instance
can bind to multiple queues.
See :doc:`userguide/routing` for more information.
.. _faq-disable-prefetch:
Can I disable prefetching of tasks?
-----------------------------------
**Answer**: Maybe! The AMQP term "prefetch" is confusing, as it's only used
to describe the task prefetching *limit*. There's no actual prefetching involved.
Disabling the prefetch limits is possible, but that means the worker will
consume as many tasks as it can, as fast as possible.
A discussion on prefetch limits, and configuration settings for a worker
that only reserves one task at a time is found here:
:ref:`optimizing-prefetch-limit`.
.. _faq-change-periodic-task-interval-at-runtime:
Can I change the interval of a periodic task at runtime?
--------------------------------------------------------
**Answer**: Yes, you can use the Django database scheduler, or you can
create a new schedule subclass and override
:meth:`~celery.schedules.schedule.is_due`:
.. code-block:: python
from celery.schedules import schedule
class my_schedule(schedule):
def is_due(self, last_run_at):
return run_now, next_time_to_check
.. _faq-task-priorities:
Does Celery support task priorities?
------------------------------------
**Answer**: Yes, RabbitMQ supports priorities since version 3.5.0,
and the Redis transport emulates priority support.
You can also prioritize work by routing high priority tasks
to different workers. In the real world this usually works better
than per message priorities. You can use this in combination with rate
limiting, and per message priorities to achieve a responsive system.
.. _faq-acks_late-vs-retry:
Should I use retry or acks_late?
--------------------------------
**Answer**: Depends. It's not necessarily one or the other, you may want
to use both.
`Task.retry` is used to retry tasks, notably for expected errors that
is catch-able with the :keyword:`try` block. The AMQP transaction isn't used
for these errors: **if the task raises an exception it's still acknowledged!**
The `acks_late` setting would be used when you need the task to be
executed again if the worker (for some reason) crashes mid-execution.
It's important to note that the worker isn't known to crash, and if
it does it's usually an unrecoverable error that requires human
intervention (bug in the worker, or task code).
In an ideal world you could safely retry any task that's failed, but
this is rarely the case. Imagine the following task:
.. code-block:: python
@app.task
def process_upload(filename, tmpfile):
# Increment a file count stored in a database
increment_file_counter()
add_file_metadata_to_db(filename, tmpfile)
copy_file_to_destination(filename, tmpfile)
If this crashed in the middle of copying the file to its destination
the world would contain incomplete state. This isn't a critical
scenario of course, but you can probably imagine something far more
sinister. So for ease of programming we have less reliability;
It's a good default, users who require it and know what they
are doing can still enable acks_late (and in the future hopefully
use manual acknowledgment).
In addition `Task.retry` has features not available in AMQP
transactions: delay between retries, max retries, etc.
So use retry for Python errors, and if your task is idempotent
combine that with `acks_late` if that level of reliability
is required.
.. _faq-schedule-at-specific-time:
Can I schedule tasks to execute at a specific time?
---------------------------------------------------
**Answer**: Yes. You can use the `eta` argument of :meth:`Task.apply_async`.
Note that using distant `eta` times is not recommended, and in such case
:ref:`periodic tasks<guide-beat>` should be preferred.
See :ref:`calling-eta` for more details.
.. _faq-safe-worker-shutdown:
Can I safely shut down the worker?
----------------------------------
**Answer**: Yes, use the :sig:`TERM` signal.
This will tell the worker to finish all currently
executing jobs and shut down as soon as possible. No tasks should be lost
even with experimental transports as long as the shutdown completes.
You should never stop :mod:`~celery.bin.worker` with the :sig:`KILL` signal
(``kill -9``), unless you've tried :sig:`TERM` a few times and waited a few
minutes to let it get a chance to shut down.
Also make sure you kill the main worker process only, not any of its child
processes. You can direct a kill signal to a specific child process if
you know the process is currently executing a task the worker shutdown
is depending on, but this also means that a ``WorkerLostError`` state will
be set for the task so the task won't run again.
Identifying the type of process is easier if you have installed the
:pypi:`setproctitle` module:
.. code-block:: console
$ pip install setproctitle
With this library installed you'll be able to see the type of process in
:command:`ps` listings, but the worker must be restarted for this to take effect.
.. seealso::
:ref:`worker-stopping`
.. _faq-daemonizing:
Can I run the worker in the background on [platform]?
-----------------------------------------------------
**Answer**: Yes, please see :ref:`daemonizing`.
.. _faq-django:
Django
======
.. _faq-django-beat-database-tables:
What purpose does the database tables created by ``django-celery-beat`` have?
-----------------------------------------------------------------------------
When the database-backed schedule is used the periodic task
schedule is taken from the ``PeriodicTask`` model, there are
also several other helper tables (``IntervalSchedule``,
``CrontabSchedule``, ``PeriodicTasks``).
.. _faq-django-result-database-tables:
What purpose does the database tables created by ``django-celery-results`` have?
--------------------------------------------------------------------------------
The Django database result backend extension requires
two extra models: ``TaskResult`` and ``GroupResult``.
.. _faq-windows:
Windows
=======
.. _faq-windows-worker-embedded-beat:
Does Celery support Windows?
----------------------------------------------------------------
**Answer**: No.
Since Celery 4.x, Windows is no longer supported due to lack of resources.
But it may still work and we are happy to accept patches.
|