对可视化进行注释 - Amazon Managed Grafana
在面板中创建注释通过控制面板设置获取注释内置查询

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

对可视化进行注释

本文档主题专为支持 Grafana 10.x 版本的 Grafana 工作区而设计。

对于支持 Grafana 9.x 版本的 Grafana 工作区，请参阅使用 Grafana 版本 9。

对于支持 Grafana 8.x 版本的 Grafana 工作区，请参阅使用 Grafana 版本 8。

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

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

  • 直接在面板中，使用内置的注释查询。

  • 使用 Grafana HTTP API。

  • 在控制面板设置中配置注释查询。

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

本节介绍了第一和第三个选项；有关使用 Grafana HTTP API 的信息，请参阅 注释 API。

以下可视化类型支持注释：

  • 时间序列

  • 状态时间轴

  • K 线图

在面板中创建注释

Grafana 允许使用所有控制面板上存在的内置注释查询直接从面板添加注释事件。以这种方式创建的注释存储在 Grafana 中。

要直接在面板中添加注释：

  • 必须已保存控制面板。

  • 必须启用内置查询。

添加注释

  1. 在控制面板中，选择要向其添加注释的面板。将出现一个上下文菜单。

  2. 在上下文菜单中，选择添加注释。

  3. （可选）添加注释描述和标签。

  4. 选择保存。

或者，要添加注释，请在选择面板时按下 Ctrl（或 Cmd），此时将显示添加注释弹出窗口。

区域注释

您还可以创建覆盖可视化中某个区域或时间段的注释。

添加区域注释

  1. 在控制面板中，按住 Ctrl（或 Cmd）并选择面板的某个区域。

  2. 添加注释描述和标签（可选）。

  3. 单击保存。

编辑注释

  1. 在控制面板中，将鼠标悬停在面板中的注释指示器上。

  2. 选择注释工具提示中的编辑（铅笔）图标。

  3. 修改描述 and/or 标签。

  4. 选择保存。

删除注释

  1. 在控制面板中，将鼠标悬停在面板中的注释指示器上。

  2. 选择注释工具提示中的删除（垃圾桶）图标。

通过控制面板设置获取注释

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

添加新的注释查询

  1. 选择控制面板标题中的设置（齿轮）图标以打开设置菜单。

  2. 选择注释。

  3. 单击添加注释查询。

  4. 输入注释查询的名称。

    此名称被赋予切换功能，允许您启用此查询中显示的注释事件。

  5. 选择注释的数据来源。

    您还可以选择打开高级数据来源选取器以查看更多选项，包括添加数据来源（仅供管理员使用）。

  6. 如果不想立即使用注释查询，请清除启用复选框。

  7. 如果不想在控制面板中显示注释查询切换，请选中隐藏复选框。

  8. 选择事件标记的颜色。

  9. 在显示位置下拉列表中，选择以下选项之一：

    • 所有面板：注释显示在所有支持注释的面板上。

    • 选定面板：注释显示在您选择的所有面板上。

    • 除此以外的所有面板：注释显示在除您选择的面板之外的所有面板上。

  10. 配置查询。

    每个数据来源的注释查询选项都不同。有关特定数据来源中注释的信息，请参阅 连接到数据来源。

内置查询

添加注释后，将仍然可见。这是因为所有控制面板上都存在内置的注释查询。此注释查询将获取源于当前控制面板（存储在 Grafana 中）的所有注释事件，并将其显示在创建事件的面板上。这包括警报状态历史记录注释。

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

要直接向控制面板添加注释，必须启用此查询。

确认内置查询已启用

  1. 选择控制面板标题中的控制面板设置（齿轮）图标以打开控制面板设置菜单。

  2. 选择注释。

  3. 查找注释和警报（内置）查询。

    如果查询名称前显示已禁用，则需要选择查询名称以将其打开并更新设置。

阻止获取和绘制注释

  1. 选择控制面板标题中的控制面板设置（齿轮）图标以打开控制面板设置菜单。

  2. 选择注释。

  3. 选择注释和警报（内置）查询。

  4. 选择启用开关将其关闭。

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

按标签筛选查询

您可以将筛选依据设置为 Tags 来创建新的查询，以通过 Grafana 数据来源从内置注释查询获取注释。

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

您还可以在标签查询中使用模板变量。这意味着，如果您有一个显示不同服务的统计信息的控制面板和一个指示显示哪些服务的模板变量，您可以在注释查询中使用相同的模板变量，仅显示这些服务的注释。