跳至主要内容

添加对注释查询的支持

您可以为插件添加对注释查询的支持，这些查询将信息插入到 Grafana 警报中。本指南说明如何为数据源插件添加对 注释查询 的支持。

在数据源插件中支持注释查询​

要启用注释，只需在插件中添加两行代码。Grafana 使用您的默认查询编辑器来编辑注释查询。

  1. 将 "annotations": true 添加到 plugin.json 文件中，以告知 Grafana 您的插件支持注释。

    src/plugin.json
    {
      "annotations": true
    }

  2. 在 datasource.ts 中，覆盖来自 DataSourceApi（或后端数据源的 DataSourceWithBackend）的 annotations 属性。对于默认行为，将 annotations 设置为空对象。

    src/datasource.ts
    annotations: {
    }