跳转到主要内容

插件协议

Grafana 服务器使用物理线协议与后端插件进行通信。此协议在 Grafana 和后端插件之间建立合同,以允许它们相互通信。

使用插件协议进行开发

注意

我们强烈建议不要直接针对协议实施后端插件开发。相反,我们更喜欢您使用实现了此协议并提供高级 API 的 Grafana 插件 SDK for Go

如果您选择直接针对插件协议进行开发,您可以使用 Protocol Buffers (即 protobufs) 与 gRPC 来完成。

Grafana 的插件协议 protobufs 可在 GitHub 仓库 中找到。

注意

由于 Grafana 本身将 SDK 的部分内容用作依赖项,因此插件协议位于 Grafana 插件 SDK for Go 中。

版本控制

有时, Grafana 将在插件协议的最新版本中提供服务的添加、消息和字段。我们预计这些更新不会引入任何破坏性更改。但是,如果我们必须对插件协议进行破坏性更改,我们将创建一个新的插件协议主版本。

随着 Grafana 发布新的主要版本,插件协议也将发布新的主要版本。当这种情况发生时,我们将支持旧版和新版插件协议一段时间,以确保现有的后端插件继续工作。

插件协议试图遵循 Grafana 的版本策略。然而,这并不意味着 Grafana 发布新版本时,我们就会自动创建新的插件协议版本。