可视化注解

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

Annotated visualization with annotation context menu open

在 Grafana Play 中试用

使用 Grafana Play，您可以探索并查看其工作原理，从实际示例中学习，加快您的开发。此功能可在注解页面上看到。

试用

您可以通过三种方式对可视化进行注解

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

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

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

以下可视化类型支持注解

时序图
状态时间线
K线图

在面板中创建注解

Grafana 具备直接从面板添加注解事件的功能，使用所有仪表盘都具有的内置注解查询。您通过此方式创建的注解存储在 Grafana 中。

要直接在面板中添加注解

仪表盘必须已保存。
内置查询必须启用。了解更多信息请参阅内置查询。

观看以下视频，快速了解如何创建注解

添加注解

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

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

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

添加区域注解

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

编辑注解

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

删除注解

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

通过仪表盘设置获取注解

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

观看下面的视频快速了解教程。

添加新的注解查询

要向仪表盘添加新的注解查询，请按照以下步骤操作

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

内置查询

添加注解后，它们仍然可见。这是因为所有仪表盘都存在内置注解查询。此注解查询获取源自当前仪表盘的所有注解事件，这些事件存储在 Grafana 中，并显示在它们创建的面板上。这包括告警状态历史记录注解。

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

要直接向仪表盘添加注解，必须启用此查询。

要确认内置查询是否启用，请执行以下步骤

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

您可以通过以下步骤停止获取和绘制注解

点击仪表盘标题中的仪表盘设置（齿轮）图标打开设置菜单。
点击注解。
找到并点击注解和告警（内置）查询以打开它。
点击已启用切换将其关闭。
点击保存仪表盘。
点击返回仪表盘并退出编辑。

当您使用另存为功能复制仪表盘时，它会获得一个新的仪表盘 ID，因此在源仪表盘上创建的注解将不再在复制的仪表盘上可见。您仍然可以通过添加新的注解查询并按标签过滤来显示它们。但是，这仅适用于源仪表盘上的注解带有可供过滤的标签。

以下是一些内置注解查询特有的查询选项。

按标签过滤查询

您可以通过将过滤方式设置为 Tags 来创建新查询，以使用 -- Grafana -- 数据源从内置注解查询中获取注解。

Grafana 还支持现有标签的类型提示，请至少提供一个标签。

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