Skip to main content

rq-dashboard-fast is a FastAPI-based dashboard to monitor your Redis-Queue (RQ) Jobs, Queues, and Workers

Project description

RQ Dashboard FastAPI 🛠

Redis FastAPI Python

RQ Dashboard FastAPI is a general purpose, lightweight FastAPI-based web frontend to monitor your RQ queues, jobs, and workers in real-time. Goal of this package is to ease integration into FastAPI-Applications and provide a Docker Image for convenience.

Screenshot 2024-02-09 at 18 14 13

Featured in Related Projects Redis Queue Docs

Example Usage

from fastapi import FastAPI
from rq_dashboard_fast import RedisQueueDashboard
import uvicorn

app = FastAPI()
dashboard = RedisQueueDashboard(redis://redis:6379/, "/rq")

app.mount(/rq, dashboard)

if __name__ == "__main__":
    uvicorn.run(app, host="0.0.0.0", port=8000)

Access the Dashboard at

http://127.0.0.1:8000/rq

Installing from PyPi

PyPi: rq-dashboard-fast

$ pip install rq-dashboard-fast

Running in Docker

  1. You can run the RQ Dashboard FastAPI as a Docker container with custom Redis URL:
docker run -e REDIS_URL=<your_redis_url> hannes221/rq-dashboard-fast

Access the Dashboard at

http://127.0.0.1:8000/rq

To change change the port, you can specify the following flag:

docker run -e REDIS_URL=<your_redis_url>  -e FASTAPI_PORT=<your_fastapi_port> hannes221/rq-dashboard-fast

Replace <your_fastapi_port> with your desired FastAPI and host port.

  1. You can use Docker Compose by creating a docker-compose.yml file:
version: '3.11'
services:
  dashboard:
    image: hannes221/rq-dashboard-fast
    ports:
      - '8000:8000'
    environment:
      - REDIS_URL=<your_redis_url>

Then run:

docker compose up

Access the Dashboard at

http://127.0.0.1:8000/rq

To change the part update the compose file:

version: '3.11'
services:
  dashboard:
    image: hannes221/rq-dashboard-fast
    ports:
      - '<your_fastapi_port>:<your_fastapi_port>'
    environment:
      - REDIS_URL=<your_redis_url>
      - FASTAPI_PORT=<your_fastapi_port>

Replace <your_fastapi_port> with your desired FastAPI and host port.

Docker Hub: hannes221/rq-dashboard-fast

Github Repository

Github: rq-dashboard-fast

$ pip install rq-dashboard-fast

Planned Features

  • Data from rq-scheduler
  • More data about workers
  • Docker Image
  • Add pagination to jobs page
  • Data Export
  • Statistics Tab
  • Run Standalone (Terminal)

Contributing

If you want to contribute, reach out or create a PR directly.

Project details


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_fast-0.5.9.tar.gz (15.9 kB view details)

Uploaded Source

Built Distribution

rq_dashboard_fast-0.5.9-py3-none-any.whl (21.6 kB view details)

Uploaded Python 3

File details

Details for the file rq_dashboard_fast-0.5.9.tar.gz.

File metadata

  • Download URL: rq_dashboard_fast-0.5.9.tar.gz
  • Upload date:
  • Size: 15.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for rq_dashboard_fast-0.5.9.tar.gz
Algorithm Hash digest
SHA256 1103983c04d1a1b46263af2373192994289f12f4ff6aceefa55cf5c33dc0102a
MD5 cb13328c6ff172d25a0f788058ed6393
BLAKE2b-256 2ef183d56d1d4746a43d7626ce92c928c2f1c4d52d10db9c1cdad9092b68a45e

See more details on using hashes here.

File details

Details for the file rq_dashboard_fast-0.5.9-py3-none-any.whl.

File metadata

File hashes

Hashes for rq_dashboard_fast-0.5.9-py3-none-any.whl
Algorithm Hash digest
SHA256 411f57b3ece887b1d2853c52c1c1a70388f8104ff3969cefa0a686e0c9245484
MD5 faf39dcdc04c5c5aaa30fe5a73983324
BLAKE2b-256 d2fb120b87ed9f57fa57ddfee7ab029ac1e96479f9778e4a93d8c44b91482317

See more details on using hashes here.

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