This document describes the current stable version of Celery (4.3). For development docs, go here.
celery.bin.events
¶
The celery events command.
See also
See Preload Options and Daemon Options.
-
-d
,
--dump
¶
Dump events to stdout.
-
-c
,
--camera
¶
Take snapshots of events using this camera.
-
--detach
¶
Camera: Detach and run in the background as a daemon.
-
-F
,
--freq
,
--frequency
¶
Camera: Shutter frequency. Default is every 1.0 seconds.
-
-r
,
--maxrate
¶
Camera: Optional shutter rate limit (e.g., 10/m).
-
-l
,
--loglevel
¶
Logging level, choose between DEBUG, INFO, WARNING, ERROR, CRITICAL, or FATAL. Default is INFO.
-
-f
,
--logfile
¶
Path to log file. If no logfile is specified, stderr is used.
-
--pidfile
¶
Optional file used to store the process 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.
-
class
celery.bin.events.
events
(app=None, get_app=None, no_color=False, stdout=None, stderr=None, quiet=False, on_error=None, on_usage_error=None)[source]¶ Event-stream utilities.
Notes
# - Start graphical monitor (requires curses) $ celery events --app=proj $ celery events -d --app=proj # - Dump events to screen. $ celery events -b amqp:// # - Run snapshot camera. $ celery events -c <camera> [options]
Examples
$ celery events $ celery events -d $ celery events -c mod.attr -F 1.0 --detach --maxrate=100/m -l info
-
doc
= u"The :program:`celery events` command.\n\n.. program:: celery events\n\n.. seealso::\n\n See :ref:`preload-options` and :ref:`daemon-options`.\n\n.. cmdoption:: -d, --dump\n\n Dump events to stdout.\n\n.. cmdoption:: -c, --camera\n\n Take snapshots of events using this camera.\n\n.. cmdoption:: --detach\n\n Camera: Detach and run in the background as a daemon.\n\n.. cmdoption:: -F, --freq, --frequency\n\n Camera: Shutter frequency. Default is every 1.0 seconds.\n\n.. cmdoption:: -r, --maxrate\n\n Camera: Optional shutter rate limit (e.g., 10/m).\n\n.. cmdoption:: -l, --loglevel\n\n Logging level, choose between `DEBUG`, `INFO`, `WARNING`,\n `ERROR`, `CRITICAL`, or `FATAL`. Default is INFO.\n\n.. cmdoption:: -f, --logfile\n\n Path to log file. If no logfile is specified, `stderr` is used.\n\n.. cmdoption:: --pidfile\n\n Optional file used to store the process pid.\n\n The program won't start if this file already exists\n and the pid is still alive.\n\n.. cmdoption:: --uid\n\n User id, or user name of the user to run as after detaching.\n\n.. cmdoption:: --gid\n\n Group id, or group name of the main group to change to after\n detaching.\n\n.. cmdoption:: --umask\n\n Effective umask (in octal) of the process after detaching. Inherits\n the umask of the parent process by default.\n\n.. cmdoption:: --workdir\n\n Optional directory to change to after detaching.\n\n.. cmdoption:: --executable\n\n Executable to use for the detached process.\n"¶
-
run
(dump=False, camera=None, frequency=1.0, maxrate=None, loglevel=u'INFO', logfile=None, prog_name=u'celery events', pidfile=None, uid=None, gid=None, umask=None, workdir=None, detach=False, **kwargs)[source]¶
-
run_evcam
(camera, logfile=None, pidfile=None, uid=None, gid=None, umask=None, workdir=None, detach=False, **kwargs)[source]¶
-
supports_args
= False¶
-