agenda/agendash

Agendash

Agenda的Web仪表板，用于直观管理Agenda任务队列。

核心功能与特性

• 作业状态自动刷新：默认60秒轮询更新作业状态
• UI调度新作业：通过界面直接创建新任务
• 作业详情查看：可查看作业的JSON数据等详细信息
• 作业重新排队：复制作业数据并立即运行
• 作业删除：清理旧的已完成作业
• 多条件搜索：支持按名称、元数据搜索，可查询Mongo Object Id
• 分页功能：便于浏览大量作业
• 响应式UI：适配各种设备屏幕

使用场景与适用范围

适用于需要监控和管理Agenda任务队列的开发者和系统管理员。可集成到Express、Hapi、Koa等Web框架，或作为独立应用运行，帮助用户实时掌握作业状态并进行高效管理。

安装

bash
npm install --save agendash

注意：Agendash需要MongoDB版本>2.6.0以执行所需的聚合查询。这是指Mongo数据库版本，而非Node包版本！要检查数据库版本，连接Mongo后运行db.version()。

使用方法

中间件使用

Express

Agendash提供Express中间件，可挂载到指定路径。例如，以下配置将Agendash部署在/dash路径下（注意：不要将Agendash挂载到根路径，如app.use('/', Agendash(agenda))）：

js
var express = require("express");
var app = express();

// ... 其他Express中间件（如body-parser）

var Agenda = require("agenda");
var Agendash = require("agendash");

var agenda = new Agenda({ db: { address: "mongodb://127.0.0.1/agendaDb" } });
// 或提供自定义Mongo客户端：
// var agenda = new Agenda({mongo: myMongoClient})

app.use("/dash", Agendash(agenda));

// ... 其他路由

// ... 启动服务器

可通过中间件为Agendash路径添加认证，例如使用passport实现管理员权限控制：

js
app.use(
  "/dash",
  function (req, res, next) {
    if (!req.user || !req.user.is_admin) {
      res.send(401);
    } else {
      next();
    }
  },
  Agendash(agenda)
);

其他中间件（如connect）可通过以下方式使用：

js
app.use(
  "/agendash",
  Agendash(agenda, {
    middleware: "connect",
  })
);

注意：如果使用CSRF保护中间件（如csurf），可能需要为Agendash路由禁用该保护。

Hapi

使用Hapi需要Node.js版本≥12，且需安装依赖：

bash
npm i @hapi/inert @hapi/hapi

js
const agenda = new Agenda().database(
  "mongodb://127.0.0.1/agendaDb",
  "agendaJobs"
);

const server = require("@hapi/hapi").server({
  port: 3002,
  host: "localhost",
});
await server.register(require("@hapi/inert"));
await server.register(
  Agendash(agenda, {
    middleware: "hapi",
  })
);

await server.start();

启动后访问http://localhost:3002/。

Koa

安装依赖：

bash
npm i koa koa-bodyparser koa-router koa-static

js
const agenda = new Agenda().database(
  "mongodb://127.0.0.1/agendaDb",
  "agendaJobs"
);

const Koa = require("koa");
const app = new Koa();
const middlewares = Agendash(agenda, {
  middleware: "koa",
});
for (const middleware of middlewares) {
  app.use(middleware);
}

await app.listen(3002);

启动后访问http://localhost:3002/。

独立使用

Agendash提供独立的Express应用，可通过命令行启动：

bash
./node_modules/.bin/agendash --db=mongodb://localhost/agendaDb --collection=agendaCollection --port=3002

默认使用agendaJobs集合和3000端口，可简化命令：

bash
./node_modules/.bin/agendash --db=mongodb://localhost/agendaDb

若npm版本≥5.2，可使用npx：

bash
npx agendash --db=mongodb://localhost/agendaDb --collection=agendaCollection --port=3002

启动后访问http://localhost:3002/。

Docker使用

可通过Docker容器运行Agendash：

bash
docker run -p 3000:3000 \
  --env MONGODB_URI=mongo://myUser:myPass@myHost/myDb \
  --env COLLECTION=myAgendaCollection agenda/agendash

启动后访问http://localhost:3000/。

故障排除

排序索引

为提高排序性能，可能需要创建以下索引（参见https://github.com/agenda/agendash/issues/24%EF%BC%89%EF%BC%9A

js
db.agendaJobs.ensureIndex({
    "nextRunAt" : -1,
    "lastRunAt" : -1,
    "lastFinishedAt" : -1
}, "agendash")

路线图

• 增加测试覆盖率
• 添加Fastify及其他类Express库的中间件
• 社区决定！提交功能请求