跳到主要内容

插件协议

Grafana 服务器使用物理线路协议与后端插件通信。该协议在 Grafana 和后端插件之间建立契约,使其能够相互通信。

使用插件协议进行开发

注意

我们强烈建议不要直接使用协议进行后端插件开发。相反,我们推荐您使用实现了该协议并提供更高级别 API 的Grafana Go 插件 SDK

如果您选择直接使用插件协议进行开发,可以使用Protocol Buffers(即 protobufs)和gRPC来实现。

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

注意

插件协议位于Grafana Go 插件 SDK中,因为 Grafana 本身使用 SDK 的部分作为依赖项。

版本控制

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

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

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