Rendered documentation for Github Pages.

_sources/changelog.txt

@@ -9,9 +9,7 @@
 
 2.4.0
 =====
-:release-date: 2011-10-28 04:00 P.M BST
-:status: FROZEN
-:branch: master
+:release-date: 2011-11-04 04:00 P.M GMT
 
 .. _v240-important:
 
@@ -32,6 +30,10 @@ Important Notes
 
     This is a workaround for http://bugs.python.org/issue6721#msg140215.
 
+    Be aware that while this fixes the logging library lock,
+    there could still be other locks initialized in the parent
+    process, introduced by custom code.
+
     Fix contributed by Harm Verhagen.
 
 * AMQP Result backend: Now expires results by default.
@@ -49,43 +51,48 @@ Important Notes
 
         CELERY_TASK_RESULT_EXPIRES = None
 
+* Eventlet: Fixed problem with shutdown (Issue #457).
+
 * Broker transports can be now be specified using URLs
 
-    The broker hostname can now be given as an URL instead, of the format::
+    The broker can now be specified as an URL instead.
+    This URL must have the format::
 
         transport://user:password@hostname:port/virtual_host
 
     for example the default broker is written as::
 
         amqp://guest:guest@localhost:5672//
 
-    Transport defaults to amqp, and is not required.
-    user, password, port and virtual_host is also not mandatory and
-    will default to the corresponding transport default.
+    The scheme is required, so that the host is identified
+    as an URL and not just a host name.
+    User, password, port and virtual_host are optional and
+    defaults to the particular transports default value.
 
     .. note::
 
         Note that the path component (virtual_host) always starts with a
         forward-slash.  This is necessary to distinguish between the virtual
-        host '' (empty) and '/', which are both acceptable virtual host names.
+        host ``''`` (empty) and ``'/'``, which are both acceptable virtual
+        host names.
 
-        A virtual host of '/' becomes:
+        A virtual host of ``'/'`` becomes:
 
             amqp://guest:guest@localhost:5672//
 
-        and a virtual host of '' (empty) becomes::
+        and a virtual host of ``''`` (empty) becomes::
 
             amqp://guest:guest@localhost:5672/
 
         So the leading slash in the path component is **always required**.
 
-   In addition the :setting:`BROKER_URL` setting has been added as an alias
-   to ``BROKER_HOST``.  Any broker setting specified in both the URL and in
-   the configuration will be ignored, if a setting is not provided in the URL
-   then the value from the configuration will be used as default.
+    In addition the :setting:`BROKER_URL` setting has been added as an alias
+    to ``BROKER_HOST``.  Any broker setting specified in both the URL and in
+    the configuration will be ignored, if a setting is not provided in the URL
+    then the value from the configuration will be used as default.
 
-   Also, programs now support the :option:`-b|--broker` option to specify
-   a broker URL on the command line::
+    Also, programs now support the :option:`-b|--broker` option to specify
+    a broker URL on the command line::
 
         $ celeryd -b redis://localhost
 
@@ -99,15 +106,15 @@ Important Notes
 * The :setting:`CELERY_TASK_ERROR_WHITELIST` setting has been replaced
   by a more flexible approach (Issue #447).
 
-  The Mail sending logic is now available as ``Task.ErrorMail``.
-  The actual implementation is in :module:`celery.utils.mail`.
+    The error mail sending logic is now available as ``Task.ErrorMail``,
+    with the implementation (for reference) in :mod:`celery.utils.mail`.
 
-  The error mail class can be sub-classed to gain complete control
-  of when error messages are sent, thus removing the need for a separate
-  white-list setting.
+    The error mail class can be sub-classed to gain complete control
+    of when error messages are sent, thus removing the need for a separate
+    white-list setting.
 
-  The :setting:`CELERY_TASK_ERROR_WHITELIST` setting has been deprecated,
-  and will be removed completely in version 3.0.
+    The :setting:`CELERY_TASK_ERROR_WHITELIST` setting has been deprecated,
+    and will be removed completely in version 3.0.
 
 * Additional Deprecations
 
@@ -145,6 +152,8 @@ News
 
 * No longer depends on :mod:`pyparsing`.
 
+* Now depends on Kombu 1.4.3.
+
 * CELERY_IMPORTS can now be a scalar value (Issue #485).
 
     It is too easy to forget to add the comma after the sole element of a
@@ -179,6 +188,9 @@ News
 
     Contributed by Chris Chamberlin.
 
+* Fixed race condition in celery.events.state (celerymon/celeryev)
+  where task info would be removed while iterating over it (Issue #501).
+
 * The Cache, Cassandra, MongoDB, Redis and Tyrant backends now respects
   the :setting:`CELERY_RESULT_SERIALIZER` setting (Issue #435).
 
@@ -196,6 +208,10 @@ News
 * ``celeryd_multi`` now supports a ``stop_verify`` command to wait for
   processes to shutdown.
 
+* Cache backend did not work if the cache key was unicode (Issue #504).
+
+    Fix contributed by Neil Chintomby.
+
 * New setting :setting:`CELERY_RESULT_DB_SHORT_LIVED_SESSIONS` added,
   which if enabled will disable the caching of SQLAlchemy sessions
   (Issue #449).
@@ -207,6 +223,8 @@ News
 
     Fix contributed by Remy Noel
 
+* celeryd-multi did not work on Windows (Issue #472).
+
 * New-style ``CELERY_REDIS_*`` settings now takes precedence over
   the old ``REDIS_*`` configuration keys (Issue #508).
 
@@ -223,13 +241,16 @@ News
 
 * The :setting:`CELERYBEAT_MAX_LOOP_INTERVAL` setting was not respected.
 
-* ``inspect.registered_tasks`` renamed to ``inspect.tasks`` for naming
+* ``inspect.registered_tasks`` renamed to ``inspect.registered`` for naming
   consistency.
 
     The previous name is still available as an alias.
 
     Contributed by Mher Movsisyan
 
+* Worker logged the string representation of args and kwargs
+  without safe guards (Issue #480).
+
 * RHEL init script: Changed celeryd startup priority.
 
     The default start / stop priorities for MySQL on RHEL are
@@ -248,6 +269,12 @@ News
 
     Contributed by Yury V. Zaytsev.
 
+* KeyValueStoreBackend.get_many did not respect the ``timeout`` argument
+  (Issue #512).
+
+* celerybeat/celeryev's --workdir option did not chdir before after
+  configuration was attempted (Issue #506).
+
 * After deprecating 2.4 support we can now name modules correctly, since we
   can take use of absolute imports.
 
@@ -261,6 +288,21 @@ News
     Also, as you may have noticed the contributors of new features/fixes are
     now mentioned in the Changelog.
 
+.. _version-2.3.3:
+
+2.3.3
+=====
+:release-date: 2011-16-09 05:00 P.M BST
+:by: Mher Movsisyan
+
+* Monkey patching :attr:`sys.stdout` could result in the worker
+  crashing if the replacing object did not define :meth:`isatty`
+  (Issue #477).
+
+* ``CELERYD`` option in :file:`/etc/default/celeryd` should not
+  be used with generic init scripts.
+
+
 .. _version-2.3.2:
 
 2.3.2
@@ -277,7 +319,7 @@ News
     If you'd like to contribute to Celery you should read this
     guide: http://ask.github.com/celery/contributing.html
 
-    We are looking for contributors of all skill levels, so don't
+    We are looking for contributors at all skill levels, so don't
     hesitate!
 
 * Now depends on Kombu 1.3.1

_sources/configuration.txt

@@ -127,8 +127,9 @@ Can be one of the following:
 CELERY_RESULT_SERIALIZER
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-Result message serialization format.  Default is `"pickle"`. See
-:ref:`executing-serializers`.
+Result serialization format.  Default is `"pickle"`. See
+:ref:`executing-serializers` for information about supported
+serialization formats.
 
 .. _conf-database-result-backend:
 
@@ -533,17 +534,20 @@ built-in transports: ``amqplib``, ``pika``, ``redis``, ``beanstalk``,
 
 .. setting:: BROKER_URL
 
-Default broker URL.  This must be an URL in the format of::
+BROKER_URL
+~~~~~~~~~~
+
+Default broker URL.  This must be an URL in the form of::
 
     transport://userid:password@hostname:port/virtual_host
 
+Only the scheme part (``transport://``) is required, the rest
+is optional, and defaults to the specific transports default values.
+
 If this setting is defined it will override a subset of the
-other ``BROKER`` options, these options are :setting:`BROKER_HOST`,
+other ``BROKER`` options. These options are :setting:`BROKER_HOST`,
 :setting:`BROKER_USER`, :setting:`BROKER_PASSWORD`, :setting:`BROKER_PORT`,
-and :setting:`BROKER_VHOST`.  The query part of the URL can also be used
-to set options, e.g.::
-
-    amqp://localhost/myvhost?ssl=1
+and :setting:`BROKER_VHOST`.
 
 See the Kombu documentation for more information about broker URLs.
 

_sources/faq.txt

@@ -405,6 +405,10 @@ 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.
 
+Results expire after 1 day by default.  It may be a good idea
+to lower this value by configuring the :setting:`CELERY_TASK_RESULT_EXPIRES`
+setting.
+
 If you don't use the results for a task, make sure you set the
 `ignore_result` option:
 
@@ -417,17 +421,6 @@ If you don't use the results for a task, make sure you set the
     class MyTask(Task):
         ignore_result = True
 
-Results can also be disabled globally using the
-:setting:`CELERY_IGNORE_RESULT` setting.
-
-.. note::
-
-    Celery version 2.1 added support for automatic expiration of
-    AMQP result backend results.
-
-    To use this you need to run RabbitMQ 2.1 or higher and enable
-    the :setting:`CELERY_AMQP_TASK_RESULT_EXPIRES` setting.
-
 .. _faq-use-celery-with-stomp:
 
 Can I use Celery with ActiveMQ/STOMP?

_sources/internals/reference/celery.datastructures.txt

@@ -54,8 +54,3 @@
     .. autoclass:: LRUCache
         :members:
         :undoc-members:
-
-    Functions
-    ---------
-
-    .. autofunction:: consume_queue

_sources/reference/celery.signals.txt

@@ -1,5 +1,11 @@
-.. _signals:
+======================================================
+ celery.signals
+======================================================
 
+.. contents::
+    :local:
 .. currentmodule:: celery.signals
 
 .. automodule:: celery.signals
+    :members:
+    :undoc-members:

_sources/userguide/index.txt

@@ -21,3 +21,4 @@
     monitoring
     optimizing
     concurrency/index
+    signals

_sources/userguide/monitoring.txt

@@ -93,10 +93,10 @@ Commands
 
         $ celeryctl inspect revoked
 
-* **inspect registered_tasks**: List registered tasks
+* **inspect registered**: List registered tasks
     ::
 
-        $ celeryctl inspect registered_tasks
+        $ celeryctl inspect registered
 
 * **inspect stats**: Show worker statistics
     ::

_sources/userguide/optimizing.txt

@@ -47,10 +47,10 @@ like adding new worker nodes, or revoking unnecessary tasks.
 .. _`The back of the envelope`:
     http://books.google.com/books?id=kse_7qbWbjsC&pg=PA67
 
-.. _optimizing-worker-settings:
+.. _optimizing-general-settings:
 
-Worker Settings
-===============
+General Settings
+================
 
 .. _optimizing-connection-pools:
 
@@ -60,8 +60,16 @@ Broker Connection Pools
 You should enable the :setting:`BROKER_POOL_LIMIT` setting,
 as this will drastically improve overall performance.
 
+The value should be based on how many threads will use
+connections at the same time.
+
 This setting will be enabled by default in version 3.0.
 
+.. _optimizing-worker-settings:
+
+Worker Settings
+===============
+
 .. _optimizing-prefetch-limit:
 
 Prefetch Limits

_sources/userguide/remote-tasks.txt

@@ -109,7 +109,7 @@ task being executed::
             [f2cc8efc-2a14-40cd-85ad-f1c77c94beeb] processed: 100
 
 Since applying tasks can be done via HTTP using the
-`djcelery.views.apply` view, executing tasks from other languages is easy.
+:func:`djcelery.views.apply` view, executing tasks from other languages is easy.
 For an example service exposing tasks via HTTP you should have a look at
 `examples/celery_http_gateway` in the Celery distribution:
 http://github.com/ask/celery/tree/master/examples/celery_http_gateway/