health

Documentation

Index

• func ConfigAdd(path string)
• func Register(ctx context.Context) (mongo.ClientOptionsPlugin, mongo.ClientPlugin)
• type Checker
  • func NewChecker(client *mongo.Client) *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) (mongo.ClientOptionsPlugin, mongo.ClientPlugin)
• 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) (mongo.ClientOptionsPlugin, mongo.ClientPlugin)

Register registers a new health plugin on a new mongo client.

Types

type Checker

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

Checker represents health checker plugin for mongoDB.

func NewChecker

func NewChecker(client *mongo.Client) *Checker

NewChecker returns a new checker plugin.

func (*Checker) Check

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

Check checks if mongo is up (no returned error).

type Health

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

Health represents a healh plugin for mongo.

func NewHealth

func NewHealth() *Health

NewHealth returns a new health with default options.

func NewHealthWithConfigPath

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

NewHealthWithConfigPath returns a new health with options from config path.

func NewHealthWithOptions

func NewHealthWithOptions(options *Options) *Health

NewHealthWithOptions returns a new health with options.

func (*Health) Register

func (i *Health) Register(ctx context.Context) (mongo.ClientOptionsPlugin, mongo.ClientPlugin)

Register registers this health plugin on a new mongo client.

type Options

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

Options represents health plugin for mongo 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 options based a given key path.