Flower
======
.. 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
.. image:: https://travis-ci.org/mher/flower.svg?branch=master
:target: https://travis-ci.org/mher/flower
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, Google, Github, Gitlab and Okta OAuth
- Prometheus integration
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
Launch from celery: ::
$ celery flower -A proj --address=127.0.0.1 --port=5555
Launch using docker: ::
$ docker run -p 5555:5555 mher/flower
Launch with unix socket file: ::
$ flower --unix-socket=/tmp/flower.sock
Broker URL and other configuration options can be passed through the standard Celery options: ::
$ celery flower -A proj --broker=amqp://guest:guest@localhost:5672//
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`_.
.. _API Reference: https://flower.readthedocs.io/en/latest/api.html
.. _examples: http://nbviewer.ipython.org/urls/raw.github.com/mher/flower/master/docs/api.ipynb
Documentation
-------------
Documentation is available at `Read the Docs`_ and `IPython Notebook Viewer`_
.. _Read the Docs: https://flower.readthedocs.io
.. _IPython Notebook Viewer: http://nbviewer.ipython.org/urls/raw.github.com/mher/flower/master/docs/api.ipynb
License
-------
Flower is licensed under BSD 3-Clause License. See the LICENSE file
in the top distribution directory for the full license text.
Raw data
{
"_id": null,
"home_page": "https://github.com/mher/flower",
"name": "flower-custom",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Mher Movsisyan",
"author_email": "mher.movsisyan@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/30/a6/45a44f349de932317c458ec3ddda1de65af5d2670d6e728f589e7e5e6627/flower-custom-1.2.2.tar.gz",
"platform": null,
"description": "Flower\n======\n\n.. image:: https://github.com/mher/flower/workflows/Build/badge.svg\n :target: https://github.com/mher/flower/actions\n\n.. image:: https://img.shields.io/pypi/v/flower.svg\n :target: https://pypi.python.org/pypi/flower\n\n.. image:: https://travis-ci.org/mher/flower.svg?branch=master\n :target: https://travis-ci.org/mher/flower\n\nFlower is a web based tool for monitoring and administrating Celery clusters.\n\nFeatures\n--------\n\n- Real-time monitoring using Celery Events\n\n - Task progress and history\n - Ability to show task details (arguments, start time, runtime, and more)\n - Graphs and statistics\n\n- Remote Control\n\n - View worker status and statistics\n - Shutdown and restart worker instances\n - Control worker pool size and autoscale settings\n - View and modify the queues a worker instance consumes from\n - View currently running tasks\n - View scheduled tasks (ETA/countdown)\n - View reserved and revoked tasks\n - Apply time and rate limits\n - Configuration viewer\n - Revoke or terminate tasks\n\n- Broker monitoring\n\n - View statistics for all Celery queues\n - Queue length graphs\n\n- HTTP API\n- Basic Auth, Google, Github, Gitlab and Okta OAuth\n- Prometheus integration\n\nInstallation\n------------\n\nPyPI version: ::\n\n $ pip install flower\n\nDevelopment version: ::\n\n $ pip install https://github.com/mher/flower/zipball/master\n\nUsage\n-----\n\nLaunch the server and open http://localhost:5555: ::\n\n $ flower --port=5555\n\nLaunch from celery: ::\n\n $ celery flower -A proj --address=127.0.0.1 --port=5555\n\nLaunch using docker: ::\n\n $ docker run -p 5555:5555 mher/flower\n\nLaunch with unix socket file: ::\n\n $ flower --unix-socket=/tmp/flower.sock\n\nBroker URL and other configuration options can be passed through the standard Celery options: ::\n\n $ celery flower -A proj --broker=amqp://guest:guest@localhost:5672//\n\nAPI\n---\n\nFlower API enables to manage the cluster via REST API, call tasks and\nreceive task events in real-time via WebSockets.\n\nFor example you can restart worker's pool by: ::\n\n $ curl -X POST http://localhost:5555/api/worker/pool/restart/myworker\n\nOr call a task by: ::\n\n $ curl -X POST -d '{\"args\":[1,2]}' http://localhost:5555/api/task/async-apply/tasks.add\n\nOr terminate executing task by: ::\n\n $ curl -X POST -d 'terminate=True' http://localhost:5555/api/task/revoke/8a4da87b-e12b-4547-b89a-e92e4d1f8efd\n\nOr receive task completion events in real-time: ::\n\n var ws = new WebSocket(\"ws://localhost:5555/api/task/events/task-succeeded/\");\n ws.onmessage = function (event) {\n console.log(event.data);\n }\n\nFor more info checkout `API Reference`_ and `examples`_.\n\n.. _API Reference: https://flower.readthedocs.io/en/latest/api.html\n.. _examples: http://nbviewer.ipython.org/urls/raw.github.com/mher/flower/master/docs/api.ipynb\n\nDocumentation\n-------------\n\nDocumentation is available at `Read the Docs`_ and `IPython Notebook Viewer`_\n\n.. _Read the Docs: https://flower.readthedocs.io\n.. _IPython Notebook Viewer: http://nbviewer.ipython.org/urls/raw.github.com/mher/flower/master/docs/api.ipynb\n\nLicense\n-------\n\nFlower is licensed under BSD 3-Clause License. See the LICENSE file\nin the top distribution directory for the full license text.\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "Base Celery Flower 0.9 And Latest Commit",
"version": "1.2.2",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "30a645a44f349de932317c458ec3ddda1de65af5d2670d6e728f589e7e5e6627",
"md5": "e6ef3ecd67a975c334dad30b94223892",
"sha256": "299bd528283decb357436f6bfd61894c896b7f2bd4fbee4860c7f0e380397de0"
},
"downloads": -1,
"filename": "flower-custom-1.2.2.tar.gz",
"has_sig": false,
"md5_digest": "e6ef3ecd67a975c334dad30b94223892",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1250755,
"upload_time": "2023-02-03T05:51:56",
"upload_time_iso_8601": "2023-02-03T05:51:56.436304Z",
"url": "https://files.pythonhosted.org/packages/30/a6/45a44f349de932317c458ec3ddda1de65af5d2670d6e728f589e7e5e6627/flower-custom-1.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-03 05:51:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "mher",
"github_project": "flower",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "flower-custom"
}
JSON
