Celery 1.0.6 (stable) documentation

This Page

Configuration - celery.conf

QUEUES

Queue name/options mapping.

DEFAULT_QUEUE

Name of the default queue.

DEFAULT_EXCHANGE

Default exchange.

DEFAULT_EXCHANGE_TYPE

Default exchange type.

DEFAULT_DELIVERY_MODE

Default delivery mode ("persistent" or "non-persistent"). Default is "persistent".

DEFAULT_ROUTING_KEY

Default routing key used when sending tasks.

BROKER_CONNECTION_TIMEOUT

The timeout in seconds before we give up establishing a connection to the AMQP server.

BROADCAST_QUEUE

Name prefix for the queue used when listening for broadcast messages. The workers hostname will be appended to the prefix to create the final queue name.

Default is "celeryctl".

BROADCAST_EXCHANGE

Name of the exchange used for broadcast messages.

Default is "celeryctl".

BROADCAST_EXCHANGE_TYPE

Exchange type used for broadcast messages. Default is "fanout".

EVENT_QUEUE

Name of queue used to listen for event messages. Default is "celeryevent".

EVENT_EXCHANGE

Exchange used to send event messages. Default is "celeryevent".

EVENT_EXCHANGE_TYPE

Exchange type used for the event exchange. Default is "topic".

EVENT_ROUTING_KEY

Routing key used for events. Default is "celeryevent".

EVENT_SERIALIZER

Type of serialization method used to serialize events. Default is "json".

RESULT_EXCHANGE

Exchange used by the AMQP result backend to publish task results. Default is "celeryresult".

CELERY_SEND_TASK_ERROR_EMAILS

If set to True, errors in tasks will be sent to admins by e-mail. If unset, it will send the e-mails if settings.DEBUG is True.

ALWAYS_EAGER

Always execute tasks locally, don’t send to the queue.

TASK_RESULT_EXPIRES

Task tombstone expire time in seconds.

IGNORE_RESULT

If enabled, the default behavior will be to not store task results.

TRACK_STARTED

If enabled, the default behavior will be to track when tasks starts by storing the STARTED state.

ACKS_LATE

If enabled, the default behavior will be to acknowledge task messages after the task is executed.

STORE_ERRORS_EVEN_IF_IGNORED

If enabled, task errors will be stored even though Task.ignore_result is enabled.

MAX_CACHED_RESULTS

Total number of results to store before results are evicted from the result cache.

BROKER_CONNECTION_RETRY

Automatically try to re-establish the connection to the AMQP broker if it’s lost.

BROKER_CONNECTION_MAX_RETRIES

Maximum number of retries before we give up re-establishing a connection to the broker.

If this is set to 0 or None, we will retry forever.

Default is 100 retries.

TASK_SERIALIZER

A string identifying the default serialization method to use. Can be pickle (default), json, yaml, or any custom serialization methods that have been registered with carrot.serialization.registry.

Default is pickle.

RESULT_BACKEND

The backend used to store task results (tombstones).

CELERY_CACHE_BACKEND

Use a custom cache backend for celery. If not set the django-global cache backend in CACHE_BACKEND will be used.

SEND_EVENTS

If set, celery will send events that can be captured by monitors like celerymon. Default is: False.

DEFAULT_RATE_LIMIT

The default rate limit applied to all tasks which doesn’t have a custom rate limit defined. (Default: None)

DISABLE_RATE_LIMITS

If True all rate limits will be disabled and all tasks will be executed as soon as possible.

CELERYBEAT_LOG_LEVEL

Default log level for celerybeat. Default is: INFO.

CELERYBEAT_LOG_FILE

Default log file for celerybeat. Default is: None (stderr)

CELERYBEAT_SCHEDULE_FILENAME

Name of the persistent schedule database file. Default is: celerybeat-schedule.

CELERYBEAT_MAX_LOOP_INTERVAL

The maximum number of seconds celerybeat is allowed to sleep between checking the schedule. The default is 5 minutes, which means celerybeat can only sleep a maximum of 5 minutes after checking the schedule run-times for a periodic task to apply. If you change the run_times of periodic tasks at run-time, you may consider lowering this value for changes to take effect faster (A value of 5 minutes, means the changes will take effect in 5 minutes at maximum).

CELERYMON_LOG_LEVEL

Default log level for celerymon. Default is: INFO.

CELERYMON_LOG_FILE

Default log file for celerymon. Default is: None (stderr)

LOG_LEVELS

Mapping of log level names to logging module constants.

CELERYD_LOG_FORMAT

The format to use for log messages.

CELERYD_TASK_LOG_FORMAT

The format to use for task log messages.

CELERYD_LOG_FILE

Filename of the daemon log file. Default is: None (stderr)

CELERYD_LOG_LEVEL

Default log level for daemons. (WARN)

CELERYD_CONCURRENCY

The number of concurrent worker processes. If set to 0, the total number of available CPUs/cores will be used.

CELERYD_PREFETCH_MULTIPLIER

The number of concurrent workers is multipled by this number to yield the wanted AMQP QoS message prefetch count.

CELERYD_POOL

Name of the task pool class used by the worker. Default is "celery.worker.pool.TaskPool".

CELERYD_LISTENER

Name of the listener class used by the worker. Default is "celery.worker.listener.CarrotListener".

CELERYD_MEDIATOR

Name of the mediator class used by the worker. Default is "celery.worker.controllers.Mediator".

CELERYD_ETA_SCHEDULER

Name of the ETA scheduler class used by the worker. Default is "celery.worker.controllers.ScheduleController".