mirror of
https://github.com/grafana/grafana.git
synced 2025-07-31 20:32:19 +08:00
baba1634b8
* fix dispense * plugin loading refactor Moves common functionality of registering, starting, stopping and restarting backend plugins to backendplugin package. * simplify plugin descriptors * target sdk v0.5.0 Co-authored-by: Kyle Brandt <kyle@kbrandt.com>
85 lines
2.8 KiB
Go
85 lines
2.8 KiB
Go
package backendplugin
|
|
|
|
import (
|
|
"os/exec"
|
|
|
|
"github.com/grafana/grafana/pkg/infra/log"
|
|
|
|
datasourceV1 "github.com/grafana/grafana-plugin-model/go/datasource"
|
|
rendererV1 "github.com/grafana/grafana-plugin-model/go/renderer"
|
|
backend "github.com/grafana/grafana-plugin-sdk-go/backend"
|
|
sdk "github.com/grafana/grafana-plugin-sdk-go/common"
|
|
"github.com/hashicorp/go-plugin"
|
|
)
|
|
|
|
const (
|
|
// DefaultProtocolVersion is the protocol version assumed for legacy clients that don't specify
|
|
// a particular version or version 1 during their handshake. This is currently the version used
|
|
// since Grafana launched support for backend plugins.
|
|
DefaultProtocolVersion = 1
|
|
)
|
|
|
|
// Handshake is the HandshakeConfig used to configure clients and servers.
|
|
var handshake = plugin.HandshakeConfig{
|
|
// The ProtocolVersion is the version that must match between Grafana core
|
|
// and Grafana plugins. This should be bumped whenever a (breaking) change
|
|
// happens in one or the other that makes it so that they can't safely communicate.
|
|
ProtocolVersion: DefaultProtocolVersion,
|
|
|
|
// The magic cookie values should NEVER be changed.
|
|
MagicCookieKey: sdk.MagicCookieKey,
|
|
MagicCookieValue: sdk.MagicCookieValue,
|
|
}
|
|
|
|
func newClientConfig(executablePath string, logger log.Logger, versionedPlugins map[int]plugin.PluginSet) *plugin.ClientConfig {
|
|
return &plugin.ClientConfig{
|
|
Cmd: exec.Command(executablePath),
|
|
HandshakeConfig: handshake,
|
|
VersionedPlugins: versionedPlugins,
|
|
Logger: logWrapper{Logger: logger},
|
|
AllowedProtocols: []plugin.Protocol{plugin.ProtocolGRPC},
|
|
}
|
|
}
|
|
|
|
// PluginDescriptor descriptor used for registering backend plugins.
|
|
type PluginDescriptor struct {
|
|
pluginID string
|
|
executablePath string
|
|
managed bool
|
|
versionedPlugins map[int]plugin.PluginSet
|
|
}
|
|
|
|
// NewBackendPluginDescriptor creates a new backend plugin descriptor
|
|
// used for registering a backend datasource plugin.
|
|
func NewBackendPluginDescriptor(pluginID, executablePath string) PluginDescriptor {
|
|
return PluginDescriptor{
|
|
pluginID: pluginID,
|
|
executablePath: executablePath,
|
|
managed: true,
|
|
versionedPlugins: map[int]plugin.PluginSet{
|
|
DefaultProtocolVersion: {
|
|
pluginID: &datasourceV1.DatasourcePluginImpl{},
|
|
},
|
|
sdk.ProtocolVersion: {
|
|
"backend": &backend.CoreGRPCPlugin{},
|
|
"transform": &backend.TransformGRPCPlugin{},
|
|
},
|
|
},
|
|
}
|
|
}
|
|
|
|
// NewRendererPluginDescriptor creates a new renderer plugin descriptor
|
|
// used for registering a backend renderer plugin.
|
|
func NewRendererPluginDescriptor(pluginID, executablePath string) PluginDescriptor {
|
|
return PluginDescriptor{
|
|
pluginID: pluginID,
|
|
executablePath: executablePath,
|
|
managed: false,
|
|
versionedPlugins: map[int]plugin.PluginSet{
|
|
DefaultProtocolVersion: {
|
|
pluginID: &rendererV1.RendererPluginImpl{},
|
|
},
|
|
},
|
|
}
|
|
}
|