Интерфейс командной строки

amqp

Оболочка администрирования AMQP.

Также работает с транспортами, не использующими AMQP (кроме тех, которые хранят объявления в памяти).

celeryamqp[OPTIONS]COMMAND[ARGS]...

celeryamqpbasic.ack[OPTIONS]DELIVERY_TAG

celeryamqpbasic.get[OPTIONS]QUEUE[NO_ACK]

celeryamqpbasic.publish[OPTIONS]MSGEXCHANGEROUTING_KEY[MANDATORY]
[IMMEDIATE]

celeryamqpexchange.declare[OPTIONS]EXCHANGETYPE[PASSIVE][DURABLE]
[AUTO_DELETE]

celeryamqpexchange.delete[OPTIONS]EXCHANGEIF_UNUSED

celeryamqpqueue.bind[OPTIONS]QUEUEEXCHANGEROUTING_KEY

celeryamqpqueue.declare[OPTIONS]QUEUE[PASSIVE][DURABLE][AUTO_DELETE]

celeryamqpqueue.delete[OPTIONS]QUEUE[IF_UNUSED][IF_EMPTY]

celeryamqpqueue.purge[OPTIONS]QUEUE

celeryamqprepl[OPTIONS]

beat

Запустить планировщик периодических задач beat.

celerybeat[OPTIONS]

Параметры

--detach

Отсоединиться и запустить в фоновом режиме как демон.

-s, --schedule <schedule>

Путь к базе данных расписания. По умолчанию — celerybeat-schedule. К имени файла может быть добавлено расширение «.db».

-S, --scheduler <scheduler>

Используемый класс планировщика.

--max-interval <max_interval>

Максимальное время сна в секундах между итерациями планировщика.

-l, --loglevel <loglevel>

Уровень ведения журнала.

Варианты:

DEBUG | INFO | WARNING | ERROR | CRITICAL | FATAL

-f, --logfile <logfile>

Место назначения журнала; по умолчанию — stderr

--pidfile <pidfile>

Путь к PID-файлу; по умолчанию PID-файл не создается

--uid <uid>

Сбросить привилегии до указанного идентификатора пользователя

--gid <gid>

Сбросить привилегии до указанного идентификатора группы

--umask <umask>

Создавать файлы и каталоги с указанной маской umask

--executable <executable>

Переопределить путь к исполняемому файлу Python

call

Вызвать задачу по имени.

celerycall[OPTIONS]NAME

Параметры

-a, --args <args>

Позиционные аргументы.

-k, --kwargs <kwargs>

Именованные аргументы.

--eta <eta>

Запланированное время.

--countdown <countdown>

Время eta в секундах от текущего момента.

--expires <expires>

Время истечения срока действия.

--serializer <serializer>

Сериализатор задачи.

--queue <queue>

Пользовательское имя очереди.

--exchange <exchange>

Пользовательское имя обменника.

--routing-key <routing_key>

Пользовательский ключ маршрутизации.

Аргументы

NAME

Обязательный аргумент

control

Отправить команду управления COMMAND рабочим процессам.

Доступно для транспортов RabbitMQ (AMQP), Redis и MongoDB.

celerycontrol[OPTIONS]COMMAND

Параметры

--list

Вывести список доступных команд управления и завершить работу.

-t, --timeout <timeout>

Время ожидания ответа в секундах.

-d, --destination <destination>

Список имен узлов назначения, разделенных запятыми.

-j, --json

Использовать JSON в качестве формата вывода.

Аргументы

COMMAND

Обязательный аргумент

events

Утилиты для потока событий.

celeryevents[OPTIONS]

Параметры

-d, --dump

-c, --camera <camera>

-d, --detach

-F, --frequency, --freq <frequency>

-r, --maxrate <maxrate>

-l, --loglevel <loglevel>

Уровень ведения журнала.

Варианты:

DEBUG | INFO | WARNING | ERROR | CRITICAL | FATAL

-f, --logfile <logfile>

Место назначения журнала; по умолчанию — stderr

--pidfile <pidfile>

Путь к PID-файлу; по умолчанию PID-файл не создается

--uid <uid>

Сбросить привилегии до указанного идентификатора пользователя

--gid <gid>

Сбросить привилегии до указанного идентификатора группы

--umask <umask>

Создавать файлы и каталоги с указанной маской umask

--executable <executable>

Переопределить путь к исполняемому файлу Python

graph

Команда celery graph.

celerygraph[OPTIONS]COMMAND[ARGS]...

celerygraphbootsteps[OPTIONS]

celerygraphworkers[OPTIONS]

inspect

Проверить рабочие процессы, отправив им команду inspect COMMAND.

Доступно для транспортов RabbitMQ (AMQP) и Redis.

celeryinspect[OPTIONS]COMMAND

Параметры

--list

Вывести список доступных команд inspect и завершить работу.

-t, --timeout <timeout>

Время ожидания ответа в секундах.

-d, --destination <destination>

Список имен узлов назначения, разделенных запятыми.

-j, --json

Использовать JSON в качестве формата вывода.

Аргументы

COMMAND

Обязательный аргумент

list

Получить сведения от брокера.

Примечание:

Для RabbitMQ требуется плагин управления.

celerylist[OPTIONS]COMMAND[ARGS]...

celerylistbindings[OPTIONS]

logtool

Команда celery logtool.

celerylogtool[OPTIONS]COMMAND[ARGS]...

celerylogtooldebug[OPTIONS][FILES]...

celerylogtoolerrors[OPTIONS][FILES]...

celerylogtoolincomplete[OPTIONS][FILES]...

celerylogtoolstats[OPTIONS][FILES]...

celerylogtooltraces[OPTIONS][FILES]...

migrate

Перенести задачи с одного брокера на другой.

Предупреждение:

Эта команда экспериментальная. Перед продолжением убедитесь, что у вас есть резервная копия задач.

celerymigrate[OPTIONS]SOURCEDESTINATION

Параметры

-n, --limit <limit>

Количество задач для получения.

-t, --timeout <timeout>

Время ожидания задач в секундах.

-a, --ack-messages

Подтверждать сообщения от исходного брокера.

-T, --tasks <tasks>

Список имен задач для фильтрации.

-Q, --queues <queues>

Список очередей для переноса.

-F, --forever

Непрерывно переносить задачи, пока процесс не будет завершен.

Аргументы

SOURCE

Обязательный аргумент

DESTINATION

Обязательный аргумент

multi

Запустить несколько экземпляров рабочих процессов.

celerymulti[OPTIONS]

purge

Удалить все сообщения из всех известных очередей задач.

Предупреждение:

Эту команду нельзя отменить.

celerypurge[OPTIONS]

Параметры

-f, --force

Не запрашивать подтверждение.

-Q, --queues <queues>

Список имен очередей для очистки, разделенных запятыми.

-X, --exclude-queues <exclude_queues>

Список имен очередей, которые не нужно очищать, разделенных запятыми.

report

Выводит сведения, которые полезно включить в отчеты об ошибках.

celeryreport[OPTIONS]

result

Вывести возвращаемое значение для указанного идентификатора задачи.

celeryresult[OPTIONS]TASK_ID

Параметры

-t, --task <task>

Имя задачи (для пользовательского бэкенда).

--traceback

Вместо этого вывести трассировку стека.

Аргументы

TASK_ID

Обязательный аргумент

shell

Запустить сеанс оболочки с удобным доступом к символам Celery.

В глобальную область видимости будут добавлены следующие символы: - celery: текущее приложение. - chord, group, chain, chunks,

xmap, xstarmap subtask, Task

• все зарегистрированные задачи.

celeryshell[OPTIONS]

Параметры

-I, --ipython

Принудительно использовать IPython.

-B, --bpython

Принудительно использовать bpython.

--python

Принудительно использовать оболочку Python по умолчанию.

-T, --without-tasks

Не добавлять задачи в локальную область видимости.

--eventlet

Использовать eventlet.

--gevent

Использовать gevent.

status

Показать список работающих в сети рабочих процессов.

celerystatus[OPTIONS]

Параметры

-t, --timeout <timeout>

Время ожидания ответа в секундах.

-d, --destination <destination>

Список имен узлов назначения, разделенных запятыми.

-j, --json

Использовать JSON в качестве формата вывода.

upgrade

Выполнить обновление между версиями.

celeryupgrade[OPTIONS]COMMAND[ARGS]...

celeryupgradesettings[OPTIONS]FILENAME

worker

Запустить экземпляр рабочего процесса.

celeryworker[OPTIONS]

Параметры

-n, --hostname <hostname>

Задать пользовательское имя хоста (например, ‘w1@%%h’). Подстановки: %%h (имя хоста), %%n (имя) и %%d (домен).

-D, --detach

Запустить рабочий процесс в фоновом режиме.

-S, --statedb <statedb>

Путь к базе данных состояния. К имени файла может быть добавлено расширение «.db».

-l, --loglevel <loglevel>

Уровень ведения журнала.

Варианты:

DEBUG | INFO | WARNING | ERROR | CRITICAL | FATAL

-O, --optimization <optimization>

Применить профиль оптимизации.

Варианты:

default | fair

--prefetch-multiplier <prefetch multiplier>

Задать пользовательское значение коэффициента предварительной выборки для этого экземпляра рабочего процесса.

--disable-prefetch

Отключить предварительную выборку брокером. Рабочий процесс будет получать задачу, только когда появится свободный слот процесса. Поддерживается только брокерами Redis.

-c, --concurrency <concurrency>

Количество дочерних процессов, обрабатывающих очередь. По умолчанию используется количество ЦП, доступных в вашей системе.

-P, --pool <pool>

Реализация пула.

Варианты:

prefork | eventlet | gevent | solo | processes | threads | custom

-E, --task-events, --events

Отправлять события, связанные с задачами, которые могут перехватываться такими средствами мониторинга, как celery events, celerymon и другими.

--time-limit <time_limit>

Включить жесткое ограничение времени выполнения задач (в секундах, целое или вещественное число).

--soft-time-limit <soft_time_limit>

Включить мягкое ограничение времени выполнения задач (в секундах, целое или вещественное число).

--max-tasks-per-child <max_tasks_per_child>

Максимальное количество задач, которое может выполнить рабочий процесс пула, прежде чем его завершат и заменят новым рабочим процессом.

--max-memory-per-child <max_memory_per_child>

Максимальный объем резидентной памяти в КиБ, который может использовать дочерний процесс, прежде чем его заменят новым. Если из-за одной задачи дочерний процесс превысит это ограничение, выполнение задачи будет завершено, после чего дочерний процесс заменят. По умолчанию ограничение отсутствует.

--purge, --discard

-Q, --queues <queues>

-X, --exclude-queues <exclude_queues>

-I, --include <include>

--without-gossip

--without-mingle

--without-heartbeat

--heartbeat-interval <heartbeat_interval>

--autoscale <autoscale>

-B, --beat

-s, --schedule-filename, --schedule <schedule_filename>

--scheduler <scheduler>

-f, --logfile <logfile>

Назначение журнала; по умолчанию — stderr

--pidfile <pidfile>

Путь к файлу PID; по умолчанию файл PID не создается

--uid <uid>

Сменить привилегии на указанный идентификатор пользователя

--gid <gid>

Сменить привилегии на указанный идентификатор группы

--umask <umask>

Создавать файлы и каталоги с указанной маской umask

--executable <executable>

Переопределить путь к исполняемому файлу Python