health

Documentation

Index

• type CheckMongoClient
  • func NewClient(mongoConnection *mongoDriver.MongoConnection) *CheckMongoClient
  • func NewClientWithCollections(mongoConnection *mongoDriver.MongoConnection, ...) *CheckMongoClient
  • func (c *CheckMongoClient) Checker(ctx context.Context, state *healthcheck.CheckState) error
• type Collection
• type Database

Types

type CheckMongoClient

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

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

func NewClient

func NewClient(mongoConnection *mongoDriver.MongoConnection) *CheckMongoClient

NewClient returns a new health check client using the given service

func NewClientWithCollections

func NewClientWithCollections(mongoConnection *mongoDriver.MongoConnection, clientDatabaseCollection map[Database][]Collection) *CheckMongoClient

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

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 Collection

type Collection string

Collection a list of mongo types

type Database

type Database string

Database a list of mongo types