Git Product home page Git Product logo

flower's Introduction

Celery Flower

image

image

image

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

For more info checkout API Reference and examples.

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

Or launch from celery: :

$ celery flower -A proj --address=127.0.0.1 --port=5555

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

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

Or run with unix socket file: :

$ flower --unix_socket=/tmp/flower.sock

Documentation

Documentation is available at Read the Docs and IPython Notebook Viewer

License

Flower is licensed under BSD 3-Clause License. See the LICENSE file in the top distribution directory for the full license text.

Getting help

Please head over to #celery IRC channel on irc.freenode.net or open an issue.

Contributing

If you'd like to contribute, simply fork the repository, commit your changes, run the tests (python -m tests) and send a pull request. Make sure you add yourself to CONTRIBUTORS.

If you are interested in maintaining the project please contact.

flower's People

Contributors

mher avatar ask avatar igeorgievsky avatar melevir avatar jerzyk avatar pazur avatar tebeka avatar david-thorman avatar adamgreig avatar btoueg avatar kouk avatar asmodehn avatar alexferl avatar mozillazg avatar geoffjukes avatar tbarbugli avatar robbles avatar mjschultz avatar hughes avatar lucmult avatar jzhou77 avatar jetz avatar audriusbutkevicius avatar rorito avatar saifelse avatar prmtl avatar systemsoverload avatar tjanez avatar morty avatar yulis avatar

Watchers

Liubq avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.