Documentation
¶
Index ¶
- Constants
- func New(descriptor PluginDescriptor) backendplugin.PluginFactoryFunc
- func NewBackendPlugin(pluginID, executablePath string, startFns PluginStartFuncs) backendplugin.PluginFactoryFunc
- func NewRendererPlugin(pluginID, executablePath string, startFns PluginStartFuncs) backendplugin.PluginFactoryFunc
- type Client
- type LegacyClient
- type LegacyStartFunc
- type PluginDescriptor
- type PluginStartFuncs
- type StartFunc
Constants ¶
View Source
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 )
Variables ¶
This section is empty.
Functions ¶
func New ¶
func New(descriptor PluginDescriptor) backendplugin.PluginFactoryFunc
New allocates and returns a new gRPC (external) backendplugin.Plugin.
func NewBackendPlugin ¶
func NewBackendPlugin(pluginID, executablePath string, startFns PluginStartFuncs) backendplugin.PluginFactoryFunc
NewBackendPlugin creates a new backend plugin factory used for registering a backend plugin.
func NewRendererPlugin ¶
func NewRendererPlugin(pluginID, executablePath string, startFns PluginStartFuncs) backendplugin.PluginFactoryFunc
NewRendererPlugin creates a new renderer plugin factory used for registering a backend renderer plugin.
Types ¶
type Client ¶
type Client struct {
DataPlugin grpcplugin.DataClient
TransformPlugin grpcplugin.TransformClient
RendererPlugin pluginextensionv2.RendererPlugin
}
Client client for communicating with a plugin using the current (v2) plugin protocol.
type LegacyClient ¶
type LegacyClient struct {
DatasourcePlugin datasourceV1.DatasourcePlugin
RendererPlugin rendererV1.RendererPlugin
}
LegacyClient client for communicating with a plugin using the v1 plugin protocol.
type LegacyStartFunc ¶
type LegacyStartFunc func(pluginID string, client *LegacyClient, logger log.Logger) error
LegacyStartFunc callback function called when a plugin with old plugin protocol is started.
type PluginDescriptor ¶
type PluginDescriptor struct {
// contains filtered or unexported fields
}
PluginDescriptor is a descriptor used for registering backend plugins.
func (PluginDescriptor) PluginID ¶
func (pd PluginDescriptor) PluginID() string
PluginID returns the plugin ID.
type PluginStartFuncs ¶
type PluginStartFuncs struct {
OnLegacyStart LegacyStartFunc
OnStart StartFunc
}
PluginStartFuncs functions called for plugin when started.
Source Files
Click to show internal directories.
Click to hide internal directories.