uptimekuma

Documentation

Index

• type Heartbeat
• type HeartbeatData
• type HeartbeatStatus
• type Incident
• type Settings
  • func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings
• type StatusPageData
• type Widget
  • func NewWidget(tviewApp *tview.Application, redrawChan chan bool, pages *tview.Pages, ...) *Widget
  • func (widget *Widget) Refresh()

Types

type Heartbeat

type Heartbeat struct {
	Status int `json:"status"`
}

Heartbeat represents a single heartbeat event

type HeartbeatData

type HeartbeatData struct {
	HeartbeatList map[string][]*Heartbeat `json:"heartbeatList"`
	UptimeList    map[string]float64      `json:"uptimeList"`
}

HeartbeatData represents the data from the /api/status-page/heartbeat/<slug> endpoint

type HeartbeatStatus

type HeartbeatStatus int

HeartbeatStatus represents the status of a heartbeat Matches JS: DOWN=0, UP=1, PENDING=2, MAINTENANCE=3

const (
	DOWN HeartbeatStatus = iota
	UP
	PENDING
	MAINTENANCE
)

type Incident

type Incident struct {
	CreatedDate string `json:"createdDate"`
}

Incident represents an incident in Uptime Kuma

type Settings

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

func NewSettingsFromYAML

func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings

NewSettingsFromYAML creates a new settings instance from a YAML config block

type StatusPageData

type StatusPageData struct {
	Incident *Incident `json:"incident"`
}

StatusPageData represents the data from the /api/status-page/<slug> endpoint

type Widget

type Widget struct {
	view.TextWidget
	// contains filtered or unexported fields
}

Widget is the container for your module's data

func NewWidget

func NewWidget(tviewApp *tview.Application, redrawChan chan bool, pages *tview.Pages, settings *Settings) *Widget

NewWidget creates and returns an instance of Widget

func (*Widget) Refresh

func (widget *Widget) Refresh()

Refresh updates the onscreen contents of the widget