Skip to main content

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

  • 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);
}

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 --address=127.0.0.1 --port=5555

Broker URL and other configuration options can be passed through the standard Celery options:

$ celery flower --broker=amqp://guest:guest@localhost:5672//

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.

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.5.0.tar.gz (277.0 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: flower-0.5.0.tar.gz
  • Upload date:
  • Size: 277.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for flower-0.5.0.tar.gz
Algorithm Hash digest
SHA256 ae01cfa0872f11eea12b39e78906c039bd0696fed10210c492343242e17bef7f
MD5 1dd3b47c11e3aa323e194fd3f9f0275b
BLAKE2b-256 39b2e61c605a4122edf5bb1e8de681b3e28a3155b7ca0da70a8fbb79d57adcfd

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