health

Documentation

Index

• func ConfigAdd(path string)
• func Register(ctx context.Context, conn *grpc.ClientConn) error
• type Checker
  • func NewChecker(conn *grpc.ClientConn) *Checker
  • func (c *Checker) Check(ctx context.Context) error
• type Health
  • func NewHealth() *Health
  • func NewHealthWithConfigPath(path string) (*Health, error)
  • func NewHealthWithOptions(options *Options) *Health
  • func (i *Health) Register(ctx context.Context, conn *grpc.ClientConn) error
• type Options
  • func NewOptions() (*Options, error)
  • func NewOptionsWithPath(path string) (opts *Options, err error)

Functions

func ConfigAdd

func ConfigAdd(path string)

func Register

func Register(ctx context.Context, conn *grpc.ClientConn) error

Register registers a new health checker plugin for grpc client.

Types

type Checker

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

Checker health checker for grpc client.

func NewChecker

func NewChecker(conn *grpc.ClientConn) *Checker

NewChecker returns a new health checker for grpc client.

func (*Checker) Check

func (c *Checker) Check(ctx context.Context) error

Check check if grpc client is connected.

type Health

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

Health represents health checker plugin for grpc client.

func NewHealth

func NewHealth() *Health

NewHealth returns a new health checker plugin with default options.

func NewHealthWithConfigPath

func NewHealthWithConfigPath(path string) (*Health, error)

NewHealthWithConfigPath returns a new health checker plugin with options from config path.

func NewHealthWithOptions

func NewHealthWithOptions(options *Options) *Health

NewHealthWithOptions returns a new health checker plugin with options.

func (*Health) Register

func (i *Health) Register(ctx context.Context, conn *grpc.ClientConn) error

Register registers this health checker plugin for grpc client.

type Options

type Options struct {
	Name        string
	Enabled     bool
	Description string
	Required    bool
}

Options health checker plugin for grpc client options.

func NewOptions

func NewOptions() (*Options, error)

NewOptions returns options from config file or environment vars.

func NewOptionsWithPath

func NewOptionsWithPath(path string) (opts *Options, err error)

NewOptionsWithPath unmarshals a given key path into options and returns it.