Documentation
¶
Overview ¶
Package grpcplugin provides support for serving plugin over gRPC.
This package is internal and meant to be used internally by the SDK and Grafana.
Index ¶
- Constants
- func Serve(opts ServeOpts) error
- type DataClient
- type DataGRPCPlugin
- type DataServer
- type DiagnosticsClient
- type DiagnosticsGRPCPlugin
- type DiagnosticsServer
- type ResourceClient
- type ResourceGRPCPlugin
- type ResourceServer
- type ServeOpts
- type TransformClient
- type TransformDataCallBack
- type TransformGRPCPlugin
- type TransformServer
Constants ¶
const ( // ProtocolVersion is the current (latest) supported protocol version. ProtocolVersion = 2 // MagicCookieKey is the the magic cookie key that will be used for negotiating // between plugin host and client. // Should NEVER be changed. MagicCookieKey = "grafana_plugin_type" // MagicCookieValue is the the magic cookie value that will be used for negotiating // between plugin host and client. // Should NEVER be changed. MagicCookieValue = "datasource" )
Variables ¶
This section is empty.
Functions ¶
Types ¶
type DataClient ¶
type DataClient interface {
pluginv2.DataClient
}
DataClient represents a data client.
type DataGRPCPlugin ¶
type DataGRPCPlugin struct {
plugin.NetRPCUnsupportedPlugin
plugin.GRPCPlugin
DataServer DataServer
}
DataGRPCPlugin implements the GRPCPlugin interface from github.com/hashicorp/go-plugin.
func (*DataGRPCPlugin) GRPCClient ¶
func (p *DataGRPCPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)
GRPCClient returns c as a data gRPC client.
func (*DataGRPCPlugin) GRPCServer ¶
func (p *DataGRPCPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error
GRPCServer registers p as a data gRPC server.
type DataServer ¶
type DataServer interface {
pluginv2.DataServer
}
DataServer represents a data server.
type DiagnosticsClient ¶
type DiagnosticsClient interface {
pluginv2.DiagnosticsClient
}
DiagnosticsClient is the client API for the Diagnostics service.
type DiagnosticsGRPCPlugin ¶
type DiagnosticsGRPCPlugin struct {
plugin.NetRPCUnsupportedPlugin
plugin.GRPCPlugin
DiagnosticsServer DiagnosticsServer
}
DiagnosticsGRPCPlugin implements the GRPCPlugin interface from github.com/hashicorp/go-plugin.
func (*DiagnosticsGRPCPlugin) GRPCClient ¶
func (p *DiagnosticsGRPCPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)
GRPCClient returns c as a diagnostics gRPC client.
func (*DiagnosticsGRPCPlugin) GRPCServer ¶
func (p *DiagnosticsGRPCPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error
GRPCServer registers p as a diagnostics gRPC server.
type DiagnosticsServer ¶
type DiagnosticsServer interface {
pluginv2.DiagnosticsServer
}
DiagnosticsServer is the server API for the Diagnostics service.
type ResourceClient ¶
type ResourceClient interface {
pluginv2.ResourceClient
}
ResourceClient is the client API for the Resource service.
type ResourceGRPCPlugin ¶
type ResourceGRPCPlugin struct {
plugin.NetRPCUnsupportedPlugin
plugin.GRPCPlugin
ResourceServer ResourceServer
}
ResourceGRPCPlugin implements the GRPCPlugin interface from github.com/hashicorp/go-plugin.
func (*ResourceGRPCPlugin) GRPCClient ¶
func (p *ResourceGRPCPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)
GRPCClient returns c as a resource gRPC client.
func (*ResourceGRPCPlugin) GRPCServer ¶
func (p *ResourceGRPCPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error
GRPCServer registers p as a resource gRPC server.
type ResourceServer ¶
type ResourceServer interface {
pluginv2.ResourceServer
}
ResourceServer is the server API for the Resource service.
type ServeOpts ¶
type ServeOpts struct {
DiagnosticsServer DiagnosticsServer
ResourceServer ResourceServer
DataServer DataServer
TransformServer TransformServer
// GRPCServer factory method for creating GRPC server.
// If nil, the default one will be used.
GRPCServer func(options []grpc.ServerOption) *grpc.Server
}
ServeOpts options for serving plugins.
type TransformClient ¶
type TransformClient interface {
TransformData(ctx context.Context, req *pluginv2.QueryDataRequest, callback TransformDataCallBack) (*pluginv2.QueryDataResponse, error)
}
TransformClient represents a client type capable of transforming data.
type TransformDataCallBack ¶
type TransformDataCallBack interface {
// QueryData makes a request to query for data.
QueryData(ctx context.Context, req *pluginv2.QueryDataRequest) (*pluginv2.QueryDataResponse, error)
}
TransformDataCallBack represents a type capable of receiving data transformation callbacks.
type TransformGRPCPlugin ¶
type TransformGRPCPlugin struct {
plugin.NetRPCUnsupportedPlugin
plugin.GRPCPlugin
TransformServer TransformServer
}
TransformGRPCPlugin implements the GRPCPlugin interface from github.com/hashicorp/go-plugin.
func (*TransformGRPCPlugin) GRPCClient ¶
func (p *TransformGRPCPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)
GRPCClient returns c as a transform gRPC client.
func (*TransformGRPCPlugin) GRPCServer ¶
func (p *TransformGRPCPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error
GRPCServer registers p as a transform gRPC server.
type TransformServer ¶
type TransformServer interface {
// TransformData makes a request to transform data.
TransformData(ctx context.Context, req *pluginv2.QueryDataRequest, callback TransformDataCallBack) (*pluginv2.QueryDataResponse, error)
}
TransformServer represents a server type capable of transforming data.
Source Files