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.

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

$ pip install rq-dashboard-fast

Running in Docker

You can run the RQ Dashboard FastAPI as a Docker container with custom Redis URL and port:

docker run -p 8000:8000 -e REDIS_URL=<your_redis_url> -e FASTAPI_PORT=<your_fastapi_port> hannescode/rq-dashboard-fast

Replace <your_redis_url> with your desired Redis URL and <your_fastapi_port> with your desired FastAPI port.

Alternatively, you can use Docker Compose by creating a docker-compose.yml file:

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

Replace <your_redis_url> and <your_fastapi_port> with your desired Redis URL and FastAPI port. Then run:

docker-compose up

Access the Dashboard at

http://127.0.0.1:<your_fastapi_port>/rq

Docker Hub: https://hub.docker.com/r/hannes221/rq-dashboard-fast

Next Features

  • Docker Image
  • 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.2.3.tar.gz (11.5 kB view hashes)

Uploaded Source

Built Distribution

rq_dashboard_fast-0.2.3-py3-none-any.whl (16.5 kB view hashes)

Uploaded Python 3

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