Skip to main content

Celery Flower

Project description

https://badge.fury.io/py/flower.png https://travis-ci.org/mher/flower.png?branch=master https://pypip.in/d/flower/badge.png

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

To install, simply:

$ pip install flower

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//

Documentation

Documentation is available at Read the Docs and IPython Notebook Viewer

Screenshots

https://raw.github.com/mher/flower/master/docs/screenshots/dashboard.png https://raw.github.com/mher/flower/master/docs/screenshots/pool.png https://raw.github.com/mher/flower/master/docs/screenshots/tasks.png https://raw.github.com/mher/flower/master/docs/screenshots/task.png https://raw.github.com/mher/flower/master/docs/screenshots/monitor.png

More screenshots

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 AUTHORS.

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

flower-new-0.8.0.tar.gz (1.2 MB view details)

Uploaded Source

Built Distributions

flower_new-0.8.0-py2.py3-none-any.whl (321.4 kB view details)

Uploaded Python 2 Python 3

flower_new-0.8.0-py2-none-any.whl (321.4 kB view details)

Uploaded Python 2

File details

Details for the file flower-new-0.8.0.tar.gz.

File metadata

  • Download URL: flower-new-0.8.0.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for flower-new-0.8.0.tar.gz
Algorithm Hash digest
SHA256 4fa2dd474559ab862b4b2fc3854272fa664e309fb29005c10c9c73b4427d8b17
MD5 47c3efe0cc30e20e4331efa93442a662
BLAKE2b-256 c9ab12b5aee846a45d6b8450d3ee7156d719f9a57dc4ec32b4fbe96b6211c48e

See more details on using hashes here.

File details

Details for the file flower_new-0.8.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for flower_new-0.8.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 074c5caea64874a342b0a38a17ae7b421c5b485696b5b604ed50d7715da366a6
MD5 d80d8714bab7758e03a23261dd7ae887
BLAKE2b-256 c9dc48a1b0a5dc97841599c75894e094f65d1f15a9e7a5646cb1d19d5d444062

See more details on using hashes here.

File details

Details for the file flower_new-0.8.0-py2-none-any.whl.

File metadata

File hashes

Hashes for flower_new-0.8.0-py2-none-any.whl
Algorithm Hash digest
SHA256 23b1b6b8f20469052528f7b802cfdf1d153b875be8b2ab3015e70a499ebdb28e
MD5 1454de9ae90b5553df37c78c1f943fcc
BLAKE2b-256 611809189008ef9c6bbdee03ac9a70702b6ef68959898591df959f9aff9007e1

See more details on using hashes here.

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