Skip to main content
PyPI - Downloads Docker Pulls https://github.com/mher/flower/workflows/Build/badge.svg https://img.shields.io/pypi/v/flower.svg

Flower is an open-source web application for monitoring and managing Celery clusters. It provides real-time information about the status of Celery workers and tasks.

Features

  • Real-time monitoring using Celery Events
    • View task progress and history

    • View task details (arguments, start time, runtime, and more)

  • 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

    • Revoke or terminate tasks

  • Broker monitoring
    • View statistics for all Celery queues

  • HTTP Basic Auth, Google, Github, Gitlab and Okta OAuth

  • Prometheus integration

  • API

Installation

Installing flower with pip is simple

$ pip install flower

The development version can be installed from Github

$ pip install https://github.com/mher/flower/zipball/master#egg=flower

Usage

To run Flower, you need to provide the broker URL

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

Or use the configuration of celery application

$ celery -A tasks.app flower

By default, flower runs on port 5555, which can be modified with the port option

$ celery -A tasks.app flower --port=5001

You can also run Flower using the docker image

$ docker run -v examples:/data -p 5555:5555 mher/flower celery --app=tasks.app flower

In this example, Flower is using the tasks.app defined in the examples/tasks.py file

API

Flower API enables to manage the cluster via HTTP REST API.

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

For more info checkout API Reference

Documentation

Documentation is available at Read the Docs

License

Flower is licensed under BSD 3-Clause License. See the License file for the full license text.

Download files

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

Source Distribution

flower-2.1.0.tar.gz (3.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flower-2.1.0-py2.py3-none-any.whl (404.6 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: flower-2.1.0.tar.gz
  • Upload date:
  • Size: 3.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.14.3

File hashes

Hashes for flower-2.1.0.tar.gz
Algorithm Hash digest
SHA256 ece79fd190bfd198947e30470c4b26a6d5df1861d54309430dd926ed516302ff
MD5 d52a8a6b9e17a7784a9ee14c0200e06e
BLAKE2b-256 fd9fe3061a153ba1928a96cf1a431449411ff4a9411465d1554fdcd0feb8d239

See more details on using hashes here.

File details

Details for the file flower-2.1.0-py2.py3-none-any.whl.

File metadata

  • Download URL: flower-2.1.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 404.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.14.3

File hashes

Hashes for flower-2.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2f433aaee3efeba5b844b2ab7371f16058d892de76156b77e6d09de03a4095bc
MD5 57d9d59c68eec56f607b707d66f21f39
BLAKE2b-256 6787cd70fe77cb5ad4a79eaebe7d86d15efd8b1d950f8d0ab99470a4fd21c9a8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page