@glidemq/dashboard

中文文档
0.4.3发布于 2026/10/24Apache-2.0TypeScriptCommonJS零依赖构建来源已验证近 30 天下载 44.1万

用于滑翔-mq的网络仪表板 -- -- 排队监测、管理和AI可观察性

中文使用文档
文档目录8 节
  1. 为什么
  2. 安装
  3. 快开始
  4. AI-原生特征
  5. API 密码
  6. 限制
  7. 链接
  8. 许可证

@ glidemq/ 磁盘

npm license

实时仪表板 滑翔伞 - 排队监视AI的可观察性 滴入快递中件,不需要前端构建.

为什么

  • 即时可见 - 见工作统计、州、工人和不书写工具的吞吐量
  • 实时更新 - SSE将工作事件推向浏览器,因为发生,没有投票
  • 业务控制 - 暂停、恢复、排出、重试和清理队列,从点到点点击UI

安装

npm install @glidemq/dashboard glide-mq express

要求数 0.15.2 滑翔伞 财务报告和审定财务报表 捷运4或5。 。 。 .

兼容性测试用 滑翔-平方厘米0.2.0。支持的最小对等范围和仪表板HTTP行为保持不变.

快开始

import express from "express";
import { Queue } from "glide-mq";
import { createDashboard } from "@glidemq/dashboard";

const app = express();
const queue = new Queue("payments", {
  connection: { addresses: [{ host: "localhost", port: 6379 }] },
});

app.use("/dashboard", createDashboard([queue]));
app.listen(3000);
// Open http://localhost:3000/dashboard

AI-原生特征

工作细节视图包括: usage (基于记录的代号/费用细目), signals, (中文(简体) ), budgetKey, (中文(简体) ), fallbackIndex,以及 tpmTokens。 。 。 .

3个专门的终点暴露出AI管弦乐状态:

  • GET /api/queues/:name/flows/:id/usage - 所有工作在流动中的总的代号/费用使用。 返回合并使用记录.
  • GET /api/queues/:name/flows/:id/budget - 流动预算状况 -- -- 当前支出、每类上限、剩余预算。 如果没有确定预算,则返回404个.
  • GET /api/usage/summary - 在所有已挂起的队列中滚动总使用量 ?queues= 子集。 支助 start, (中文(简体) ), end, (中文(简体) ), window,以及 windowMs。 。 。 .
  • GET /api/queues/:name/jobs/:id/stream - 流出工作输出块的SSE端点。 支助 ?lastId= 重新开放。 回返 event: chunk 以条目字段为数据的信息.

SSE 事件流( R)/api/events现包括 usage, (中文(简体) ), suspended,以及 budget-exceeded 活动与标准队列生命周期事件.

用于 HTTP 上的写侧流管弦(POST /flows, (中文(简体) ), GET /flows/:id, (中文(简体) ), GET /flows/:id/tree, (中文(简体) ), DELETE /flows/:id),使用核心滑翔-mq代理或HTTP包装集成: @glidemq/hono, (中文(简体) ), @glidemq/fastify,以及 @glidemq/hapi仪表板继续侧重于检查和业务.

API 密码

createDashboard(queues: Queue[], opts?: DashboardOptions): Router
选项类型默认说明
queueEventsQueueEvents[][]实时SSE事件实例
readOnlybooleanfalse以 403 屏蔽所有变异路线
authorize(req, action) => boolean | Promise<boolean>- 说吧行动授权回调

动作字符串 : queue:pause, (中文(简体) ), queue:resume, (中文(简体) ), queue:obliterate, (中文(简体) ), queue:drain, (中文(简体) ), queue:retryAll, (中文(简体) ), queue:clean, (中文(简体) ), job:remove, (中文(简体) ), job:retry, (中文(简体) ), job:promote, (中文(简体) ), job:changePriority, (中文(简体) ), job:changeDelay, (中文(简体) ), scheduler:upsert, (中文(简体) ), scheduler:remove

app.use(
  "/dashboard",
  createDashboard(queues, {
    authorize: (req, action) => {
      if (action === "queue:obliterate") return req.session?.user?.role === "admin";
      return true;
    },
  })
);

限制

  • 唯快报. 没有内置适配器用于Fastify,Hono,或Koa.
  • Middleware,不是一个独立的服务器 - 在已有的Express应用程序上挂载.
  • 需要滑行- mq( 滑行- mq) Queue 实例。 不直接连接到 Valkey/ Redis .

许可证

阿帕奇 - 2.0

版本与发布记录

@glidemq/dashboard 共发布 6 个版本,首次发布于 2026/02/24;过去 12 个月发布了 6 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.4.3latest2026/10/2423 天前
0.4.22026/10/061 个月前
0.4.12026/04/067 个月前
0.4.02026/04/027 个月前
0.3.02026/03/287 个月前
0.2.02026/02/248 个月前

关于 @glidemq/dashboard 的常见问题

@glidemq/dashboard 是什么?

用于滑翔-mq的网络仪表板 -- -- 排队监测、管理和AI可观察性

如何安装 @glidemq/dashboard?

在项目目录运行 npm install @glidemq/dashboard,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:express(^4 || ^5)、glide-mq(>=0.15.2)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@glidemq/dashboard 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@glidemq/dashboard 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@glidemq/dashboard 可以商用吗?

@glidemq/dashboard 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@glidemq/dashboard 的下载量有多少?

根据 npm 官方下载统计,@glidemq/dashboard 在 2026/10/17 – 2026/11/15 这 30 天内被下载 440,878 次,日均约 14,696 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@glidemq/dashboard 还在维护吗?

最新版本 0.4.3 发布于 2026/10/24(23 天前);至今共发布 6 个版本,其中过去 12 个月发布了 6 个;首次发布于 2026/02/24。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。