注释可视化

标注提供了一种在可视化上标记点的丰富事件的方式。它们在所有图形面板上以垂直线和图标的形式显示。当您悬停在标注上时，可以获取事件描述和事件标签。文本字段可以包括指向其他系统以获取更多详情的链接。

Annotated visualization with annotation context menu open

使用 Grafana Play 尝试

使用 Grafana Play，您可以探索和了解其工作原理，通过实际示例学习以加速您的开发。此功能可以在标注上查看。

尝试一下

您可以通过三种方式标注可视化

在面板中直接使用内置标注查询
使用 HTTP API
在仪表盘设置中配置标注查询

在前两种情况下，您正在创建新的注释，而在最后一种情况下，您正在从数据源查询现有的注释。内置注释查询也支持这一点。

本页解释了第一种和第三种选项；有关使用HTTP API的信息，请参阅注释API。

以下可视化类型支持注释

时间序列
状态时间线
蜡烛图

在面板中创建注释

Grafana具有直接从面板使用内置注释查询添加注释事件的能力，该查询存在于所有仪表板上。您以这种方式创建的注释将存储在Grafana中。

要直接在面板中添加注释

仪表板必须已经保存。
必须启用内置查询。更多详情请参阅内置查询。

观看以下视频，了解创建注释的快速教程

添加注释

要添加注释，请完成以下步骤

如果您刚刚保存了仪表板，请刷新页面。
点击仪表板右上角的编辑。
点击要添加注释的面板。
将出现一个上下文菜单。
在上下文菜单中，点击添加注释。
添加注释描述和标签（可选）。
点击保存仪表板。
点击退出编辑。

或者，要添加注释，请按Ctrl/Cmd并点击面板，将出现添加注释上下文菜单。

添加区域注释

如果您刚刚保存了仪表板，请刷新页面。
点击仪表板右上角的编辑。
按Ctrl/Cmd并点击并拖动面板。
添加注释描述和标签（可选）。
点击保存仪表板。
点击退出编辑。

编辑注释

点击仪表板右上角的编辑。
将鼠标悬停在面板上的注释指示器上。
点击注释提示中的铅笔图标。
修改描述和标签。
点击保存仪表板。
点击退出编辑。

删除注释

点击仪表板右上角的编辑。
将鼠标悬停在面板上的注释指示器上。
点击注释提示中的垃圾箱图标。
点击保存仪表板。
点击退出编辑。

通过仪表板设置获取注释

在仪表板设置中，在注释下，您可以使用任何数据源添加新查询以获取注释，包括内置的数据注释数据源。注释查询返回可以在仪表板上的图表中可视化为事件标记的事件。

观看以下视频，了解快速教程。

添加新的注释查询

要将新的注释查询添加到仪表板，请按照以下步骤操作

点击仪表板右上角的编辑。
点击设置。
在设置页面上，转到注释选项卡。
点击添加注释查询。
如果您之前已添加查询，将显示+ 新查询按钮。
为注释查询输入名称。
此名称将分配给允许您启用/禁用显示此查询注释事件的切换（复选框）。
选择注释的数据源。
您还可以点击打开高级数据源选择器以查看更多选项，包括添加数据源（仅管理员）。
如果您不想立即使用注释查询，请清除启用复选框。
如果您不想在仪表板中显示注释查询切换，请选择隐藏复选框。
选择事件标记的颜色。
在显示在下拉菜单中，选择以下选项之一
- 所有面板 - 注释显示在所有支持注释的面板上。
- 所选面板 - 注释显示在您选择的全部面板上。
- 除所选之外的所有面板 - 注释显示在您选择之外的所有面板上。
注释过滤
配置查询。
不同数据源的注释查询选项不同。有关特定数据源注释的信息，请参阅特定数据源主题。
点击保存仪表板。
点击返回仪表板和退出编辑。

内置查询

添加注释后，它们仍然可见。这是因为所有仪表板上都存在内置的注释查询。此注释查询将检索来自当前仪表板的所有注释事件（存储在Grafana中），并在创建它们的面板上显示。这包括警报状态历史注释。

默认情况下，内置注释查询使用-- Grafana --特殊数据源，并且仅支持使用此数据源手动注释。您可以在内置注释查询中使用另一个数据源，但您只能使用该数据源的查询编辑器创建自动化注释。

要直接将注释添加到仪表板，必须启用此查询。

要确认内置查询是否启用，请按照以下步骤操作

点击仪表板右上角的编辑。
点击设置。
在设置页面上，转到注释选项卡。
找到注释和警报（内置）查询。
如果查询名称前显示为禁用，则需要单击查询名称以打开它并更新设置。

您可以通过以下步骤停止检索和绘制注释

单击仪表板标题中的仪表板设置（齿轮）图标以打开设置菜单。
单击注释。
找到并单击注释和警报（内置）查询以打开它。
单击启用开关以关闭它。
点击保存仪表板。
点击返回仪表板和退出编辑。

当您使用另存为功能复制仪表板时，它将获得新的仪表板ID，因此源仪表板上创建的注释在副本中不再可见。如果您添加一个新的注释查询并按标签筛选，则仍然可以显示它们。但是，这仅当源仪表板上的注释有筛选的标签时才有效。

以下是针对内置注释查询的一些特定查询选项。

按标签筛选查询

您可以通过将筛选器设置为标签，使用-- Grafana --数据源创建新的查询以从内置注释查询检索注释。

Grafana v8.1及更高版本也支持现有标签的自动完成，至少提供一个标签。

例如，创建一个名为outages的注释查询名称并指定一个标签outage。此查询将显示所有带有outage标签的注释（来自任何仪表板或通过API）。如果在注释查询中定义了多个标签，则Grafana将仅显示匹配所有标签的注释。要修改行为，启用匹配任何，Grafana将显示包含您提供的任何标签的注释。