05.8、注释 Annotations
注释(Annotations)
注释是 Grafana 的重要功能,用于在时间轴上标记重要事件。本节将学习:如何添加注释、事件标记、以及部署追踪。
添加注释
添加注释的步骤是什么?
第一步:进入 Dashboard 设置。 Dashboard Settings > Annotations,点击 Add annotation query。
第二步:配置注释数据源。 选择数据源(Prometheus、Loki 等),配置查询语句,设置标签过滤。可以从数据源自动获取注释。
第三步:配置注释显示。 设置注释名称,选择显示位置(顶部、底部),设置颜色和图标。这样注释会在图表上显示。
第四步:手动添加注释。 在图表上右键,选择 Add annotation,输入注释文本和时间。可以手动添加注释。
注释类型: Annotations 包括自动注释(从数据源查询)和手动注释(手动添加)。都可以用于事件标记。
注释会在时间轴上显示,标记重要事件。
事件标记
事件标记适用于哪些场景呢?
第一个场景:部署事件。 标记新版本部署、标记回滚操作、标记配置变更。这样可以关联部署和指标变化。
第二个场景:故障事件。 标记故障发生时间、标记故障恢复时间、标记维护窗口。这样可以分析故障对指标的影响。
第三个场景:业务事件。 标记促销活动、标记重要事件、标记流量高峰。这样可以分析业务事件对系统的影响。
事件标记示例:
部署事件: 时间:2026-01-15 10:00:00,标签:deployment, v2.1.0,描述:部署新版本 v2.1.0。这样可以在图表上看到部署时间。
故障事件: 时间:2026-01-15 14:30:00,标签:incident, database,描述:数据库连接池耗尽。这样可以看到故障时间和指标变化的关系。
事件标记流程: 重要事件 → 添加注释 → 设置时间 → 添加标签 → 输入描述 → 在图表上显示。这样就可以在图表上看到事件标记。
使用注释标记事件,可以更好地理解指标变化的原因。
部署追踪
部署追踪是什么? 部署追踪用于关联部署和指标变化。
部署追踪有什么方法呢?
第一种方法:自动从 CI/CD 获取部署信息。 Jenkins、GitLab CI、GitHub Actions,部署时自动添加注释,标记版本号和时间。这样部署会自动标记。
第二种方法:使用 API。 调用 Grafana API,添加部署注释,标记版本号和时间。这样可以在部署脚本中自动添加。
第三种方法:从 Prometheus 查询。 查询部署指标,自动添加注释,标记部署事件。这样可以从监控数据中获取部署信息。
API 示例: 使用 POST /api/annotations API,可以添加注释。这样可以在 CI/CD 流程中自动添加。
部署追踪流程: 部署触发 → CI/CD 执行 → 调用 Grafana API → 添加部署注释 → 在 Dashboard 显示 → 关联指标变化。这样就可以看到部署对指标的影响。
使用注释追踪部署,可以更好地理解部署对系统的影响。
本节小结
在本节中,我们学习了注释(Annotations):
第一个是添加注释。 Dashboard Settings > Annotations。可以自动从数据源获取或手动添加。
第二个是事件标记。 部署事件、故障事件、业务事件。可以在图表上标记重要事件。
第三个是部署追踪。 从 CI/CD 自动获取或使用 API。可以自动追踪部署。
第四个是注释类型。 自动注释(数据源)和手动注释。两种方式都可以使用。
Annotations 总结: Annotations 包括添加注释、事件标记、部署追踪。这些功能组合在一起,可以让 Dashboard 更实用。
这就是注释(Annotations)。使用注释可以标记重要事件,更好地理解指标变化。
在下一节,我们将学习仪表盘链接和跳转。学习如何创建 Dashboard 链接,跨 Dashboard 跳转。