Flask-based web front-end for monitoring RQ queues.
JavaScript Python
Switch branches/tags
Nothing to show
Pull request Compare This branch is 148 commits behind eoranged:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
rq_dashboard
.gitignore
LICENSE
MANIFEST.in
README.md
requirements.txt
setup.cfg
setup.py

README.md

rq-dashboard is a general purpose, lightweight, Flask-based web front-end to monitor your RQ queues, jobs, and workers in realtime.

It looks like this

Installing

$ pip install rq-dashboard

Running the dashboard

You can either run the dashboard standalone, like this...

$ rq-dashboard
* Running on http://127.0.0.1:9181/
* Restarting with reloader
...

Integrating the dashboard in your Flask app

...or you can integrate the dashboard in your own Flask app, like this:

from flask import Flask
from rq_dashboard import RQDashboard


app = Flask(__name__)
RQDashboard(app)

@app.route("/")
def hello():
    return "Hello World!"

if __name__ == "__main__":
    app.run()

This will register the dashboard on the /rq URL root in your Flask app. To use a different URL root, use the following:

RQDashboard(app, url_prefix='/some/other/url')

Maturity notes

The RQ dashboard is currently being developed and is in beta stage. It is currently not possible to run RQ dashboard against anything but the default (localhost) Redis connections. (Patches welcome :))