backend

package
v0.77.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 5, 2020 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Overview

Package backend provides SDK handler interfaces and contracts for implementing and serving backend plugins.

Index

Constants

View Source 
const (
	// PluginProfilerEnv is a constant for the GF_PLUGINS_PROFILER environment variable used to enable pprof.
	PluginProfilerEnv = "GF_PLUGINS_PROFILER"

	// PluginProfilerPortEnv is a constant for the GF_PLUGINS_PROFILER_PORT environment variable use to specify a pprof port (default 6060).
	PluginProfilerPortEnv = "GF_PLUGINS_PROFILER_PORT"
)

Variables

View Source 
var Logger log.Logger = log.DefaultLogger

Logger is the default logger instance. This can be used directly to log from your plugin to grafana-server with calls like backend.Logger.Debug(...).

Functions

func Serve 

func Serve(opts ServeOpts) error

Serve starts serving the plugin over gRPC.

func SetupPluginEnvironment 

func SetupPluginEnvironment(pluginID string)

SetupPluginEnvironment will read the environment variables and apply the standard environment behavior.

As the SDK evolves, this will likely change.

Currently this function enables and configures profiling with pprof.

Types

type AppInstanceSettings 

type AppInstanceSettings struct {
	// JSONData repeats the properties at this level of the object (excluding DataSourceConfig), and also includes any
	//custom properties associated with the plugin config instance.
	JSONData json.RawMessage

	// DecryptedSecureJSONData contains key,value pairs where the encrypted configuration plugin instance in Grafana
	//server have been decrypted before passing them to the plugin.
	DecryptedSecureJSONData map[string]string

	// Updated is the last time this plugin instance's configuration was updated.
	Updated time.Time
}

AppInstanceSettings represents settings for an app instance.

In Grafana an app instance is an app plugin of certain type that have been configured and enabled in a Grafana organization.

type CallResourceHandler 

type CallResourceHandler interface {
	CallResource(ctx context.Context, req *CallResourceRequest, sender CallResourceResponseSender) error
}

CallResourceHandler handles resource calls.

type CallResourceHandlerFunc 

type CallResourceHandlerFunc func(ctx context.Context, req *CallResourceRequest, sender CallResourceResponseSender) error

CallResourceHandlerFunc is an adapter to allow the use of ordinary functions as backend.CallResourceHandler. If f is a function with the appropriate signature, CallResourceHandlerFunc(f) is a Handler that calls f.

func (CallResourceHandlerFunc) CallResource 

func (fn CallResourceHandlerFunc) CallResource(ctx context.Context, req *CallResourceRequest, sender CallResourceResponseSender) error

CallResource calls fn(ctx, req, sender).

type CallResourceRequest 

type CallResourceRequest struct {
	PluginContext PluginContext
	Path          string
	Method        string
	URL           string
	Headers       map[string][]string
	Body          []byte
}

CallResourceRequest represents a request for a resource call.

type CallResourceResponse 

type CallResourceResponse struct {
	Status  int
	Headers map[string][]string
	Body    []byte
}

CallResourceResponse represents a response from a resource call.

type CallResourceResponseSender 

type CallResourceResponseSender interface {
	Send(*CallResourceResponse) error
}

CallResourceResponseSender is used for sending resource call responses.

type CheckHealthHandler 

type CheckHealthHandler interface {
	CheckHealth(ctx context.Context, req *CheckHealthRequest) (*CheckHealthResult, error)
}

CheckHealthHandler enables users to send health check requests to a backend plugin

type CheckHealthHandlerFunc 

type CheckHealthHandlerFunc func(ctx context.Context, req *CheckHealthRequest) (*CheckHealthResult, error)

CheckHealthHandlerFunc is an adapter to allow the use of ordinary functions as backend.CheckHealthHandler. If f is a function with the appropriate signature, CheckHealthHandlerFunc(f) is a Handler that calls f.

func (CheckHealthHandlerFunc) CheckHealth 

func (fn CheckHealthHandlerFunc) CheckHealth(ctx context.Context, req *CheckHealthRequest) (*CheckHealthResult, error)

CheckHealth calls fn(ctx, req).

type CheckHealthRequest 

type CheckHealthRequest struct {
	PluginContext PluginContext
}

CheckHealthRequest contains the healthcheck request

type CheckHealthResult 

type CheckHealthResult struct {
	Status      HealthStatus
	Message     string
	JSONDetails []byte
}

CheckHealthResult contains the healthcheck response

type CollectMetricsHandler 

type CollectMetricsHandler interface {
	CollectMetrics(ctx context.Context) (*CollectMetricsResult, error)
}

CollectMetricsHandler handles metric collection.

type CollectMetricsHandlerFunc 

type CollectMetricsHandlerFunc func(ctx context.Context) (*CollectMetricsResult, error)

CollectMetricsHandlerFunc is an adapter to allow the use of ordinary functions as backend.CollectMetricsHandler. If f is a function with the appropriate signature, CollectMetricsHandlerFunc(f) is a Handler that calls f.

func (CollectMetricsHandlerFunc) CollectMetrics 

func (fn CollectMetricsHandlerFunc) CollectMetrics(ctx context.Context) (*CollectMetricsResult, error)

CollectMetrics calls fn(ctx, req).

type CollectMetricsResult 

type CollectMetricsResult struct {
	PrometheusMetrics []byte
}

CollectMetricsResult collect metrics result.

type ConvertFromProtobuf 

type ConvertFromProtobuf struct{}

ConvertFromProtobuf has a collection of methods for converting from the autogenerated protobuf go code to our SDK objects. This object exists to attach a collection of conversion methods to.

This is used internally by the SDK and inside Grafana-server, plugin authors should not need this functionality.

func FromProto 

func FromProto() ConvertFromProtobuf

FromProto returns a new ConvertFromProtobuf.

func (ConvertFromProtobuf) AppInstanceSettings 

func (f ConvertFromProtobuf) AppInstanceSettings(proto *pluginv2.AppInstanceSettings) *AppInstanceSettings

AppInstanceSettings converts protobuf version of an AppInstanceSettings to the SDK version.

func (ConvertFromProtobuf) CallResourceRequest 

func (f ConvertFromProtobuf) CallResourceRequest(protoReq *pluginv2.CallResourceRequest) *CallResourceRequest

CallResourceRequest converts protobuf version of a CallResourceRequest to the SDK version.

func (ConvertFromProtobuf) CallResourceResponse 

func (f ConvertFromProtobuf) CallResourceResponse(protoResp *pluginv2.CallResourceResponse) *CallResourceResponse

CallResourceResponse converts protobuf version of a CallResourceResponse to the SDK version.

func (ConvertFromProtobuf) CheckHealthRequest 

func (f ConvertFromProtobuf) CheckHealthRequest(protoReq *pluginv2.CheckHealthRequest) *CheckHealthRequest

CheckHealthRequest converts protobuf version of a CheckHealthRequest to the SDK version.

func (ConvertFromProtobuf) CheckHealthResponse 

func (f ConvertFromProtobuf) CheckHealthResponse(protoResp *pluginv2.CheckHealthResponse) *CheckHealthResult

CheckHealthResponse converts protobuf version of a HealthCheckResponse to the SDK version.

func (ConvertFromProtobuf) CollectMetricsResponse 

func (f ConvertFromProtobuf) CollectMetricsResponse(protoResp *pluginv2.CollectMetricsResponse) *CollectMetricsResult

CollectMetricsResponse converts protobuf version of a CollectMetricsResponse to the SDK version.

func (ConvertFromProtobuf) DataQuery 

func (f ConvertFromProtobuf) DataQuery(proto *pluginv2.DataQuery) *DataQuery

DataQuery converts protobuf version of a DataQuery to the SDK version.

func (ConvertFromProtobuf) DataSourceInstanceSettings 

func (f ConvertFromProtobuf) DataSourceInstanceSettings(proto *pluginv2.DataSourceInstanceSettings) *DataSourceInstanceSettings

DataSourceInstanceSettings converts protobuf version of a DataSourceInstanceSettings to the SDK version.

func (ConvertFromProtobuf) PluginContext 

func (f ConvertFromProtobuf) PluginContext(proto *pluginv2.PluginContext) PluginContext

PluginContext converts protobuf version of a PluginContext to the SDK version.

func (ConvertFromProtobuf) QueryDataRequest 

func (f ConvertFromProtobuf) QueryDataRequest(protoReq *pluginv2.QueryDataRequest) *QueryDataRequest

QueryDataRequest converts protobuf version of a QueryDataRequest to the SDK version.

func (ConvertFromProtobuf) QueryDataResponse 

func (f ConvertFromProtobuf) QueryDataResponse(protoRes *pluginv2.QueryDataResponse) (*QueryDataResponse, error)

QueryDataResponse converts protobuf version of a QueryDataResponse to the SDK version.

func (ConvertFromProtobuf) TimeRange 

func (f ConvertFromProtobuf) TimeRange(proto *pluginv2.TimeRange) TimeRange

TimeRange converts protobuf version of a TimeRange to the SDK version.

func (ConvertFromProtobuf) User 

func (f ConvertFromProtobuf) User(user *pluginv2.User) *User

User converts protobuf version of a User to the SDK version.

type ConvertToProtobuf 

type ConvertToProtobuf struct{}

ConvertToProtobuf has a collection of methods for converting the autogenerated protobuf go code to our SDK objects. This object exists to attach a collection of conversion methods to.

This is used internally by the SDK and inside Grafana-server, plugin authors should not need this functionality.

func ToProto 

func ToProto() ConvertToProtobuf

ToProto returns a new ConvertToProtobuf.

func (ConvertToProtobuf) AppInstanceSettings 

func (t ConvertToProtobuf) AppInstanceSettings(s *AppInstanceSettings) *pluginv2.AppInstanceSettings

AppInstanceSettings converts the SDK version of an AppInstanceSettings to the protobuf version.

func (ConvertToProtobuf) CallResourceRequest 

func (t ConvertToProtobuf) CallResourceRequest(req *CallResourceRequest) *pluginv2.CallResourceRequest

CallResourceRequest converts the SDK version of a CallResourceRequest to the protobuf version.

func (ConvertToProtobuf) CallResourceResponse 

func (t ConvertToProtobuf) CallResourceResponse(resp *CallResourceResponse) *pluginv2.CallResourceResponse

CallResourceResponse converts the SDK version of a CallResourceResponse to the protobuf version.

func (ConvertToProtobuf) CheckHealthResponse 

func (t ConvertToProtobuf) CheckHealthResponse(res *CheckHealthResult) *pluginv2.CheckHealthResponse

CheckHealthResponse converts the SDK version of a CheckHealthResponse to the protobuf version.

func (ConvertToProtobuf) DataQuery 

func (t ConvertToProtobuf) DataQuery(q DataQuery) *pluginv2.DataQuery

DataQuery converts the SDK version of a DataQuery to the protobuf version.

func (ConvertToProtobuf) DataSourceInstanceSettings 

func (t ConvertToProtobuf) DataSourceInstanceSettings(s *DataSourceInstanceSettings) *pluginv2.DataSourceInstanceSettings

DataSourceInstanceSettings converts the SDK version of a DataSourceInstanceSettings to the protobuf version.

func (ConvertToProtobuf) HealthStatus 

func (t ConvertToProtobuf) HealthStatus(status HealthStatus) pluginv2.CheckHealthResponse_HealthStatus

HealthStatus converts the SDK version of a HealthStatus to the protobuf version.

func (ConvertToProtobuf) PluginContext 

func (t ConvertToProtobuf) PluginContext(pluginCtx PluginContext) *pluginv2.PluginContext

PluginContext converts the SDK version of a PluginContext to the protobuf version.

func (ConvertToProtobuf) QueryDataRequest 

func (t ConvertToProtobuf) QueryDataRequest(req *QueryDataRequest) *pluginv2.QueryDataRequest

QueryDataRequest converts the SDK version of a QueryDataRequest to the protobuf version.

func (ConvertToProtobuf) QueryDataResponse 

func (t ConvertToProtobuf) QueryDataResponse(res *QueryDataResponse) (*pluginv2.QueryDataResponse, error)

QueryDataResponse converts the SDK version of a QueryDataResponse to the protobuf version. It will set the RefID on the frames to the RefID key in Responses if a Frame's RefId property is an empty string.

func (ConvertToProtobuf) TimeRange 

func (t ConvertToProtobuf) TimeRange(tr TimeRange) *pluginv2.TimeRange

TimeRange converts the SDK version of a TimeRange to the protobuf version.

func (ConvertToProtobuf) User 

func (t ConvertToProtobuf) User(user *User) *pluginv2.User

User converts the SDK version of a User to the protobuf version.

type DataQuery 

type DataQuery struct {
	// RefID is the unique identifier of the query, set by the frontend call.
	RefID string

	// QueryType is an optional identifier for the type of query.
	// It can be used to distinguish different types of queries.
	QueryType string

	// MaxDataPoints is the maximum number of datapoints that should be returned from a time series query.
	MaxDataPoints int64

	// Interval is the suggested duration between time points in a time series query.
	Interval time.Duration

	// TimeRange is the Start and End of the query as sent by the frontend.
	TimeRange TimeRange

	// JSON is the raw JSON query and includes the above properties as well as custom properties.
	JSON json.RawMessage
}

DataQuery represents a single query as sent from the frontend. A slice of DataQuery makes up the Queries property of a QueryDataRequest.

type DataResponse 

type DataResponse struct {
	// The data returned from the Query. Each Frame repeats the RefID.
	Frames data.Frames

	// Error is a property to be set if the the corresponding DataQuery has an error.
	Error error
}

DataResponse contains the results from a DataQuery. A map of RefIDs (unique query identifers) to this type makes up the Responses property of a QueryDataResponse. The Error property is used to allow for partial success responses from the containing QueryDataResponse.

type DataSourceInstanceSettings 

type DataSourceInstanceSettings struct {
	// ID is the Grafana assigned numeric identifier of the the data source instance.
	ID int64

	// Name is the configured name of the data source instance.
	Name string

	// URL is the configured URL of a data source instance (e.g. the URL of an API endpoint).
	URL string

	// User is a configured user for a data source instance. This is not a Grafana user, rather an arbitrary string.
	User string

	// Database is the configured database for a data source instance. (e.g. the default Database a SQL data source would connect to).
	Database string

	// BasicAuthEnabled indicates if this data source instance should use basic authentication.
	BasicAuthEnabled bool

	// BasicAuthUser is the configured user for basic authentication. (e.g. when a data source uses basic
	// authentication to connect to whatever API it fetches data from).
	BasicAuthUser string

	// JSONData contains the raw DataSourceConfig as JSON as stored by Grafana server. It repeats the properties in
	// this object and includes custom properties.
	JSONData json.RawMessage

	// DecryptedSecureJSONData contains key,value pairs where the encrypted configuration in Grafana server have been
	// decrypted before passing them to the plugin.
	DecryptedSecureJSONData map[string]string

	// Updated is the last time the configuration for the data source instance was updated.
	Updated time.Time
}

DataSourceInstanceSettings represents settings for a data source instance.

In Grafana a data source instance is a data source plugin of certain type that have been configured and created in a Grafana organization.

type GRPCSettings 

type GRPCSettings struct {
	// MaxReceiveMsgSize the max gRPC message size in bytes the plugin can receive.
	// If this is <= 0, gRPC uses the default 16MB.
	MaxReceiveMsgSize int

	// MaxSendMsgSize the max gRPC message size in bytes the plugin can send.
	// If this is <= 0, gRPC uses the default `math.MaxInt32`.
	MaxSendMsgSize int
}

GRPCSettings settings for gRPC.

type HealthStatus 

type HealthStatus int

HealthStatus is the status of the plugin. 

const (
	// HealthStatusUnknown means the status of the plugin is unknown.
	HealthStatusUnknown HealthStatus = iota

	// HealthStatusOk means the status of the plugin is good.
	HealthStatusOk

	// HealthStatusError means the plugin is in an error state.
	HealthStatusError
)

func (HealthStatus) String 

func (hs HealthStatus) String() string

String textual represntation of the status.

type PluginContext 

type PluginContext struct {
	// OrgID is The Grafana organization identifier the request originating from.
	OrgID int64

	// PluginID is the unique identifier of the plugin that the request is for.
	PluginID string

	// User is the Grafana user making the request.
	//
	// Will not be provided if Grafana backend initiated the request,
	// for example when request is coming from Grafana Alerting.
	User *User

	// AppInstanceSettings is the configured app instance settings.
	//
	// In Grafana an app instance is an app plugin of certain
	// type that have been configured and enabled in a Grafana organization.
	//
	// Will only be set if request targeting an app instance.
	AppInstanceSettings *AppInstanceSettings

	// DataSourceConfig is the configured data source instance
	// settings.
	//
	// In Grafana a data source instance is a data source plugin of certain
	// type that have been configured and created in a Grafana organization.
	//
	// Will only be set if request targeting a data source instance.
	DataSourceInstanceSettings *DataSourceInstanceSettings
}

PluginContext holds contextual information about a plugin request, such as Grafana organization, user and plugin instance settings.

type QueryDataHandler 

type QueryDataHandler interface {
	// QueryData handles multiple queries and returns multiple responses.
	// req contains the queries []DataQuery (where each query contains RefID as a unique identifier).
	// The QueryDataResponse contains a map of RefID to the response for each query, and each response
	// contains Frames ([]*Frame).
	//
	// The Frames' RefID property, when it is an empty string, will be automatically set to
	// the RefID in QueryDataResponse.Responses map. This is done before the QueryDataResponse is
	// sent to Grafana. Therefore one does not need to be set that property on frames when using this method.
	QueryData(ctx context.Context, req *QueryDataRequest) (*QueryDataResponse, error)
}

QueryDataHandler handles data queries.

type QueryDataHandlerFunc 

type QueryDataHandlerFunc func(ctx context.Context, req *QueryDataRequest) (*QueryDataResponse, error)

QueryDataHandlerFunc is an adapter to allow the use of ordinary functions as backend.QueryDataHandler. If f is a function with the appropriate signature, QueryDataHandlerFunc(f) is a Handler that calls f.

func (QueryDataHandlerFunc) QueryData 

func (fn QueryDataHandlerFunc) QueryData(ctx context.Context, req *QueryDataRequest) (*QueryDataResponse, error)

QueryData calls fn(ctx, req).

type QueryDataRequest 

type QueryDataRequest struct {
	PluginContext PluginContext
	Headers       map[string]string
	Queries       []DataQuery
}

QueryDataRequest contains a single request which contains multiple queries. It is the input type for a QueryData call.

type QueryDataResponse 

type QueryDataResponse struct {
	// Responses is a map of RefIDs (Unique Query ID) to *DataResponse.
	Responses Responses
}

QueryDataResponse contains the results from a QueryDataRequest. It is the return type of a QueryData call.

func NewQueryDataResponse 

func NewQueryDataResponse() *QueryDataResponse

NewQueryDataResponse returns a QueryDataResponse with the Responses property initialized.

type Responses 

type Responses map[string]DataResponse

Responses is a map of RefIDs (Unique Query ID) to DataResponses. The QueryData method the QueryDataHandler method will set the RefId property on the DataRespones' frames based on these RefIDs.

type ServeOpts 

type ServeOpts struct {
	// CheckHealthHandler handler for health checks.
	CheckHealthHandler CheckHealthHandler

	// CallResourceHandler handler for resource calls.
	// Optional to implement.
	CallResourceHandler CallResourceHandler

	// QueryDataHandler handler for data queries.
	// Required to implement if data source.
	QueryDataHandler QueryDataHandler

	// TransformDataHandler handler for data transformations.
	// Very experimental and shouldn't be implemented in most cases.
	// Optional to implement.
	TransformDataHandler TransformDataHandler

	// GRPCSettings settings for gPRC.
	GRPCSettings GRPCSettings
}

ServeOpts options for serving plugins.

type TimeRange 

type TimeRange struct {
	// From is the start time of the query.
	From time.Time

	// To is the end time of the query.
	To time.Time
}

TimeRange represents a time range for a query and is a property of DataQuery.

func (TimeRange) Duration 

func (tr TimeRange) Duration() time.Duration

Duration returns a time.Duration representing the amount of time between From and To.

type TransformDataCallBackHandler 

type TransformDataCallBackHandler interface {
	// QueryData is a data transformation callback for querying for data.
	// TODO: Forget if I actually need PluginConfig on the callback or not.
	QueryData(ctx context.Context, req *QueryDataRequest) (*QueryDataResponse, error)
}

TransformDataCallBackHandler is a type that can handle callbacks from TransformDataHandler.

type TransformDataHandler 

type TransformDataHandler interface {
	// TransformData transforms query results and return them to the host.
	TransformData(ctx context.Context, req *QueryDataRequest, callBack TransformDataCallBackHandler) (*QueryDataResponse, error)
}

TransformDataHandler is a type that can transform data.

type TransformHandlers 

type TransformHandlers interface {
	TransformDataHandler
}

TransformHandlers handles data transforms

type User 

type User struct {
	Login string
	Name  string
	Email string
	Role  string
}

User represents a Grafana user.

Source Files

View all Source files

Directories

Path Synopsis
Package datasource provides utilities for creating and serving a data source plugin over gRPC.
 Package datasource provides utilities for creating and serving a data source plugin over gRPC.
Package grpcplugin provides support for serving plugin over gRPC.
 Package grpcplugin provides support for serving plugin over gRPC.
Package instancemgmt provides utilities for managing plugin instances.
 Package instancemgmt provides utilities for managing plugin instances.
Package log provides a logging interface to send logs from plugins to Grafana server.
 Package log provides a logging interface to send logs from plugins to Grafana server.
Package resource provides utils for handling resource calls.
 Package resource provides utils for handling resource calls.
httpadapter
Package httpadapter provides support for handling resource calls using an http.Handler.
 Package httpadapter provides support for handling resource calls using an http.Handler.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.