status

Documentation

Index

• type ComponentStatus
• type Report
• type Status
  • func NewStatus(version string) (status *Status)
  • func (s *Status) Register(name string) (cs ComponentStatus, err error)
  • func (s *Status) Report() (report Report)
• type StatusType
  • func (s StatusType) MarshalJSON() ([]byte, error)
  • func (s StatusType) String() string
  • func (s *StatusType) UnmarshalJSON(b []byte) error

Types

type ComponentStatus

type ComponentStatus interface {
	SetStatus(statusType StatusType, message string)
	// getters
	Status() StatusType
	Message() string
	LastUpdate() time.Time
}

type Report

type Report struct {
	Version    string                     `json:"version"`
	Status     StatusType                 `json:"status"`
	Components map[string]componentStatus `json:"components"`
}

type Status

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

func NewStatus

func NewStatus(version string) (status *Status)

func (*Status) Register

func (s *Status) Register(name string) (cs ComponentStatus, err error)

func (*Status) Report

func (s *Status) Report() (report Report)

type StatusType

type StatusType int

const (
	ERROR StatusType = iota
	WARN
	OK
)

func (StatusType) MarshalJSON

func (s StatusType) MarshalJSON() ([]byte, error)

func (StatusType) String

func (s StatusType) String() string

func (*StatusType) UnmarshalJSON

func (s *StatusType) UnmarshalJSON(b []byte) error