plugin

Apr 25, 2025

Changes in this version

+ const RegisterFuncName

+ var Handshake = pluginhc.HandshakeConfig

+ func IncidentToProto(incident models.Incident) *proto.Incident

+ func NotifyRequestToProto(notifyRequest *models.NotifyRequest) *proto.NotifyRequest

+ func ProtoToIncident(incident *proto.Incident) models.Incident

+ func ProtoToNotifyRequest(notifyRequest *proto.NotifyRequest) *models.NotifyRequest

+ type Base struct

+ BaseInfo config.BaseInfo

+ Params map[string]interface{}

+ type GRPCClient struct

+ func (m *GRPCClient) Description() (string, error)

+ func (m *GRPCClient) Id() (string, error)

+ func (m *GRPCClient) Init(baseInfo config.BaseInfo, params map[string]interface{}) error

+ func (m *GRPCClient) MetadataFields() ([]models.MetadataField, error)

+ func (m *GRPCClient) Name() (string, error)

+ func (m *GRPCClient) Notify(notifyReq *models.NotifyRequest) error

+ func (m *GRPCClient) PreCheck(incident *models.Incident) error

+ type GRPCServer struct

+ Impl Notifier

+ func (s *GRPCServer) Description(ctx context.Context, empty *emptypb.Empty) (*proto.DescriptionResponse, error)

+ func (s *GRPCServer) Id(ctx context.Context, request *emptypb.Empty) (*proto.IdResponse, error)

+ func (s *GRPCServer) Init(ctx context.Context, request *proto.InitRequest) (*emptypb.Empty, error)

+ func (s *GRPCServer) MetadataFields(ctx context.Context, request *emptypb.Empty) (*proto.ListMetadataField, error)

+ func (s *GRPCServer) Name(ctx context.Context, request *emptypb.Empty) (*proto.NameResponse, error)

+ func (s *GRPCServer) Notify(ctx context.Context, request *proto.NotifyRequest) (*proto.ErrorResponse, error)

+ func (s *GRPCServer) PreCheck(ctx context.Context, request *proto.NotifyRequest) (*proto.ErrorResponse, error)

+ type Notifier interface

+ Description func() (string, error)

+ Id func() (string, error)

+ Init func(baseInfo config.BaseInfo, params map[string]interface{}) error

+ MetadataFields func() ([]models.MetadataField, error)

+ Name func() (string, error)

+ Notify func(notifyReq *models.NotifyRequest) error

+ PreCheck func(incident *models.Incident) error

+ type NotifierGRPCPlugin struct

+ Impl Notifier

+ func (p *NotifierGRPCPlugin) GRPCClient(ctx context.Context, broker *pluginhc.GRPCBroker, c *grpc.ClientConn) (interface{}, error)

+ func (p *NotifierGRPCPlugin) GRPCServer(broker *pluginhc.GRPCBroker, s *grpc.Server) error

+ type Plugin struct

+ BaseRequest Base

+ func (n *Plugin) Creator(params map[string]interface{}, baseInfo config.BaseInfo) (notifiers.Notifier, error)

+ func (n *Plugin) Description() string

+ func (n *Plugin) Id() string

+ func (n *Plugin) MetadataFields() []models.MetadataField

+ func (n *Plugin) Name() string

+ func (n *Plugin) Notify(notifyReq *models.NotifyRequest) error

+ func (n *Plugin) PreCheck(incident *models.Incident) error