health

Documentation

Index

• type BuildInfo
• type Manager
  • func NewManager(ctx context.Context, config types.ConfigManager, logger types.Logger, ...) (*Manager, error)
  • func (hm *Manager) Check(ctx context.Context) types.HealthReport
  • func (hm *Manager) IsRunning() bool
  • func (hm *Manager) RegisterChecker(name string, checker types.HealthChecker)
  • func (hm *Manager) Start() error
  • func (hm *Manager) Stop() error
• type State

Types

type BuildInfo

type BuildInfo struct {
	Version   string    `json:"version"`
	GitCommit string    `json:"git_commit"`
	GitBranch string    `json:"git_branch"`
	BuildTime time.Time `json:"build_time"`
	GoVersion string    `json:"go_version"`
	OS        string    `json:"os"`
	Arch      string    `json:"arch"`
	Compiler  string    `json:"compiler"`
}

type Manager

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

func NewManager

func NewManager(ctx context.Context, config types.ConfigManager, logger types.Logger, router types.HTTPRouter) (*Manager, error)

func (*Manager) Check

func (hm *Manager) Check(ctx context.Context) types.HealthReport

func (*Manager) IsRunning

func (hm *Manager) IsRunning() bool

func (*Manager) RegisterChecker

func (hm *Manager) RegisterChecker(name string, checker types.HealthChecker)

func (*Manager) Start

func (hm *Manager) Start() error

func (*Manager) Stop

func (hm *Manager) Stop() error

type State

type State int32

const (
	StateStopped State = iota
	StateStarting
	StateRunning
	StateStopping
)