flower

Real-time monitor and web admin for Celery distributed task queue

https://github.com/mher/flower

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    3 of 213 committers (1.4%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.2%) to scientific vocabulary

Keywords

administration asynchronous celery monitoring python rabbitmq redis task-queue workers

Keywords from Contributors

closember http-client aiohttp http-server fuzzing asyncio unit-testing python39 python313 json-schema
Last synced: 6 months ago · JSON representation

Repository

Real-time monitor and web admin for Celery distributed task queue

Basic Info
Statistics
  • Stars: 6,905
  • Watchers: 141
  • Forks: 1,126
  • Open Issues: 168
  • Releases: 0
Topics
administration asynchronous celery monitoring python rabbitmq redis task-queue workers
Created over 13 years ago · Last pushed 6 months ago
Metadata Files
Readme License

README.rst

Flower
======

.. image:: https://img.shields.io/pypi/dm/flower.svg
    :target: https://pypistats.org/packages/flower
    :alt: PyPI - Downloads
.. image:: https://img.shields.io/docker/pulls/mher/flower.svg
    :target: https://hub.docker.com/r/mher/flower
    :alt: Docker Pulls
.. image:: https://github.com/mher/flower/workflows/Build/badge.svg
    :target: https://github.com/mher/flower/actions
.. image:: https://img.shields.io/pypi/v/flower.svg
    :target: https://pypi.python.org/pypi/flower

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`_

.. _API Reference: https://flower.readthedocs.io/en/latest/api.html

Documentation
-------------

Documentation is available at `Read the Docs`_

.. _Read the Docs: https://flower.readthedocs.io

License
-------

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

.. _`License`: https://github.com/mher/flower/blob/master/LICENSE

Owner

  • Login: mher
  • Kind: user

GitHub Events

Total
  • Create event: 4
  • Issues event: 25
  • Watch event: 436
  • Delete event: 3
  • Member event: 2
  • Issue comment event: 74
  • Push event: 8
  • Pull request review event: 32
  • Pull request review comment event: 23
  • Pull request event: 27
  • Fork event: 50
Last Year
  • Create event: 4
  • Issues event: 25
  • Watch event: 436
  • Delete event: 3
  • Member event: 2
  • Issue comment event: 74
  • Push event: 8
  • Pull request review event: 32
  • Pull request review comment event: 23
  • Pull request event: 27
  • Fork event: 50

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 1,158
  • Total Committers: 213
  • Avg Commits per committer: 5.437
  • Development Distribution Score (DDS): 0.326
Past Year
  • Commits: 3
  • Committers: 3
  • Avg Commits per committer: 1.0
  • Development Distribution Score (DDS): 0.667
Top Committers
Name Email Commits
Mher Movsisyan m****n@g****m 780
Ask Solem a****k@c****g 13
Tomasz Kluczkowski t****1@h****k 10
Ilya Georgievsky i****y@d****m 10
melevir m****r@g****m 9
Tomasz Pazurkiewicz t****z@p****l 7
Janusz Harkot jh@b****l 7
Adam Greig a****m@a****m 5
David Thorman d****n@k****m 5
Leo Singer l****r@l****g 5
Miki Tebeka m****a@g****m 5
Simon Gurcke s****n@g****e 5
Paul p****n@g****m 4
Benjamin Toueg b****g@g****m 4
Christian Clauss c****s@m****m 4
Konstantinos Koukopoulos kk@l****m 4
Balthazar Rouberol b****l@m****m 4
Raghuram Srinivasan r****u@s****v 4
Michael J. Schultz m****z@g****m 3
Matt Hughes h****2@g****m 3
Paul Wise p****3@b****t 3
Luciano Pacheco l****t@g****m 3
Jingyu Zhou z****y@c****n 3
Jet.Z j****g@g****m 3
Bhargav Srinivasan b****5@g****m 3
Rahul Arya r****1@g****m 3
Rob O'Dwyer o****b@g****m 3
Tommaso Barbugli t****i@g****m 3
geoffjukes g****f@j****g 3
mozillazg o****g@g****m 3
and 183 more...

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 213
  • Total pull requests: 107
  • Average time to close issues: about 1 year
  • Average time to close pull requests: 4 months
  • Total issue authors: 204
  • Total pull request authors: 79
  • Average comments per issue: 3.46
  • Average comments per pull request: 1.18
  • Merged pull requests: 35
  • Bot issues: 1
  • Bot pull requests: 1
Past Year
  • Issues: 27
  • Pull requests: 31
  • Average time to close issues: 19 days
  • Average time to close pull requests: 13 days
  • Issue authors: 27
  • Pull request authors: 20
  • Average comments per issue: 0.11
  • Average comments per pull request: 0.48
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 1
Top Authors
Issue Authors
  • themanifold (3)
  • dpdoughe (2)
  • estraph (2)
  • tprynn (2)
  • CharlesFr (2)
  • paulocheque (2)
  • JimScope (2)
  • nirob-appsbee (2)
  • krishnakumar18 (1)
  • philippgoehl (1)
  • hland (1)
  • benjaminh (1)
  • daveisfera (1)
  • yingw787 (1)
  • dependabot[bot] (1)
Pull Request Authors
  • pabs3 (3)
  • cclauss (3)
  • MyeaMKelly (3)
  • rabbit-aaron (2)
  • shuo-heygen (2)
  • jancespivo (2)
  • the-witch-king (2)
  • woutdenolf (2)
  • navvsohal74 (2)
  • mher (2)
  • dpdoughe (2)
  • masahiro331 (2)
  • titovanton (2)
  • auvipy (2)
  • Baghdady92 (2)
Top Labels
Issue Labels
bug (108) enhancement (53) docs (5) question (4) tasks (4) duplicate (3) broker (2) options (1) auth (1) docker (1) api (1) monitor (1) dependencies (1)
Pull Request Labels
dependencies (1) github_actions (1)

Packages

  • Total packages: 9
  • Total downloads:
    • pypi 7,505,440 last-month
  • Total docker downloads: 975,962,788
  • Total dependent packages: 49
    (may contain duplicates)
  • Total dependent repositories: 3,306
    (may contain duplicates)
  • Total versions: 74
  • Total maintainers: 6
  • Total advisories: 2
pypi.org: flower

Celery Flower

  • Versions: 32
  • Dependent Packages: 43
  • Dependent Repositories: 3,295
  • Downloads: 7,505,335 Last month
  • Docker Downloads: 975,962,788
Rankings
Dependent repos count: 0.2%
Downloads: 0.2%
Docker downloads count: 0.3%
Dependent packages count: 0.4%
Stargazers count: 0.4%
Average: 0.5%
Forks count: 1.3%
Maintainers (1)
Last synced: 6 months ago
proxy.golang.org: github.com/mher/flower
  • Versions: 20
  • Dependent Packages: 0
  • Dependent Repositories: 1
Rankings
Forks count: 0.9%
Stargazers count: 0.9%
Average: 4.0%
Dependent repos count: 4.7%
Dependent packages count: 9.6%
Last synced: 6 months ago
conda-forge.org: flower
  • Versions: 10
  • Dependent Packages: 6
  • Dependent Repositories: 3
Rankings
Stargazers count: 4.6%
Forks count: 4.9%
Dependent packages count: 9.0%
Average: 9.1%
Dependent repos count: 18.1%
Last synced: 6 months ago
pypi.org: flower-new

Celery Flower

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 2
  • Downloads: 33 Last month
Rankings
Stargazers count: 0.4%
Forks count: 1.3%
Dependent packages count: 10.1%
Dependent repos count: 11.6%
Average: 11.7%
Downloads: 35.3%
Maintainers (1)
Last synced: 6 months ago
pypi.org: flower-custom

Base Celery Flower 0.9 And Latest Commit

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 11 Last month
Rankings
Stargazers count: 0.4%
Forks count: 1.3%
Dependent packages count: 7.0%
Average: 12.5%
Downloads: 23.7%
Dependent repos count: 30.5%
Maintainers (1)
Last synced: 6 months ago
pypi.org: flower-with-timeline

Celery Flower - with Timeline page

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 22 Last month
Rankings
Stargazers count: 0.4%
Forks count: 1.3%
Dependent packages count: 10.1%
Average: 12.8%
Dependent repos count: 21.6%
Downloads: 30.7%
Maintainers (1)
Last synced: 6 months ago
pypi.org: flowest

Celery Flower

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 17 Last month
Rankings
Stargazers count: 0.4%
Forks count: 1.3%
Dependent packages count: 10.1%
Average: 19.7%
Dependent repos count: 21.6%
Downloads: 65.3%
Maintainers (1)
Last synced: 6 months ago
pypi.org: flower-patch

Celery Flower

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 22 Last month
Rankings
Dependent packages count: 9.0%
Average: 29.8%
Dependent repos count: 50.6%
Maintainers (1)
Last synced: 6 months ago
anaconda.org: flower
  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 3
Rankings
Stargazers count: 10.8%
Forks count: 11.0%
Average: 29.9%
Dependent repos count: 46.6%
Dependent packages count: 51.2%
Last synced: 6 months ago

Dependencies

requirements/default.txt pypi
  • celery >=5.0.5
  • humanize *
  • prometheus_client >=0.8.0
  • pytz *
  • tornado >=5.0.0,<7.0.0
requirements/dev.txt pypi
  • redis <4.0.0 development
requirements/docs.txt pypi
  • Sphinx *
  • sphinxcontrib-fulltoc *
  • sphinxcontrib-httpdomain *
.github/workflows/build.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/docker.yml actions
  • actions/checkout v2 composite
  • docker/build-push-action v2 composite
  • docker/login-action v1 composite
  • docker/metadata-action v3 composite
  • docker/setup-buildx-action v1 composite
  • docker/setup-qemu-action v1 composite
Dockerfile docker
  • python alpine build
docker-compose.yml docker
  • grafana/grafana latest
  • prom/prometheus latest
  • redis alpine
requirements/test.txt pypi
setup.py pypi