Skip to content

Repository files navigation

monitor-theme-default

monitor 的内置默认主题,同时作为第三方主题的参考实现。

React + Vite + shadcn/ui,黑白配色。

开发

启动一个 hub 实例:

monitor-hub --listen 127.0.0.1:9911 --db /tmp/monitor.db --site http://127.0.0.1:9911

启动开发服务器,Vite 将 /api 与 WebSocket 代理至 hub:

npm ci
npm run dev

构建产物位于 dist/。提交前运行 npm run build && npm run lint && npm test

npm test 校验数字格式化和实时指标的输入边界。没有测试框架,Node 自己剥掉 类型,失败时退出码非零。

主题包

一个可安装主题是一个目录,名字必须与 theme.jsonshort 相同:

<themes-dir>/<short>/
├── theme.json
└── dist/
    └── index.html

theme.json 的字段均为字符串:

字段 含义
name 显示名称
short 唯一短名,限字母、数字、-_default 为内置主题保留
description 简介
version 主题版本
author 作者
url 源码地址

每个 tag 的 release 里的 theme.tar.gz 解开就是这个目录——hub 构建时嵌入的是同一个包。

将目录复制到 hub 的 --themes 位置,在后台「主题」页切换,无需重启。

主题契约

主题是纯静态 SPA,只能依赖下列同源接口:

接口 用途
GET /api/me 站点名、登录状态、公开页开关
GET /api/nodes 节点列表、实时指标和累计流量
GET /api/nodes/{id}/metrics 历史指标和延迟记录
GET /api/ws 每 2 秒推送一次节点快照的 WebSocket

metrics 的三个查询参数都可省:

  • hours=N 窗口宽度。匿名上限 168,登录后 2160,超出静默 clamp——降采样限的是响应行数,这个 上限限的是 hub 扫描多少行
  • points=W 调用方画得下的点数,只会让 hub 抽得更稀,不会更密
  • series=metrics|ping 只取要画的那一半,省掉的那半原本占响应的三分之一到三分之二

探测曲线的名字在响应的 probes 里随样本一起下发,匿名可读,所以画延迟图不需要第二个请求,也不 需要管理员身份。

匿名访问 GET /api/nodes 仅返回 public=1 的节点,响应中不含 iphostnameremark。字段定义以 hub 的 src/api.rs 为准。

未知路径回落到主题的 dist/index.html,客户端路由可用。/admin/* 由 hub 内置后台接管,不属于主题契约。

本主题用 /node/{id} 作为详情页。hub 的回落对它够用,但hub 前面若有按路径做正向白名单的反代 或 WAF,得把这个前缀放行:从列表点进去只是 pushState,边缘看不见,刷新详情页才会真的请求 /node/{id},症状是「点进去正常,一刷新就被拦」。

许可

MIT

About

Default public theme for monitor

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages