为可视化添加注释 - 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. 修改描述和/或标签。

  4. 选择保存。

删除注释

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

  2. 在批注工具提示中选择 “删除（垃圾）” 图标。

通过仪表板设置获取注释

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

添加新的注解查询

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

  2. 选择 “注释”。

  3. 单击 “添加注释查询”。

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

    这个名字被赋予了切换开关（复选框），允许你启用显示此查询中的注释事件。

  5. 为注释选择数据源。

    您也可以选择 “打开高级数据源选择器” 以查看更多选项，包括添加新数据源（仅适用于管理员）。

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

  7. 如果您不想在仪表板中显示批注查询开关，请选中 “隐藏” 复选框。

  8. 为事件标记选择一种颜色。

  9. 在 “显示方式” 下拉列表中，选择以下选项之一：

    • 所有面板-批注显示在所有支持批注的面板上。

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

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

  10. 配置查询。

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

内置查询

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

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

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

确认内置查询已启用

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

  2. 选择 “注释”。

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

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

阻止获取和绘制注释

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

  2. 选择 “注释”。

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

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

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

按标签筛选查询

通过将 F il ter by 设置为，可以创建新的查询，以便使用Grafana数据源从内置注解查询中提取注释Tags。

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

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