status

Documentation

Index

• Variables
• type ComponentReport
• type ComponentStatus
  • func (cs *ComponentStatus) LastUpdate() time.Time
  • func (cs *ComponentStatus) Message() string
  • func (cs *ComponentStatus) SetStatus(statusType StatusType, message string)
  • func (cs *ComponentStatus) Status() StatusType
• type Report
• type Status
  • func NewStatus(version string) (status *Status)
  • func (s *Status) Register(name string) (cs *ComponentStatus, err error)
  • func (s *Status) RegisterOrGet(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

Variables

var (
	ErrAlreadyExists = errors.New("component already exists")
)

Types

type ComponentReport

type ComponentReport struct {
	Status    StatusType `json:"status"`
	Message   string     `json:"message,omitempty"`
	UpdatedAt time.Time  `json:"updated_at,omitempty"`
}

type ComponentStatus

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

func (*ComponentStatus) LastUpdate

func (cs *ComponentStatus) LastUpdate() time.Time

func (*ComponentStatus) Message

func (cs *ComponentStatus) Message() string

func (*ComponentStatus) SetStatus

func (cs *ComponentStatus) SetStatus(statusType StatusType, message string)

func (*ComponentStatus) Status

func (cs *ComponentStatus) Status() StatusType

type Report

type Report struct {
	Version    string                     `json:"version"`
	Hostname   string                     `json:"hostname"`
	Status     StatusType                 `json:"status"`
	Components map[string]ComponentReport `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) RegisterOrGet

func (s *Status) RegisterOrGet(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