mirror of
https://github.com/grafana/grafana.git
synced 2025-02-16 18:34:52 -06:00
c0f3b2929c
Refactor to allow shared contract between core and external backend plugins allowing core backend data sources in Grafana to be implemented in same way as an external backend plugin. Use v0.67.0 of sdk. Add tests for verifying plugin is restarted when process is killed. Enable strict linting for backendplugin packages
79 lines
2.7 KiB
Go
79 lines
2.7 KiB
Go
package plugins
|
|
|
|
import (
|
|
"encoding/json"
|
|
"path"
|
|
|
|
"github.com/grafana/grafana/pkg/infra/log"
|
|
"github.com/grafana/grafana/pkg/models"
|
|
"github.com/grafana/grafana/pkg/plugins/backendplugin"
|
|
"github.com/grafana/grafana/pkg/plugins/backendplugin/grpcplugin"
|
|
"github.com/grafana/grafana/pkg/plugins/datasource/wrapper"
|
|
"github.com/grafana/grafana/pkg/tsdb"
|
|
"github.com/grafana/grafana/pkg/util/errutil"
|
|
)
|
|
|
|
// DataSourcePlugin contains all metadata about a datasource plugin
|
|
type DataSourcePlugin struct {
|
|
FrontendPluginBase
|
|
Annotations bool `json:"annotations"`
|
|
Metrics bool `json:"metrics"`
|
|
Alerting bool `json:"alerting"`
|
|
Explore bool `json:"explore"`
|
|
Table bool `json:"tables"`
|
|
Logs bool `json:"logs"`
|
|
Tracing bool `json:"tracing"`
|
|
QueryOptions map[string]bool `json:"queryOptions,omitempty"`
|
|
BuiltIn bool `json:"builtIn,omitempty"`
|
|
Mixed bool `json:"mixed,omitempty"`
|
|
Routes []*AppPluginRoute `json:"routes"`
|
|
Streaming bool `json:"streaming"`
|
|
|
|
Backend bool `json:"backend,omitempty"`
|
|
Executable string `json:"executable,omitempty"`
|
|
SDK bool `json:"sdk,omitempty"`
|
|
}
|
|
|
|
func (p *DataSourcePlugin) Load(decoder *json.Decoder, pluginDir string, backendPluginManager backendplugin.Manager) error {
|
|
if err := decoder.Decode(p); err != nil {
|
|
return errutil.Wrapf(err, "Failed to decode datasource plugin")
|
|
}
|
|
|
|
if err := p.registerPlugin(pluginDir); err != nil {
|
|
return errutil.Wrapf(err, "Failed to register plugin")
|
|
}
|
|
|
|
if p.Backend {
|
|
cmd := ComposePluginStartCommand(p.Executable)
|
|
fullpath := path.Join(p.PluginDir, cmd)
|
|
factory := grpcplugin.NewBackendPlugin(p.Id, fullpath, grpcplugin.PluginStartFuncs{
|
|
OnLegacyStart: p.onLegacyPluginStart,
|
|
OnStart: p.onPluginStart,
|
|
})
|
|
if err := backendPluginManager.Register(p.Id, factory); err != nil {
|
|
return errutil.Wrapf(err, "Failed to register backend plugin")
|
|
}
|
|
}
|
|
|
|
DataSources[p.Id] = p
|
|
return nil
|
|
}
|
|
|
|
func (p *DataSourcePlugin) onLegacyPluginStart(pluginID string, client *grpcplugin.LegacyClient, logger log.Logger) error {
|
|
tsdb.RegisterTsdbQueryEndpoint(pluginID, func(dsInfo *models.DataSource) (tsdb.TsdbQueryEndpoint, error) {
|
|
return wrapper.NewDatasourcePluginWrapper(logger, client.DatasourcePlugin), nil
|
|
})
|
|
|
|
return nil
|
|
}
|
|
|
|
func (p *DataSourcePlugin) onPluginStart(pluginID string, client *grpcplugin.Client, logger log.Logger) error {
|
|
if client.DataPlugin != nil {
|
|
tsdb.RegisterTsdbQueryEndpoint(pluginID, func(dsInfo *models.DataSource) (tsdb.TsdbQueryEndpoint, error) {
|
|
return wrapper.NewDatasourcePluginWrapperV2(logger, p.Id, p.Type, client.DataPlugin), nil
|
|
})
|
|
}
|
|
|
|
return nil
|
|
}
|