Skip to main content

Celery Flower

Project description

https://img.shields.io/pypi/v/flower.svg https://img.shields.io/pypi/dm/flower.svg https://travis-ci.org/mher/flower.svg?branch=master

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

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.

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

flower-0.8.3.tar.gz (2.2 MB view details)

Uploaded Source

File details

Details for the file flower-0.8.3.tar.gz.

File metadata

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

File hashes

Hashes for flower-0.8.3.tar.gz
Algorithm Hash digest
SHA256 ca6ae26361e58491d51eaded0ee7134087f4ea3cdd00ac158d903dc02dd0e85b
MD5 09d4dec422ed6c4a10584b5fce6008d6
BLAKE2b-256 8fa40be647c97c465d91864b704008304991412f5664e94646b8066ba83e7525

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