health

Documentation

Index

• func NewMaterializerRequest(srvReq structs.ServiceSpecificRequest) func(index uint64) *pbsubscribe.SubscribeRequest
• type CacheGetter
• type Client
  • func (c *Client) Close() error
  • func (c *Client) IsReadyForStreaming() bool
  • func (c *Client) Notify(ctx context.Context, req structs.ServiceSpecificRequest, correlationID string, ...) error
  • func (c *Client) ServiceNodes(ctx context.Context, req structs.ServiceSpecificRequest) (structs.IndexedCheckServiceNodes, cache.ResultMeta, error)
• type HealthView
  • func NewHealthView(req structs.ServiceSpecificRequest) (*HealthView, error)
  • func (s *HealthView) Reset()
  • func (s *HealthView) Result(index uint64) interface{}
  • func (s *HealthView) Update(events []*pbsubscribe.Event) error
• type MaterializedViewStore
• type MaterializerDeps
• type NetRPC

Functions

func NewMaterializerRequest

func NewMaterializerRequest(srvReq structs.ServiceSpecificRequest) func(index uint64) *pbsubscribe.SubscribeRequest

Types

type CacheGetter

type CacheGetter interface {
	Get(ctx context.Context, t string, r cache.Request) (interface{}, cache.ResultMeta, error)
	NotifyCallback(ctx context.Context, t string, r cache.Request, cID string, cb cache.Callback) error
}

type Client

type Client struct {
	NetRPC              NetRPC
	Cache               CacheGetter
	ViewStore           MaterializedViewStore
	MaterializerDeps    MaterializerDeps
	CacheName           string
	UseStreamingBackend bool
	QueryOptionDefaults func(options *structs.QueryOptions)
}

Client provides access to service health data.

func (*Client) Close

func (c *Client) Close() error

Close any underlying connections used by the client.

func (*Client) IsReadyForStreaming

func (c *Client) IsReadyForStreaming() bool

IsReadyForStreaming will indicate if the underlying gRPC connection is ready.

func (*Client) Notify

func (c *Client) Notify(
	ctx context.Context,
	req structs.ServiceSpecificRequest,
	correlationID string,
	cb cache.Callback,
) error

func (*Client) ServiceNodes

func (c *Client) ServiceNodes(
	ctx context.Context,
	req structs.ServiceSpecificRequest,
) (structs.IndexedCheckServiceNodes, cache.ResultMeta, error)

type HealthView

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

HealthView implements submatview.View for storing the view state of a service health result. We store it as a map to make updates and deletions a little easier but we could just store a result type (IndexedCheckServiceNodes) and update it in place for each event - that involves re-sorting each time etc. though.

func NewHealthView

func NewHealthView(req structs.ServiceSpecificRequest) (*HealthView, error)

func (*HealthView) Reset

func (s *HealthView) Reset()

func (*HealthView) Result

func (s *HealthView) Result(index uint64) interface{}

Result returns the structs.IndexedCheckServiceNodes stored by this view.

func (*HealthView) Update

func (s *HealthView) Update(events []*pbsubscribe.Event) error

Update implements View

type MaterializedViewStore

type MaterializedViewStore interface {
	Get(ctx context.Context, req submatview.Request) (submatview.Result, error)
	NotifyCallback(ctx context.Context, req submatview.Request, cID string, cb cache.Callback) error
}

type MaterializerDeps

type MaterializerDeps struct {
	Conn   *grpc.ClientConn
	Logger hclog.Logger
}

type NetRPC

type NetRPC interface {
	RPC(method string, args interface{}, reply interface{}) error
}