status

Documentation

Index

• func Module() fx.Option
• func NewStatus(d proto.Message, e error) *statusv1.Status
• func ParseGroupStatus(statusMap map[string]string, parent string, resp *statusv1.GroupStatus) (map[string]string, error)
• func RegisterStatusService(in RegisterStatusServiceIn)
• type RegisterStatusServiceIn
• type Registry
  • func NewRegistry(logger *log.Logger, alerter alerts.Alerter) Registry
• type StatusService
  • func ProvideStatusService(reg Registry) *StatusService
  • func (svc *StatusService) GetGroupStatus(ctx context.Context, req *statusv1.GroupStatusRequest) (*statusv1.GroupStatus, error)

Functions

func Module

func Module() fx.Option

Module is a fx module that provides a status Registry and registers status service handlers as grpc-gateway handlers.

func NewStatus

func NewStatus(d proto.Message, e error) *statusv1.Status

NewStatus creates a new instance of Status to be pushed into status registry. Use this function for creating status instead of by hand.

func ParseGroupStatus

func ParseGroupStatus(statusMap map[string]string, parent string, resp *statusv1.GroupStatus) (map[string]string, error)

ParseGroupStatus parses GroupStatus response and returns a map of status path to value.

func RegisterStatusService

func RegisterStatusService(in RegisterStatusServiceIn)

RegisterStatusService registers the StatusService implementation with the provided grpc server.

Types

type RegisterStatusServiceIn

type RegisterStatusServiceIn struct {
	fx.In
	Server  *grpc.Server `name:"default"`
	Service *StatusService
}

RegisterStatusServiceIn bundles and annotates parameters.

type Registry

type Registry interface {
	GetStatus() *statusv1.Status
	SetStatus(*statusv1.Status, map[string]string)
	SetGroupStatus(*statusv1.GroupStatus)
	GetGroupStatus() *statusv1.GroupStatus
	Child(key, value string) Registry
	ChildIfExists(key, value string) Registry
	Parent() Registry
	Root() Registry
	Detach()
	Key() string
	Value() string
	URI() string
	HasError() bool
	GetLogger() *log.Logger
	GetAlerter() alerts.Alerter
}

Registry .

func NewRegistry

func NewRegistry(logger *log.Logger, alerter alerts.Alerter) Registry

NewRegistry creates a new Registry.

type StatusService

type StatusService struct {
	statusv1.UnimplementedStatusServiceServer
	// contains filtered or unexported fields
}

StatusService is the implementation of the statusv1.StatusServiceServer interface.

func ProvideStatusService

func ProvideStatusService(reg Registry) *StatusService

ProvideStatusService provides a StatusService implementation.

func (*StatusService) GetGroupStatus

func (svc *StatusService) GetGroupStatus(ctx context.Context, req *statusv1.GroupStatusRequest) (*statusv1.GroupStatus, error)

GetGroupStatus returns the group status for the requested group in the Registry.