Skip to main content

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

Project description

Introduction

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

Build Pull Request Publish Release Python Support PyPI Downloads

Maturity notes

The RQ dashboard is currently being developed and is in beta stage. How migrate to version 1.0 you can find here

You can find help in the discussion page in github or join our discord server

Installing with Docker

You can also run the dashboard inside of docker:

  • copy the docker-compose.yml file from the root of the repository to docker-compose.override.yml and change the environment variables to your liking.

  • run the following command:

    $ docker-compose up
    

You can also find the official image on cjlapao/rq-dashboard:latest

Installing from PyPI

$ pip install rq-dashboard

Running the dashboard

Run the dashboard standalone, like this:

$ rq-dashboard
* Running on http://127.0.0.1:9181/
...
$ rq-dashboard --help
Usage: rq-dashboard [OPTIONS]

  Run the RQ Dashboard Flask server.

  All configuration can be set on the command line or through environment
  variables of the form RQ_DASHBOARD_*. For example RQ_DASHBOARD_USERNAME.

  A subset of the configuration (the configuration parameters used by the
  underlying flask blueprint) can also be provided in a Python module
  referenced using --config, or with a .cfg file referenced by the
  RQ_DASHBOARD_SETTINGS environment variable.

Options:
  -b, --bind TEXT                 IP or hostname on which to bind HTTP server
  -p, --port INTEGER              Port on which to bind HTTP server
  --url-prefix TEXT               URL prefix e.g. for use behind a reverse
                                  proxy
  --username TEXT                 HTTP Basic Auth username (not used if not
                                  set)
  --password TEXT                 HTTP Basic Auth password
  -c, --config TEXT               Configuration file (Python module on search
                                  path)
  -u, --redis-url TEXT            Redis URL. Can be specified multiple times.
                                  Default: redis://127.0.0.1:6379
  --poll-interval, --interval INTEGER
                                  Refresh interval in ms
  --extra-path TEXT               Append specified directories to sys.path
  --disable-delete                Disable delete jobs, clean up registries
  --debug / --normal              Enter DEBUG mode
  -v, --verbose                   Enable verbose logging
  -j, --json                      Enable JSONSerializer
  --help                          Show this message and exit.

Integrating the dashboard in your Flask app

The dashboard can be integrated in to your own Flask app by accessing the blueprint directly in the normal way, e.g.:

from flask import Flask
import rq_dashboard

app = Flask(__name__)
app.config.from_object(rq_dashboard.default_settings)
rq_dashboard.web.setup_rq_connection(app)
app.register_blueprint(rq_dashboard.blueprint, url_prefix="/rq")

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

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

If you start the Flask app on the default port, you can access the dashboard at http://localhost:5000/rq. The cli.py:main entry point provides a simple working example.

Running on Heroku

Consider using third-party project rq-dashboard-on-heroku, which installs rq-dashboard from PyPI and wraps in in Gunicorn for deployment to Heroku. rq-dashboard-on-heroku is maintained indepdently.

Running behind a Reverse Proxy

You can run the dashboard as a systemd service in Linux or via a suprevisor script and then use Apache or NGINX to direct traffic to the dashboard.

This is for non-production functionality!

Apache Reverse Proxy example:

ProxyPass /rq http://127.0.0.1:5001/rq
ProxyPassReverse /rq http://127.0.0.1:5001/rq

Systemd service example:

[Unit]
Description=Redis Queue Dashboard
[Install]

WantedBy=multi-user.target
[Service]
ExecStart=/bin/rq-dashboard -b 127.0.0.1 -p 5001 --url-prefix /rq -c rq_settings_dashboard --debug -v
StandardOutput=file:/var/log/redis/rq-dasbhoard.log
StandardError=file:/var/log/redis/rq-dashboard.log
User=redis-dash
Group=redis-dash
RemainAfterExit=yes
Type=simple
PermissionsStartOnly=false
PrivateTmp=no
  • --debug,-v are optional -- they will write stdout to your specified files.
  • rq_settings_dashboard is a Python file, with settings defined. You can use options that are available as environmental variables. (EX. RQ_DASHBOARD_REDIS_PASSWORD = password)

Developing

Develop in a virtualenv and make sure you have all the necessary build time (and run time) dependencies with

$ pip install -r requirements.txt

Develop in the normal way with

$ python setup.py develop

Stats

Download files

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

Source Distribution

rq_dashboard-0.8.2.2.tar.gz (205.9 kB view details)

Uploaded Source

Built Distribution

rq_dashboard-0.8.2.2-py2.py3-none-any.whl (210.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file rq_dashboard-0.8.2.2.tar.gz.

File metadata

  • Download URL: rq_dashboard-0.8.2.2.tar.gz
  • Upload date:
  • Size: 205.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for rq_dashboard-0.8.2.2.tar.gz
Algorithm Hash digest
SHA256 7fc1655a41e52087c221e3df76a91e5785122d98e31f1facfc399dcede80e1c2
MD5 edb7cc8efd39619dc0bf0167675e3de3
BLAKE2b-256 b4738e1c2fcae9ecaf79e743ea23d66837f1273740fa9fd43dc19ef87d7ea724

See more details on using hashes here.

Provenance

File details

Details for the file rq_dashboard-0.8.2.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for rq_dashboard-0.8.2.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 764d1c6fe415b749444aec7e7bd01e72f09423fced9ecd41802853cbbfa1f382
MD5 95dd4b2bd28708a01d8c3ca6d0c2dff2
BLAKE2b-256 53d8a15faefd6a93c2c03796a76e80739c9f12e1c0d25786e2bfcb6b976483cf

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page