注释可视化

注释提供了一种在可视化上标记丰富事件的途径。它们在所有图形面板中以垂直线和图标的形式显示。当你悬停在注释上时，你可以获得事件描述和事件标签。文本字段可以包括链接到其他系统，以获得更多详细信息。

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 将显示包含您提供的任何标签的标注。