health

Documentation

Index

• type Checker
  • func (c *Checker) Run()
  • func (c *Checker) Status() Status
• type Status

Types

type Checker

type Checker struct {
	Ctx      context.Context
	Storage  storage.Provider
	Database database.Provider
	Cache    cache.Provider

	Log *logger.Logger
	// contains filtered or unexported fields
}

Checker is a periodic health checker

func (*Checker) Run

func (c *Checker) Run()

Run starts the health checker

func (*Checker) Status

func (c *Checker) Status() Status

Status returns the status of the health checks

type Status

type Status struct {
	Healthy  bool   `json:"healthy"`
	Cache    string `json:"cache,omitempty"`
	Database string `json:"database,omitempty"`
	Storage  string `json:"storage,omitempty"`
}

Status contains the healtcheck status