api

Documentation

Index

• type Impact
• type Incident
  • func NewIncident(title string, components []string, events []IncidentEvent, startTime time.Time, ...) Incident
• type IncidentEvent
  • func NewIncidentEvent(title string, description string, time time.Time) IncidentEvent
• type IncidentEventArray
  • func (sla *IncidentEventArray) Scan(src interface{}) error
  • func (sla IncidentEventArray) Value() (driver.Value, error)
• type StatusPage
  • func NewStatusPage(name string, url string) StatusPage

Types

type Impact

type Impact string

const (
	ImpactMinor       Impact = "minor"
	ImpactMajor       Impact = "major"
	ImpactCritical    Impact = "critical"
	ImpactMaintenance Impact = "maintenance"
	ImpactNone        Impact = "none"
)

type Incident

type Incident struct {
	Title         string
	Components    []string           `gorm:"column:components;type:jsonb"`
	Events        IncidentEventArray `gorm:"column:events;type:jsonb"`
	StartTime     time.Time          `gorm:"secondarykey"`
	EndTime       *time.Time         `gorm:"secondarykey"`
	Description   *string
	DeepLink      string `gorm:"primarykey"`
	Impact        Impact `gorm:"secondarykey"`
	StatusPageUrl string `gorm:"secondarykey"`
}

func NewIncident

func NewIncident(title string, components []string, events []IncidentEvent, startTime time.Time, endTime *time.Time, description *string, deepLink string, impact Impact, statusPageUrl string) Incident

type IncidentEvent

type IncidentEvent struct {
	Title       string
	Description string
	Time        time.Time
}

func NewIncidentEvent

func NewIncidentEvent(title string, description string, time time.Time) IncidentEvent

type IncidentEventArray

type IncidentEventArray []IncidentEvent

func (*IncidentEventArray) Scan

func (sla *IncidentEventArray) Scan(src interface{}) error

func (IncidentEventArray) Value

func (sla IncidentEventArray) Value() (driver.Value, error)

type StatusPage

type StatusPage struct {
	Name string `gorm:"secondarykey"`
	URL  string `gorm:"primarykey"`
	// Used to determine if we should run a scrape for this status page
	LastHistoricallyScraped time.Time
	LastCurrentlyScraped    time.Time
	// IsIndexed is used to determine if the status page has ever been indexed in the search engine successfully
	IsIndexed bool
}

func NewStatusPage

func NewStatusPage(name string, url string) StatusPage