shared

Documentation

Index

• Variables
• type GRPCClient
  • func (plugin *GRPCClient) WriteKafkaMetrics(m []any) error
• type GRPCServer
  • func (s *GRPCServer) WriteKafkaMetrics(ctx context.Context, in *proto.WriteKafkaMetricsRequest) (*proto.Empty, error)
• type KafkaGRPCPlugin
  • func (p *KafkaGRPCPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (any, error)
  • func (p *KafkaGRPCPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error
• type KafkaPlugin

Variables

var Handshake = plugin.HandshakeConfig{

	ProtocolVersion:  1,
	MagicCookieKey:   "KAFKA_OFFSET_PLUGIN",
	MagicCookieValue: "kafka-offset",
}

Handshake is a common handshake that is shared by plugin and host.

var PluginMap = map[string]plugin.Plugin{
	"kafka_grpc": &KafkaGRPCPlugin{},
}

PluginMap is the map of plugins we can dispense.

Types

type GRPCClient

type GRPCClient struct {
	// contains filtered or unexported fields
}

GRPCClient is an implementation of KV that talks over RPC.

func (*GRPCClient) WriteKafkaMetrics

func (plugin *GRPCClient) WriteKafkaMetrics(m []any) error

WriteKafkaMetrics send to grpc server proto.KafkaGauge & proto.KafkaMeter

type GRPCServer

type GRPCServer struct {
	// This is the real implementation
	Impl KafkaPlugin

	proto.UnimplementedKafkaPluginServer
}

GRPCServer gRPC server that GRPCClient talks to.

func (*GRPCServer) WriteKafkaMetrics

func (s *GRPCServer) WriteKafkaMetrics(ctx context.Context, in *proto.WriteKafkaMetricsRequest) (*proto.Empty, error)

WriteKafkaMetrics send to plugin proto.KafkaGauge & proto.KafkaMeter

type KafkaGRPCPlugin

type KafkaGRPCPlugin struct {
	// GRPCPlugin must still implement the Plugin interface
	plugin.Plugin
	// Concrete implementation, written in Go. This is only used for plugins
	// that are written in Go.
	Impl KafkaPlugin
}

KafkaGRPCPlugin go-plugin struct to make of plugin

func (*KafkaGRPCPlugin) GRPCClient

func (p *KafkaGRPCPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (any, error)

GRPCClient build GRPC client over go-plugin

func (*KafkaGRPCPlugin) GRPCServer

func (p *KafkaGRPCPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error

GRPCServer register kafka plugin over GRPC

type KafkaPlugin

type KafkaPlugin interface {
	WriteKafkaMetrics([]any) error
}

KafkaPlugin interface of sink plugin