Skip to main content

Celery Flower

Project description

Flowest

support support support support

This repo is a fork of https://github.com/mher/flower. It integreates new features that are not yet merge to the flower branch and in general will be more active than the original flower repo.

Where to get it

Docker images

DockerHub repo

docker image pull

Github repo (latest only)

You can use docker image:

docker image pull

Install with pip from pypi

If you want to install it from pypi

pip install flowest

Build from source

git clone
pip install -r
setup.py install

support

If you need help you can get support on gitter: https://gitter.im/python-flowest/support

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.

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.

All changes made by Gabriel-Desharnais are under MIT license

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 and send a pull request. If you are interested in maintaining the project please contact.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flowest-1.0.0.tar.gz (1.3 MB view hashes)

Uploaded Source

Built Distribution

flowest-1.0.0-py2.py3-none-any.whl (456.3 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page