首页/云/可观测性速查/Text 面板:把说明固化在页面里
Grafana 与看板53 条

Text 面板:把说明固化在页面里

Text 面板支持 Markdown/HTML:写看板说明、指标口径、值班流程与导航链接;变量可在文本中插值,随看板环境切换。

可观测性速查云更新于 2026-10-13

Text 面板是什么

Text 面板用 Markdown 或 HTML 写纯文本内容,常在看板里固化说明:指标口径、值班流程、发布窗口与相关链接都可以写在页面上,与图表放在一起。它支持变量插值,同一块看板在不同环境下显示对应的说明,是降低跨班次交接成本最省力的做法。

基本信息

内容格式Markdown 或 HTML,按面板模式切换
变量插值支持看板变量,例如 $env、${service}
刷新行为随看板刷新重新渲染,跟随时间范围变化
典型位置看板顶部或图表旁,作为口径说明与导航

Markdown 示例

Markdown 示例
## 值班与口径说明
- P95 延迟口径:5 分钟窗口,含网关等待时长
- 发布窗口:周二、周四 20:00-22:00
- 相关看板:错误预算 / 日志检索入口

> 当前环境:$env(变量插值)
> 排障入口:Runbook 第 3 节

典型使用场景

  • 把指标口径写清楚,避免不同人对同一条曲线理解不一致
  • 把 runbook 关键步骤放在告警相关看板上,值班不必切换文档
  • 给大屏加导航:相关看板、日志检索、值班表的链接集中一处
  • 标注维护窗口与已知波动,减少无谓问询

内容建议

内容建议写法
口径说明写清统计窗口、排除项与依赖,用短句表述
责任信息值班组与升级路径,配合看板权限一起使用
链接用相对路径或稳定的内部链接,避免写死临时地址
敏感信息不写内网地址与账号提示,公开看板尤其注意
文本引用变量在首次加载时会短暂显示原始占位符,属正常刷新过程,刷新完成后即替换为实际取值。
公开看板里不要写内网地址、堡垒机入口等敏感信息,分享范围扩大的当天就可能被外部访问。
面板很多时把口径说明集中放在看板顶部一个 Text 面板,改动只需要一处,避免多块文字内容互相矛盾。

易错点

  • 公开看板里写内网地址或账号提示,等于把入口信息一并公开
  • 口径说明长期不更新,图表已改口径而文字还停留在旧描述
  • 把大段流程写进面板,排版过密反而没人看,关键步骤应短句前置
  • 文本引用变量在首次加载短暂显示占位符时被误判成看板故障

数据来源与参考

  • Grafana 官方文档 · Text panel
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌