api

Documentation

Index

• Variables
• func About(c echo.Context) error
• func CheckDetails(c echo.Context) error
• func CheckSummary(c echo.Context) error
• func DetailsHandler(c echo.Context) error
• func HealthSummary(c echo.Context) error
• func PostDataToServer(server string, body io.Reader) (err error)
• func PushHandler(c echo.Context) error
• func RunCanaryHandler(c echo.Context) error
• func RunTopologyHandler(c echo.Context) error
• func Topology(c echo.Context) error
• type CheckErrorMessage
• type DetailResponse
• type QueueData
• type Response
• type RunCanaryResponse
  • func (t *RunCanaryResponse) FromCheckResults(result []*pkg.CheckResult)

Variables

var (
	DefaultWindow = "1h"
)

Functions

func About

func About(c echo.Context) error

func CheckDetails

func CheckDetails(c echo.Context) error

func CheckSummary

func CheckSummary(c echo.Context) error

func DetailsHandler

func DetailsHandler(c echo.Context) error

func HealthSummary

func HealthSummary(c echo.Context) error

func PostDataToServer

func PostDataToServer(server string, body io.Reader) (err error)

func PushHandler

func PushHandler(c echo.Context) error

func RunCanaryHandler

func RunCanaryHandler(c echo.Context) error

func RunTopologyHandler

func RunTopologyHandler(c echo.Context) error

func Topology

func Topology(c echo.Context) error

TopologyQuery godoc @Id TopologyQuery @Summary Topology query @Description Query the topology graph @Tags topology @Produce json @Param id query string false "Topology ID" @Param topologyId query string false "Topology ID" @Param componentId query string false "Component ID" @Param owner query string false "Owner" @Param status query string false "Comma separated list of status" @Param types query string false "Comma separated list of types" @Param flatten query string false "Flatten the topology" @Success 200 {object} pkg.Components @Router /api/topology [get]

Types

type CheckErrorMessage

type CheckErrorMessage struct {
	Description string `json:"description"`
	Error       string `json:"error"`
}

type DetailResponse

type DetailResponse struct {
	Duration   int              `json:"duration,omitempty"`
	RunnerName string           `json:"runnerName"`
	Status     []pkg.Timeseries `json:"status"`
	Latency    pkg.Latency      `json:"latency"`
	Uptime     pkg.Uptime       `json:"uptime"`
}

type QueueData

type QueueData struct {
	Check  pkg.Check       `json:",inline"`
	Status pkg.CheckStatus `json:",inline"`
}

type Response

type Response struct {
	Duration      int           `json:"duration,omitempty"`
	RunnerName    string        `json:"runnerName"`
	Checks        pkg.Checks    `json:"checks"`
	ChecksSummary models.Checks `json:"checks_summary,omitempty"`
}

type RunCanaryResponse

type RunCanaryResponse struct {
	Total   int                 `json:"total"`
	Failed  int                 `json:"failed"`
	Success int                 `json:"success"`
	Errors  []CheckErrorMessage `json:"errors,omitempty"`
}

RunCanaryResponse represents the response body for a run now request

func (*RunCanaryResponse) FromCheckResults

func (t *RunCanaryResponse) FromCheckResults(result []*pkg.CheckResult)