bin.beat

The celery beat command.

See also

See preload-options and Daemon Options.

--detach

Detach and run in the background as a daemon.

-s, --schedule

Path to the schedule database. Defaults to celerybeat-schedule. The extension ‘.db’ may be appended to the filename. Default is {default}.

-S, --scheduler

Scheduler class to use. Default is {default}.

--max-interval

Max seconds to sleep between schedule iterations.

-f, --logfile

Path to log file. If no logfile is specified, stderr is used.

-l, --loglevel

Logging level, choose between DEBUG, INFO, WARNING, ERROR, CRITICAL, or FATAL.

--pidfile

File used to store the process pid. Defaults to celerybeat.pid.

The program won’t start if this file already exists and the pid is still alive.

--uid

User id, or user name of the user to run as after detaching.

--gid

Group id, or group name of the main group to change to after detaching.

--umask

Effective umask (in octal) of the process after detaching. Inherits the umask of the parent process by default.

--workdir

Optional directory to change to after detaching.

--executable

Executable to use for the detached process.

Module Contents

Classes

beat() Start the beat periodic task scheduler.

Functions

main(app=None)
class beat

Start the beat periodic task scheduler.

Examples:
$ celery beat -l info
$ celery beat -s /var/run/celery/beat-schedule --detach
$ celery beat -S django

The last example requires the :pypi:`django-celery-beat` extension package found on PyPI.

run(detach=False, logfile=None, pidfile=None, uid=None, gid=None, umask=None, workdir=None, **kwargs)
add_arguments(parser)
main(app=None)