Skip to main content

Celery Flower

Project description

Flower is a web based tool for monitoring and administrating Celery clusters.

Features

  • Shutdown or restart workers

  • View workers status (completed, running tasks, etc.)

  • View worker pool options (timeouts, processes, etc.)

  • Control worker pool size

  • View message broker options

  • View active queues, add or cancel queues

  • View processed task stats by type

  • View currently running tasks

  • View scheduled tasks

  • View reserved and revoked tasks

  • Apply time and rate limits

  • View all active configuration options

  • View all tasks (by type, by worker, etc.)

  • View all task options (arguments, start time, runtime, etc.)

  • Revoke or terminate tasks

  • View real-time execution graphs

API

Flower API enables to control the cluster via REST api 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 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 --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.3.1.tar.gz (235.2 kB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for flower-0.3.1.tar.gz
Algorithm Hash digest
SHA256 edba0793ccfcfdebc1bb361db9bf6c0d231d81c1e146efdb0928614d8e8e6819
MD5 36b87f504fe159c2a334a18b9b28cab4
BLAKE2b-256 b809e813bdbb92d55049fb1f283264b3bafd4dae66ae2b093cbb4103c6bf53d8

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