health

Documentation

Index

• type Checker
  • func NewChecker(client *mongo.Client) *Checker
  • func (c *Checker) Check(ctx context.Context) error
• type Health
  • func NewHealth() *Health
  • 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)

Types

type Checker

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

func NewChecker

func NewChecker(client *mongo.Client) *Checker

func (*Checker) Check

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

type Health

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

func NewHealth

func NewHealth() *Health

func NewHealthWithOptions

func NewHealthWithOptions(options *Options) *Health

func (*Health) Register

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

type Options

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

func NewOptions

func NewOptions() (*Options, error)

func NewOptionsWithPath

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