health

Documentation

Index

• func Handle(w http.ResponseWriter, r *http.Request)
• func Set(ctx context.Context, h *Config) context.Context
• type Base
  • func (b Base) Check(ctx context.Context) bool
  • func (b Base) Clone() Component
  • func (b Base) Close() error
  • func (b Base) Name() string
• type Component
• type Config
  • func Get(ctx context.Context) *Config
  • func (c *Config) Ping(name string) *Ping
• type Health
  • func (h Health) Check(ctx context.Context) map[string]bool
  • func (h Health) Close() error
• type Ping
  • func NewPing(name string) *Ping
  • func (p *Ping) Check(ctx context.Context) bool
  • func (p *Ping) Clone() Component
  • func (p *Ping) Close() error
  • func (p Ping) Name() string
• type PingChannel

Functions

func Handle

func Handle(w http.ResponseWriter, r *http.Request)

func Set

func Set(ctx context.Context, h *Config) context.Context

Types

type Base

type Base struct {
	Key       string
	CheckFunc func(ctx context.Context) bool
}

func (Base) Check

func (b Base) Check(ctx context.Context) bool

func (Base) Clone

func (b Base) Clone() Component

func (Base) Close

func (b Base) Close() error

func (Base) Name

func (b Base) Name() string

type Component

type Component interface {
	Name() string
	Check(context.Context) bool
	Clone() Component
	io.Closer
}

type Config

type Config struct {
	Health
}

func Get

func Get(ctx context.Context) *Config

func (*Config) Ping

func (c *Config) Ping(name string) *Ping

type Health

type Health []Component

func (Health) Check

func (h Health) Check(ctx context.Context) map[string]bool

func (Health) Close

func (h Health) Close() error

type Ping

type Ping struct {
	Key     string
	Channel PingChannel
}

func NewPing

func NewPing(name string) *Ping

func (*Ping) Check

func (p *Ping) Check(ctx context.Context) bool

func (*Ping) Clone

func (p *Ping) Clone() Component

func (*Ping) Close

func (p *Ping) Close() error

func (Ping) Name

func (p Ping) Name() string

type PingChannel

type PingChannel chan func()