插件 〉WebSocket API
WebSocket API
Grafana 的 WebSocket 数据源
一个用于在 Grafana 仪表板中实现实时数据更新的 WebSocket 数据源插件。
插件用途
此插件允许您将 WebSocket 端点连接作为 Grafana 仪表板的数据源。与 REST API 不同,WebSocket 在源有新数据可用时会自动更新,无需定期从中获取数据。
工作原理
当 WebSocket 端点作为数据源添加到 Grafana 中时,插件将与源 API 打开 WebSocket 连接并保持连接。当有新数据时,WebSocket 端点将通过开放的 WebSocket 连接直接将其发送到插件,您的仪表板将自动更新。
使用 WebSocket 数据源
以下是在 Grafana 中配置和使用 WebSocket 数据源插件的步骤。
配置数据源
在 Grafana 中添加 WebSocket 数据源插件
- 点击左侧边栏的齿轮图标并选择“数据源”
- 点击“添加数据源”
- 滚动到底部,在“其他”类别中选择“WebSocket API”。
配置 WebSocket 端点信息
- WebSocket 主机(使用此格式):
wss://your-host/some/prefix-path
- 如有必要,添加查询参数和自定义标头(请查阅您的 WebSocket API 数据源)。此示例展示了 API 密钥的使用方法。
- WebSocket 主机(使用此格式):
向 Grafana 仪表板添加面板以开始查看数据
- 点击左侧边栏中的 +。选择“仪表板” --> “添加新面板”
- 在选择下拉菜单中选择 WebSocket API 作为数据源
- 在左下方,将“字段”选项卡设置为
$
- 点击“路径”选项卡,并设置您想要连接的 WebSocket 端点的路径(如有必要)
- 在面板上方,点击窗口顶部的“表格视图”开关
- 来自 WebSocket 端点的任何数据将以 JSON 格式显示在面板中
自定义您的数据视图
确认您正在接收实时数据后,即可对其进行可视化
确保表格视图已关闭,并从右上角的“可视化”列表中选择任何兼容的图形类型。
从图表右上角的时间选择窗口中选择“最近 5 分钟”。
在 Grafana Cloud 上安装 WebSocket API
在 Grafana Cloud 实例上安装插件只需一键完成;更新也一样。很酷吧?
请注意,插件可能需要最多 1 分钟才能在您的 Grafana 中显示出来。
在 Grafana Cloud 实例上安装插件只需一键完成;更新也一样。很酷吧?
请注意,插件可能需要最多 1 分钟才能在您的 Grafana 中显示出来。
在 Grafana Cloud 实例上安装插件只需一键完成;更新也一样。很酷吧?
请注意,插件可能需要最多 1 分钟才能在您的 Grafana 中显示出来。
在 Grafana Cloud 实例上安装插件只需一键完成;更新也一样。很酷吧?
请注意,插件可能需要最多 1 分钟才能在您的 Grafana 中显示出来。
在 Grafana Cloud 实例上安装插件只需一键完成;更新也一样。很酷吧?
请注意,插件可能需要最多 1 分钟才能在您的 Grafana 中显示出来。
在 Grafana Cloud 实例上安装插件只需一键完成;更新也一样。很酷吧?
请注意,插件可能需要最多 1 分钟才能在您的 Grafana 中显示出来。
在 Grafana Cloud 实例上安装插件只需一键完成;更新也一样。很酷吧?
请注意,插件可能需要最多 1 分钟才能在您的 Grafana 中显示出来。
有关更多信息,请访问插件安装文档。
在本地 Grafana 上安装
对于本地实例,插件通过简单的 CLI 命令进行安装和更新。插件不会自动更新,但当有可用更新时,您会在 Grafana 内收到通知。
1. 安装数据源
使用 grafana-cli 工具通过命令行安装 WebSocket API
grafana-cli plugins install
插件将安装到您的 grafana 插件目录;默认路径为 /var/lib/grafana/plugins。有关 cli 工具的更多信息。
2. 配置数据源
从 Grafana 主菜单访问,新安装的数据源可以在“数据源”部分立即添加。
接下来,点击右上角的“添加数据源”按钮。该数据源将在“类型”选择框中可供选择。
要查看已安装数据源列表,请点击主菜单中的“插件”项。核心数据源和已安装数据源都将显示。
更新日志
1.0.2
- 更新插件描述并提升工具包版本
1.0.1
- 在 plugin.json 中添加指向许可和仓库的链接。
1.0.0
Golioth WebSocket 数据源插件发布
本次发布的主要重点是为 Grafana 社区推出新的 WebSocket 数据源插件。