本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
为可视化添加注释
本文档主题专为支持 Grafana 9.x 版本的 Grafana 工作空间而设计。
有关支持 Grafana 版本 10.x 的 Grafana 工作空间,请参阅。在 Grafana 版本 10 中工作
有关支持 Grafana 8.x 版本的 Grafana 工作空间,请参阅。在 Grafana 版本 8 中工作
注释提供了一种使用丰富事件在图表上标记点的方法。将鼠标悬停在注释上方时,可以获得事件描述和事件标签。文本字段可以包含指向其他系统的链接,并提供更多详细信息。
原生注释
Grafana 带有原生注释存储库,并且能够直接从图表面板或通过 HTTP API 添加注释事件。
添加注释
-
在仪表板中,单击 “时间序列” 面板。将出现一个上下文菜单。
-
在快捷菜单中,单击 “添加注释”。
-
添加注释描述和标签(可选)。
-
单击保存。
或者,要添加注释,Ctrl+Click
或者Cmd+Click
在 “时间序列” 面板上,将出现 “添加注释” 弹出窗口。
添加区域注释
-
在仪表板中
Ctrl+Click
或时间序列面板Cmd+Click
上。 -
在上下文菜单中,单击 “添加注释”。
-
添加注释描述和标签(可选)。
-
单击保存。
编辑注释
-
在仪表板中,将鼠标悬停在时间序列面板上的注释指示器上。
-
点击批注工具提示中的编辑(铅笔)图标。
-
修改描述和标签(可选)。
-
单击保存。
删除注释
-
在仪表板中,将鼠标悬停在时间序列面板上的注释指示器上。
-
点击注释工具提示中的垃圾桶图标。
内置查询
添加注释后,它们仍然可见。这是因为所有仪表板上都存在内置的注释查询。此注释查询将获取源自当前仪表板的所有注释事件,并将它们显示在创建它们的面板上。这包括警报状态历史记录注释。您可以通过打开 “批注” 设置(通过仪表板齿轮菜单)并修改名为的查询来阻止获取和绘制注释。Annotations &
Alerts (Built-in)
当您使用 “另存为” 功能复制仪表板时,它将获得一个新的仪表板 ID,因此在源仪表板上创建的注释将不再显示在副本上。如果您添加新的注释查询并按标签筛选,您仍然可以显示它们。只有当源仪表板上的注释有可供筛选的标签时,这才有效。
按标签查询
通过将 F il ter by 设置为,可以创建新的查询,通过-- Grafana --
数据源从本机注释存储中提取注释Tags
。
Grafana v8.1 及更高版本还支持提前输入现有标签,至少提供一个标签。
例如,创建注解查询名称outages
并指定标签outage
。此查询将显示所有带有中断标签的注释(来自任何仪表板或通过 API)。如果在注解查询中定义了多个标签,则 Grafana 将仅显示与所有标签匹配的注释。要修改行为,请启用Match
any
,Grafana 将显示包含您提供的任何一个标签的注释。
在 Grafana v5.3+ 中,可以在标签查询中使用模板变量。因此,如果您有一个显示不同服务的统计信息的仪表板和一个决定要显示哪些服务的模板变量,那么您现在可以在注释查询中使用相同的模板变量来仅显示这些服务的注释。
查询其他数据源
注释事件是通过注解查询获取的。要向仪表板添加新的批注查询,请打开仪表板设置菜单,然后选择注释。这将打开仪表板注释设置视图。要创建新的注释查询,请单击 “新建” 按钮。
为注解查询指定名称。此名称被赋予切换开关(复选框),允许您启用或禁用显示此查询中的注释事件。例如,您可能有两个名为Deploys
和的注释查询Outages
。切换开关将允许您决定要显示哪些注释。
注释查询详情
每个数据源的注释查询选项都不同。有关特定数据源中注释的信息,请参阅特定数据源主题。