注释可视化

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

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