mirror of
https://github.com/grafana/grafana.git
synced 2025-02-09 23:16:16 -06:00
94edd7a762
Moves/refactor Grafana specific functionality related to plugin dashboards out to specific services for importing dashboards and keep app plugin dashboards up-to-date. Fixes #44257
101 lines
3.4 KiB
Go
101 lines
3.4 KiB
Go
package plugins
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/grafana/grafana-plugin-sdk-go/backend"
|
|
|
|
"github.com/grafana/grafana/pkg/models"
|
|
"github.com/grafana/grafana/pkg/plugins/backendplugin"
|
|
)
|
|
|
|
// Store is the storage for plugins.
|
|
type Store interface {
|
|
// Plugin finds a plugin by its ID.
|
|
Plugin(ctx context.Context, pluginID string) (PluginDTO, bool)
|
|
// Plugins returns plugins by their requested type.
|
|
Plugins(ctx context.Context, pluginTypes ...Type) []PluginDTO
|
|
// Add adds a plugin to the store.
|
|
Add(ctx context.Context, pluginID, version string) error
|
|
// Remove removes a plugin from the store.
|
|
Remove(ctx context.Context, pluginID string) error
|
|
}
|
|
|
|
// Loader is responsible for loading plugins from the file system.
|
|
type Loader interface {
|
|
// Load will return a list of plugins found in the provided file system paths.
|
|
Load(ctx context.Context, class Class, paths []string, ignore map[string]struct{}) ([]*Plugin, error)
|
|
}
|
|
|
|
// Installer is responsible for managing plugins (add / remove) on the file system.
|
|
type Installer interface {
|
|
// Install downloads the requested plugin in the provided file system location.
|
|
Install(ctx context.Context, pluginID, version, pluginsDir, pluginZipURL, pluginRepoURL string) error
|
|
// Uninstall removes the requested plugin from the provided file system location.
|
|
Uninstall(ctx context.Context, pluginDir string) error
|
|
// GetUpdateInfo provides update information for the requested plugin.
|
|
GetUpdateInfo(ctx context.Context, pluginID, version, pluginRepoURL string) (UpdateInfo, error)
|
|
}
|
|
|
|
type UpdateInfo struct {
|
|
PluginZipURL string
|
|
}
|
|
|
|
// Client is used to communicate with backend plugin implementations.
|
|
type Client interface {
|
|
backend.QueryDataHandler
|
|
backend.CheckHealthHandler
|
|
backend.StreamHandler
|
|
backend.CallResourceHandler
|
|
|
|
// CollectMetrics collects metrics from a plugin.
|
|
CollectMetrics(ctx context.Context, pluginID string) (*backend.CollectMetricsResult, error)
|
|
}
|
|
|
|
// BackendFactoryProvider provides a backend factory for a provided plugin.
|
|
type BackendFactoryProvider interface {
|
|
BackendFactory(ctx context.Context, p *Plugin) backendplugin.PluginFactoryFunc
|
|
}
|
|
|
|
type RendererManager interface {
|
|
// Renderer returns a renderer plugin.
|
|
Renderer() *Plugin
|
|
}
|
|
|
|
type StaticRouteResolver interface {
|
|
Routes() []*StaticRoute
|
|
}
|
|
|
|
type ErrorResolver interface {
|
|
PluginErrors() []*Error
|
|
}
|
|
|
|
type PluginLoaderAuthorizer interface {
|
|
// CanLoadPlugin confirms if a plugin is authorized to load
|
|
CanLoadPlugin(plugin *Plugin) bool
|
|
}
|
|
|
|
type PluginDashboardInfoDTO struct {
|
|
UID string `json:"uid"`
|
|
PluginId string `json:"pluginId"`
|
|
Title string `json:"title"`
|
|
Imported bool `json:"imported"`
|
|
ImportedUri string `json:"importedUri"`
|
|
ImportedUrl string `json:"importedUrl"`
|
|
Slug string `json:"slug"`
|
|
DashboardId int64 `json:"dashboardId"`
|
|
FolderId int64 `json:"folderId"`
|
|
ImportedRevision int64 `json:"importedRevision"`
|
|
Revision int64 `json:"revision"`
|
|
Description string `json:"description"`
|
|
Path string `json:"path"`
|
|
Removed bool `json:"removed"`
|
|
}
|
|
|
|
type PluginDashboardManager interface {
|
|
// GetPluginDashboards gets dashboards for a certain org/plugin.
|
|
GetPluginDashboards(ctx context.Context, orgID int64, pluginID string) ([]*PluginDashboardInfoDTO, error)
|
|
// LoadPluginDashboard loads a plugin dashboard.
|
|
LoadPluginDashboard(ctx context.Context, pluginID, path string) (*models.Dashboard, error)
|
|
}
|