api

Documentation

Index

• Constants
• 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 ErrorCode(err error) string
• func ErrorDebugInfo(err error) string
• func ErrorMessage(err error) string
• func ErrorStatusCode(code string) int
• 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
• func WriteError(c echo.Context, err error) error
• type CheckData
• type CheckErrorMessage
• type DetailResponse
• type Error
  • func Errorf(code string, format string, args ...any) *Error
  • func (e *Error) Error() string
  • func (e *Error) WithDebugInfo(msg string, args ...any) *Error
• type HTTPError
• type HTTPSuccess
• type QueueData
• type Response
• type RunCanaryResponse
  • func (t *RunCanaryResponse) FromCheckResults(result []*pkg.CheckResult)

Constants

const (
	ECONFLICT       = "conflict"
	EFORBIDDEN      = "forbidden"
	EINTERNAL       = "internal"
	EINVALID        = "invalid"
	ENOTFOUND       = "not_found"
	ENOTIMPLEMENTED = "not_implemented"
	EUNAUTHORIZED   = "unauthorized"
)

Application error codes.

These are meant to be generic and they map well to HTTP error codes.

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 ErrorCode

func ErrorCode(err error) string

ErrorCode unwraps an application error and returns its code. Non-application errors always return EINTERNAL.

func ErrorDebugInfo

func ErrorDebugInfo(err error) string

ErrorDebugInfo unwraps an application error and returns its debug message.

func ErrorMessage

func ErrorMessage(err error) string

ErrorMessage unwraps an application error and returns its message. Non-application errors always return "Internal error".

func ErrorStatusCode

func ErrorStatusCode(code string) int

ErrorStatusCode returns the associated HTTP status code for an application error code.

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

func WriteError

func WriteError(c echo.Context, err error) error

WriteError writes the error to the HTTP response with appropriate status code

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     []pkg.Timeseries `json:"status"`
	Latency    pkg.Latency      `json:"latency"`
	Uptime     pkg.Uptime       `json:"uptime"`
}

type Error

type Error struct {
	// Machine-readable error code.
	Code string

	// Human-readable error message.
	Message string

	// DebugInfo contains low-level internal error details that should only be logged.
	// End-users should never see this.
	DebugInfo string
}

Error represents an application-specific error.

func Errorf

func Errorf(code string, format string, args ...any) *Error

Errorf is a helper function to return an Error with a given code and formatted message.

func (*Error) Error

func (e *Error) Error() string

Error implements the error interface. Not used by the application otherwise.

func (*Error) WithDebugInfo

func (e *Error) WithDebugInfo(msg string, args ...any) *Error

WithDebugInfo wraps an application error with a debug message.

type HTTPError

type HTTPError struct {
	Error   string `json:"error"`
	Message string `json:"message,omitempty"`
}

type HTTPSuccess

type HTTPSuccess struct {
	Message string `json:"message"`
	Payload any    `json:"payload,omitempty"`
}

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"`
}

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)