health

Documentation

Index

• Constants
• Variables
• type CheckMongoClient
  • func (c *CheckMongoClient) Checker(ctx context.Context, state *healthcheck.CheckState) error
• type Client
  • func NewClient(db *mgo.Session) *Client
  • func NewClientWithCollections(db *mgo.Session, clientDatabaseCollection map[Database][]Collection) *Client
  • func (m *Client) Healthcheck(ctx context.Context) (res string, err error)
• type Collection
• type Database
• type Healthcheck

Constants

const ServiceName = "mongodb"

ServiceName mongodb

Variables

var (
	ErrorCollectionDoesNotExist = errors.New("collection not found in database")
	ErrorWithMongoDBConnection  = errors.New("unable to connect with MongoDB")
)

List of errors

var (
	// HealthyMessage is the message that will be used in healthcheck when mongo is Healthy and all the collections exist
	HealthyMessage = "mongodb is OK and all expected collections exist"
)

Types

type CheckMongoClient

type CheckMongoClient struct {
	Client      Client
	Healthcheck Healthcheck
}

CheckMongoClient is an implementation of the mongo client with a healthcheck

func (*CheckMongoClient) Checker

func (c *CheckMongoClient) Checker(ctx context.Context, state *healthcheck.CheckState) error

Checker calls an api health endpoint and updates the provided CheckState accordingly

type Client

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

Client provides a healthcheck.Client implementation for health checking the service

func NewClient

func NewClient(db *mgo.Session) *Client

NewClient returns a new health check client using the given service

func NewClientWithCollections

func NewClientWithCollections(db *mgo.Session, clientDatabaseCollection map[Database][]Collection) *Client

NewClientWithCollections returns a new health check client containing the collections using the given service

func (*Client) Healthcheck

func (m *Client) Healthcheck(ctx context.Context) (res string, err error)

Healthcheck calls service to check its health status

type Collection

type Collection string

Collection a list of mongo types

type Database

type Database string

Database a list of mongo types

type Healthcheck

type Healthcheck = func(context.Context) (string, error)

Healthcheck health check function