Celery Flower
Project description
Flower is a web based tool for monitoring and administrating Celery clusters.
Features
Real-time monitoring using Celery Events
Task progress and history
Ability to show task details (arguments, start time, runtime, and more)
Graphs and statistics
Remote Control
View worker status and statistics
Shutdown and restart worker instances
Control worker pool size and autoscale settings
View and modify the queues a worker instance consumes from
View currently running tasks
View scheduled tasks (ETA/countdown)
View reserved and revoked tasks
Apply time and rate limits
Configuration viewer
Revoke or terminate tasks
Broker monitoring
View statistics for all Celery queues
Queue length graphs
HTTP API
Basic Auth and Google OpenID authentication
API
Flower API enables to manage the cluster via REST API, call tasks and receive task events in real-time via WebSockets.
For example you can restart worker’s pool by:
$ curl -X POST http://localhost:5555/api/worker/pool/restart/myworker
Or call a task by:
$ curl -X POST -d '{"args":[1,2]}' http://localhost:5555/api/task/async-apply/tasks.add
Or terminate executing task by:
$ curl -X POST -d 'terminate=True' http://localhost:5555/api/task/revoke/8a4da87b-e12b-4547-b89a-e92e4d1f8efd
Or receive task completion events in real-time:
var ws = new WebSocket('ws://localhost:5555/api/task/events/task-succeeded/');
ws.onmessage = function (event) {
console.log(event.data);
}For more info checkout API Reference and examples.
Installation
PyPI version:
$ pip install flower
Development version:
$ pip install https://github.com/mher/flower/zipball/master
Usage
Launch the server and open http://localhost:5555:
$ flower --port=5555
Or launch from celery:
$ celery flower -A proj --address=127.0.0.1 --port=5555
Broker URL and other configuration options can be passed through the standard Celery options:
$ celery flower -A proj --broker=amqp://guest:guest@localhost:5672//
Or run with unix socket file:
$ flower --unix_socket=/tmp/flower.sock
Documentation
Documentation is available at Read the Docs and IPython Notebook Viewer
License
Flower is licensed under BSD 3-Clause License. See the LICENSE file in the top distribution directory for the full license text.
Getting help
Please head over to #celery IRC channel on irc.freenode.net or open an issue.
Contributing
If you’d like to contribute, simply fork the repository, commit your changes, run the tests (python -m tests) and send a pull request. Make sure you add yourself to CONTRIBUTORS.
If you are interested in maintaining the project please contact.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file flower-0.9.0.tar.gz.
File metadata
- Download URL: flower-0.9.0.tar.gz
- Upload date:
- Size: 3.9 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9011f792a1e2d24185a0ab2923a29db7e5e018adc988b81712d53f2295cb4b82 |
|
| MD5 | 8727f6a1be60475b18485626601b75f9 |
|
| BLAKE2b-256 | 4c07610f5386075db78dc6f5d936b12ec51b5010650bd1db487040259af5ef90 |
