插件 〉WebSocket API


开发者

Golioth

订阅以接收不定期的产品新闻和更新



数据源
社区

WebSocket API

  • 概述
  • 安装
  • 更新日志
  • 相关内容

Grafana 的 WebSocket 数据源

一个用于在 Grafana 仪表板中实现实时数据更新的 WebSocket 数据源插件。

插件用途

此插件允许您将 WebSocket 端点连接作为 Grafana 仪表板的数据源。与 REST API 不同,WebSocket 在源有新数据可用时会自动更新,无需定期从中获取数据。

工作原理

当 WebSocket 端点作为数据源添加到 Grafana 中时,插件将与源 API 打开 WebSocket 连接并保持连接。当有新数据时,WebSocket 端点将通过开放的 WebSocket 连接直接将其发送到插件,您的仪表板将自动更新。

使用 WebSocket 数据源

以下是在 Grafana 中配置和使用 WebSocket 数据源插件的步骤。

配置数据源

  1. 在 Grafana 中添加 WebSocket 数据源插件

    • 点击左侧边栏的齿轮图标并选择“数据源”
    • 点击“添加数据源”
    • 滚动到底部,在“其他”类别中选择“WebSocket API”。
  2. 配置 WebSocket 端点信息 Grafana Websockets Configuration

    • WebSocket 主机(使用此格式):wss://your-host/some/prefix-path
    • 如有必要,添加查询参数和自定义标头(请查阅您的 WebSocket API 数据源)。此示例展示了 API 密钥的使用方法。
  3. 向 Grafana 仪表板添加面板以开始查看数据

    • 点击左侧边栏中的 +。选择“仪表板” --> “添加新面板”
    • 在选择下拉菜单中选择 WebSocket API 作为数据源
    • 在左下方,将“字段”选项卡设置为 $
    • 点击“路径”选项卡,并设置您想要连接的 WebSocket 端点的路径(如有必要)
    • 在面板上方,点击窗口顶部的“表格视图”开关
    • 来自 WebSocket 端点的任何数据将以 JSON 格式显示在面板中

    Graphana showing stream json packets

自定义您的数据视图

确认您正在接收实时数据后,即可对其进行可视化

  1. 确保表格视图已关闭,并从右上角的“可视化”列表中选择任何兼容的图形类型。

  2. 从图表右上角的时间选择窗口中选择“最近 5 分钟”。

    Graphana WebSockets Graph

在 Grafana Cloud 上安装 WebSocket API

有关更多信息,请访问插件安装文档。

更新日志

1.0.2

  • 更新插件描述并提升工具包版本

1.0.1

  • 在 plugin.json 中添加指向许可和仓库的链接。

1.0.0

Golioth WebSocket 数据源插件发布

本次发布的主要重点是为 Grafana 社区推出新的 WebSocket 数据源插件。