api

Documentation

Index

• Variables
• func About(c echo.Context) error
• func CheckDetails(c echo.Context) error
• func DetailsHandler(c echo.Context) error
• func GetBestPartitioner(totalChecks int, rangeDuration time.Duration) time.Duration
• 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
• func WebhookHandler(c echo.Context) error
• type CheckData
• type CheckErrorMessage
• type DetailResponse
• type QueueData
• type Response

Variables

var (
	DefaultWindow = "1h"
)

Functions

func About

func About(c echo.Context) error

func CheckDetails

func CheckDetails(c echo.Context) error

func DetailsHandler

func DetailsHandler(c echo.Context) error

func GetBestPartitioner

func GetBestPartitioner(totalChecks int, rangeDuration time.Duration) time.Duration

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]

func WebhookHandler

func WebhookHandler(c echo.Context) error

Types

type CheckData

type CheckData struct {
	Headers map[string]string `json:"headers"`
	JSON    map[string]any    `json:"json,omitempty"`
	Content string            `json:"content,omitempty"`
}

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     []query.Timeseries `json:"status"`
	Latency    types.Latency      `json:"latency"`
	Uptime     types.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,omitempty"`
	ChecksSummary []models.CheckSummary `json:"checks_summary,omitempty"`
}