statuspage

Documentation

Overview

Package statuspage reports the status of a service exposing an Atlassian StatusPage API.

Index

• type Component
• type ComponentsResponse
• type Config
• type Status
• type StatusResponse

Types

type Component

type Component struct {
	ID        string    `json:"id"`
	Name      string    `json:"name"`
	Status    string    `json:"status"`
	UpdatedAt time.Time `json:"updated_at"`
}

Component is a StatusPage API's component

type ComponentsResponse

type ComponentsResponse struct {
	Components []Component `json:"components"`
}

ComponentsResponse is a StatusPAge API's response body

type Config

type Config struct {
	// The base_url attribute is the base HTTP URL for the API, without the path part.
	BaseURL string `hcl:"base_url"`
	// The single_status attribute will report a single status row instead of one per component of the provider.
	StatusOnly bool `hcl:"single_status,optional"`
}

Config for the statuspage probe: it will report the condition of service providers who are exposing their system health through Atlassian's StatusPage public API.

type Status

type Status struct {
	Description string `json:"description"`
	Indicator   string `json:"indicator"`
}

Status is a StatusPage API's global status

type StatusResponse

type StatusResponse struct {
	Status Status `json:"status"`
}

StatusResponse is a StatusPage API's global status response body