health

Documentation

Index

• type Client
  • func (client *Client) Live(ctx context.Context) (bool, error)
  • func (client *Client) Ready(ctx context.Context) (bool, error)
• type ClientInterface
  • func NewHealthClient(ctx context.Context, config config.Config, livenessValidator Validator) (ClientInterface, error)
• type Validator

Types

type Client

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

Client ...

func (*Client) Live

func (client *Client) Live(ctx context.Context) (bool, error)

Live ...

func (*Client) Ready

func (client *Client) Ready(ctx context.Context) (bool, error)

Ready ...

type ClientInterface

type ClientInterface interface {
	Ready(ctx context.Context) (bool, error)
	Live(ctx context.Context) (bool, error)
}

ClientInterface ...

func NewHealthClient

func NewHealthClient(ctx context.Context, config config.Config, livenessValidator Validator) (ClientInterface, error)

NewHealthClient ...

type Validator

type Validator interface {
	Valid(ctx context.Context) bool
}

Validator ...