Package health

import "aahframe.work/ec/health"

Overview
Index

Overview

Package health provides and easy way of checking dependencies for your aah application

Index

Constants
type Collector
func NewCollector(interval time.Duration) *Collector
func (c *Collector) AddReporter(config *Config) error
func (c *Collector) Register(app *aah.Application, basePath ...string) error
func (c *Collector) RegisterForDomain(app *aah.Application, domainName string, basePath ...string) error
type Config
type Reporter

Package files

health.go version.go

Constants

Version number of library.

const Version = "0.1.0"

type Collector

Collector contains the health reporters to check and its responded data for the JSON response.

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

func NewCollector

func NewCollector(interval time.Duration) *Collector

NewCollector method returns a `Collector` instance. It periodically checks all its registered reporters.

func (*Collector) AddReporter

func (c *Collector) AddReporter(config *Config) error

AddReporter method adds a dependency to health check reporter that will be called per interval to get health report.

func (*Collector) Register

func (c *Collector) Register(app *aah.Application, basePath ...string) error

Register method registers the health collector into aah application with two routes `/healthcheck` and `/ping`.

Provides optional base path or route prefix for the above routes.

func (*Collector) RegisterForDomain

func (c *Collector) RegisterForDomain(app *aah.Application, domainName string, basePath ...string) error

RegisterForDomain method registers the health collector into aah application with two routes `/healthcheck` and `/ping` for given domain hostname.

Provides optional base path or route prefix for the above routes.

type Config

Config struct contains a Reporter configuration

type Config struct {
    Name     string
    Reporter Reporter
    SoftFail bool // if true it will allow errors so won't report unhealthy
}

type Reporter

Reporter interface for a dependency that can be health-checked.

type Reporter interface {
    // Check will return nil if dependency is reachable/healthy
    // You should implement this func with a sensible timeout (< 3 or 5 sec)
    Check() error
}

aahframe.work/ec/health

Health Check Collector by aah framework

News

Usage

Contributors

Issues

License