节点图 API

概览
安装
更改日志
相关内容

适用于 Grafana 的节点图 API 插件

此插件提供了一个数据源，用于将 REST API 连接到 Grafana 的节点图面板。它已由 Grafana 签名并发布。

Graph Example

要求

Grafana 7.5+

开始使用

通过 grafana-cli 工具安装

使用 grafana-cli 工具从命令行安装 Node Graph API

grafana-cli plugins install hamedkarbasi93-nodegraphapi-datasource

该插件将安装到您的 grafana 插件目录中；默认目录是 /var/lib/grafana/plugins。更多关于 cli 工具的信息。

通过 zip 文件安装

或者，您可以手动下载最新发布的 .zip 文件，并将其解压到您的 grafana 插件目录中；默认目录是 /var/lib/grafana/plugins。

插件配置

现在您可以添加数据源了。只需输入您的 API 应用的 URL，然后点击“保存并测试”。连接失败时将显示错误。

Add Datasource

在 Grafana 仪表盘中，选择节点图面板并可视化图形。

关于应用访问的说明
版本 0.x.x 在直接模式下工作。也就是说，浏览器必须能够访问 API 应用。
版本 1.x.x+ 在代理模式下工作。也就是说，Grafana 服务器应该能够访问 API 应用。

API 配置

REST API 应用应该处理三个请求：fields、data 和 health。下面将进行描述。

获取图字段

此路由返回参数表中定义的节点和边字段。它有助于插件为图形创建所需的参数。对于节点，需要 id 字段；对于边，需要 id、source 和 target 字段。其他字段是可选的。

端点：/api/graph/fields

方法：GET

内容类型：application/json

内容格式示例

{
  "edges_fields": [
    {
      "field_name": "id",
      "type": "string"
    },
    {
      "field_name": "source",
      "type": "string"
    },
    {
      "field_name": "target",
      "type": "string"
    },
    {
      "field_name": "mainStat",
      "type": "number"
    }
  ],
  "nodes_fields": [
    {
      "field_name": "id",
      "type": "string"
    },
    {
      "field_name": "title",
      "type": "string"
    },
    {
      "field_name": "mainStat",
      "type": "string"
    },
    {
      "field_name": "secondaryStat",
      "type": "number"
    },
    {
      "color": "red",
      "field_name": "arc__failed",
      "type": "number"
    },
    {
      "color": "green",
      "field_name": "arc__passed",
      "type": "number"
    },
    {
      "displayName": "Role",
      "field_name": "detail__role",
      "type": "string"
    }
  ]
}

获取图数据

此路由返回图数据，用于可视化。

端点：/api/graph/data

方法：GET

内容类型：application/json

数据格式示例

{
    "edges": [
        {
            "id": "1",
            "mainStat": "53/s",
            "source": "1",
            "target": "2"
        }
    ],
    "nodes": [
        {
            "arc__failed": 0.7,
            "arc__passed": 0.3,
            "detail__zone": "load",
            "id": "1",
            "subTitle": "instance:#2",
            "title": "Service1"
        },
        {
            "arc__failed": 0.5,
            "arc__passed": 0.5,
            "detail__zone": "transform",
            "id": "2",
            "subTitle": "instance:#3",
            "title": "Service2"
        }
    ]
}

有关变量的更多详细信息，请访问此处。