healthx

Documentation

Index

• type HealthCheckContract
• type HealthCheckManager
  • func NewManager() HealthCheckManager
  • func (c *HealthCheckManager) Run() HealthCheckResult
  • func (c *HealthCheckManager) SomethingFailed() bool
  • func (c *HealthCheckManager) Use(check HealthCheckContract)
• type HealthCheckResult
• type HealthCheckStatus
  • func (s HealthCheckStatus) CheckID() string
  • func (s HealthCheckStatus) IsFailed() bool
  • func (s HealthCheckStatus) Status() string
• type HealthCheckStatusContract
• type NatsConnectionCheck
  • func (c *NatsConnectionCheck) Run() HealthCheckStatusContract
• type PostgresConnectionCheck
  • func (c *PostgresConnectionCheck) Run() HealthCheckStatusContract

Types

type HealthCheckContract

type HealthCheckContract interface {
	Run() HealthCheckStatusContract
}

type HealthCheckManager

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

func NewManager

func NewManager() HealthCheckManager

func (*HealthCheckManager) Run

func (c *HealthCheckManager) Run() HealthCheckResult

func (*HealthCheckManager) SomethingFailed

func (c *HealthCheckManager) SomethingFailed() bool

func (*HealthCheckManager) Use

func (c *HealthCheckManager) Use(check HealthCheckContract)

type HealthCheckResult

type HealthCheckResult map[string]bool

type HealthCheckStatus

type HealthCheckStatus struct {
	StatusText string
	Failed     bool
	ID         string
}

func (HealthCheckStatus) CheckID

func (s HealthCheckStatus) CheckID() string

func (HealthCheckStatus) IsFailed

func (s HealthCheckStatus) IsFailed() bool

func (HealthCheckStatus) Status

func (s HealthCheckStatus) Status() string

type HealthCheckStatusContract

type HealthCheckStatusContract interface {
	Status() string
	IsFailed() bool
	CheckID() string
}

type NatsConnectionCheck

type NatsConnectionCheck struct {
	Conn *nats.Conn
	ID   string
}

func (*NatsConnectionCheck) Run

func (c *NatsConnectionCheck) Run() HealthCheckStatusContract

type PostgresConnectionCheck

type PostgresConnectionCheck struct {
	Conn *pgxpool.Conn
	ID   string
}

func (*PostgresConnectionCheck) Run

func (c *PostgresConnectionCheck) Run() HealthCheckStatusContract