RQ Dashboard FastAPI 使用教程

1. 项目介绍

RQ Dashboard FastAPI 是一个基于 FastAPI 的通用、轻量级网页前端，用于实时监控 RQ 队列、任务和工作者。该项目的目标是简化与 FastAPI 应用的集成，并提供一个方便的 Docker 镜像。

2. 项目快速启动

安装

首先，确保你已经安装了 Python 环境。然后，通过以下命令安装 RQ Dashboard FastAPI：

pip install rq-dashboard-fast

运行

在你的 FastAPI 应用中，按照以下方式集成 RQ Dashboard：

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)

启动你的 FastAPI 应用后，你可以通过浏览器访问 http://127.0.0.1:8000/rq 来查看 RQ Dashboard。

使用 Docker

你也可以使用 Docker 来运行 RQ Dashboard。首先，设置你的 Redis URL，然后运行以下命令：

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

如果你需要改变端口，可以使用以下命令：

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

使用 Docker Compose 的话，创建一个 docker-compose.yml 文件：

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

然后，运行以下命令启动服务：

docker compose up

3. 应用案例和最佳实践

在集成 RQ Dashboard 到你的 FastAPI 应用时，最佳实践是将 Dashboard 挂载到一个独立的路由，如上述示例中的 /rq。这样可以保持你的应用结构的清晰，并允许你在需要时轻松地访问 Dashboard。

一个实际应用案例可能包括实时监控后台任务队列，以便及时了解任务状态和工作者性能。

4. 典型生态项目

RQ Dashboard FastAPI 是 RQ (Redis Queue) 生态系统的一部分。以下是一些与之相关的典型项目：

• RQ: Python 的 Redis 队列库，用于管理后台任务。
• rq-scheduler: RQ 的扩展，用于定期调度任务。
• FastAPI: 一个现代、快速（高性能）的 Web 框架，用于构建 API，与 RQ Dashboard FastAPI 集成。

通过结合这些项目，可以构建一个强大的异步任务处理系统，并通过 RQ Dashboard FastAPI 进行监控。