进阶 uptime.kuma.pet 2026-11-20 10:30:00 · 3 阅读

第9章 Badge(徽章)功能详解

Badge (版本 >= 1.16.0)

描述 status、ping、uptime、avg-response、cert-exp 和 response-badges 均在本地生成。 服务器会为所有已添加至状态页并发布的监控项执行此操作。 其设计基于 badge-maker(又称 shields.io)。 以下是为特定(公开)监控项返回 SVG 图形的端点:

| Badge 类型 | URL 结构 | URL 示例 | 图形示例 | | :--- | :--- | :--- | :--- | | status | /api/badge/:monitorID/status | /api/badge/1/status | | | uptime | /api/badge/:monitorID/uptime:duration | /api/badge/1/uptime | | | ping | /api/badge/:monitorID/ping:duration | /api/badge/1/ping | | | avg-response | /api/badge/:monitorID/avg-response:duration | /api/badge/1/avg-response | | | cert-exp | /api/badge/:monitorID/cert-exp | /api/badge/1/cert-exp | | | response | /api/badge/:monitorID/response | /api/badge/1/response | |

提示 我们集成了 Badge 生成器,使配置过程更加直观。 你可以通过以下方式使用生成器:

在编辑模式下访问状态页 点击设置图标 点击“打开 Badge 生成器”按钮 填写表单以创建自定义 Badge

Badge 类型选项

Status Badge 你可以自定义 status badge 的外观: upLabel,默认值:Up downLabel,默认值:Down upColor downColor 示例

BadgeUrl:/api/badge//status?upLabel=&downLabel= 示例:/api/badge//status?upColor=white&downColor=black

Ping、Uptime、Avg-response 和 Response Badge 你可以自定义 ping、uptime、avg-response 和 response badge 的文本: labelPrefix label labelSuffix,默认值:uptime、ping 和 avg-response 为 value: uptime, ping & avg-response;image= h prefix suffix,默认值:uptime= %,ping、avg-response 和 response= ms color labelColor 示例

BadgeUrl: /api/badge//ping/24?labelPrefix=&label=

默认 uptime badge 的颜色基于正常运行时间百分比: 但可以使用预定义颜色或任何 HEX 代码颜色进行覆盖:

Ping、Uptime 和 Avg-response 的 Badge 持续时间 Badge 持续时间(以小时计)中给定的时间间隔必须以“小时”为单位,但自定义选项允许不同的显示方式: 示例

BadgeUrl:/api/badge/1/uptime/720?label=30&labelSuffix=d

Certificate Expire Badge 除了与 ping、uptime 和 avg-response 相同的选项外,还有额外的选项来自定义 cert-exp badge 的文本: upColor downColor warnDays downDays

Badge 样式 https://shields.io/#styles 中定义的多种 badge 样式。(感谢 @throwabird / 评论) flat (默认) flat-square plastic for-the-badge social 示例

BadgeUrl:/api/badge//status?style=flat-square

第三方插件应用 第三方插件或应用程序、插件或相关子项目的列表。

开发侧笔记 仅供开发参考的一些陷阱和有用技巧。

评论 (0)