health

Documentation

Index

• func ClientRegister(ctx context.Context, client *redis.Client) error
• func ClusterRegister(ctx context.Context, client *redis.ClusterClient) error
• func ConfigAdd(path string)
• type ClientChecker
  • func NewClientChecker(client *redis.Client) *ClientChecker
  • func (c *ClientChecker) Check(ctx context.Context) error
• type ClientHealth
  • func NewClientHealth() (*ClientHealth, error)
  • func NewClientHealthWithConfigPath(path string) (*ClientHealth, error)
  • func NewClientHealthWithOptions(options *Options) *ClientHealth
  • func (i *ClientHealth) Register(ctx context.Context, client *redis.Client) error
• type ClusterClientChecker
  • func NewClusterClientChecker(client *redis.ClusterClient) *ClusterClientChecker
  • func (c *ClusterClientChecker) Check(ctx context.Context) error
• type ClusterHealth
  • func NewClusterHealth() (*ClusterHealth, error)
  • func NewClusterHealthWithConfigPath(path string) (*ClusterHealth, error)
  • func NewClusterHealthWithOptions(options *Options) *ClusterHealth
  • func (i *ClusterHealth) Register(ctx context.Context, client *redis.ClusterClient) error
• type Options
  • func NewOptions() (*Options, error)
  • func NewOptionsWithPath(path string) (opts *Options, err error)

Functions

func ClientRegister

func ClientRegister(ctx context.Context, client *redis.Client) error

func ClusterRegister

func ClusterRegister(ctx context.Context, client *redis.ClusterClient) error

func ConfigAdd

func ConfigAdd(path string)

Types

type ClientChecker

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

ClientChecker represents redis client checker.

func NewClientChecker

func NewClientChecker(client *redis.Client) *ClientChecker

NewClientChecker creates the redis client checker.

func (*ClientChecker) Check

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

Check checks if redis server is responding.

type ClientHealth

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

ClientHealth represents client health.

func NewClientHealth

func NewClientHealth() (*ClientHealth, error)

NewClientHealth returns a client health with default options.

func NewClientHealthWithConfigPath

func NewClientHealthWithConfigPath(path string) (*ClientHealth, error)

NewClientHealthWithConfigPath returns a client health with options from config path.

func NewClientHealthWithOptions

func NewClientHealthWithOptions(options *Options) *ClientHealth

NewClientHealthWithOptions returns a health with the options provided.

func (*ClientHealth) Register

func (i *ClientHealth) Register(ctx context.Context, client *redis.Client) error

Register registers a new ClientChecker in the health package.

type ClusterClientChecker

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

ClientHealth represents redis cluster client checker.

func NewClusterClientChecker

func NewClusterClientChecker(client *redis.ClusterClient) *ClusterClientChecker

NewClusterClientChecker creates the redis cluster client checker.

func (*ClusterClientChecker) Check

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

Check checks if redis cluster is responding.

type ClusterHealth

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

ClusterHealth represents cluster health.

func NewClusterHealth

func NewClusterHealth() (*ClusterHealth, error)

NewClusterHealth returns a health with default options.

func NewClusterHealthWithConfigPath

func NewClusterHealthWithConfigPath(path string) (*ClusterHealth, error)

NewClusterHealthWithConfigPath returns a health with options from config path.

func NewClusterHealthWithOptions

func NewClusterHealthWithOptions(options *Options) *ClusterHealth

NewClusterHealthWithOptions returns a health with the options provided.

func (*ClusterHealth) Register

func (i *ClusterHealth) Register(ctx context.Context, client *redis.ClusterClient) error

Register registers a new ClusterClientChecker in the health package.

type Options

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

Options represents a health plugin for redis 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.