api

Documentation

Index

• Constants
• type Check
• type Entry
• type Latency
• type Stats
• type Website

Constants

const (
	StatusUnknown     = "unknown"
	StatusUp          = "up"
	StatusMaintenance = "maintenance"
	StatusDown        = "down"
)

Website status enumaration.

const (
	ResultUp   = "up"
	ResultDown = "down"
)

Check result enumaration.

Types

type Check

type Check struct {
	ID        uint      `json:"id"`
	WebsiteID uint      `json:"websiteId,omitempty" db:"website_id"`
	Checked   time.Time `json:"checkedAt" db:"checked_at"`
	Result    string    `json:"result"`
	Latency   *Latency  `json:"latency"`
}

Check ...

type Entry

type Entry struct {
	Time     time.Time     `json:"time"`
	Status   string        `json:"status"`
	Duration time.Duration `json:"duration"`
}

Entry ...

type Latency

type Latency struct {
	DNS         time.Duration `json:"dns"`
	Connection  time.Duration `json:"connection"`
	TLS         time.Duration `json:"tls"`
	Application time.Duration `json:"application"`
	Total       time.Duration `json:"total"`
}

Latency ...

type Stats

type Stats struct {
	Uptime  float64 `json:"uptime"`
	Apdex   float64 `json:"apdex"`
	Average float64 `json:"average"`
	Lowest  float64 `json:"lowest"`
	Highest float64 `json:"highest"`
	Count   uint    `json:"count"`
}

Stats ...

type Website

type Website struct {
	ID      uint      `json:"id"`
	Updated time.Time `json:"updatedAt" db:"updated_at"`
	Status  string    `json:"status"`
	URL     string    `json:"url"`
	Uptime  float64   `json:"uptime"`
}

Website ...