Documentation
¶
Index ¶
Constants ¶
View Source
const ( SectionDERP string = "DERP" SectionAccessURL string = "AccessURL" SectionWebsocket string = "Websocket" SectionDatabase string = "Database" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessURLReport ¶
type AccessURLReport struct {
AccessURL string `json:"access_url"`
Healthy bool `json:"healthy"`
Reachable bool `json:"reachable"`
StatusCode int `json:"status_code"`
HealthzResponse string `json:"healthz_response"`
Error *string `json:"error"`
}
@typescript-generate AccessURLReport
func (*AccessURLReport) Run ¶
func (r *AccessURLReport) Run(ctx context.Context, opts *AccessURLReportOptions)
type AccessURLReportOptions ¶
type Checker ¶
type Checker interface {
DERP(ctx context.Context, opts *derphealth.ReportOptions) derphealth.Report
AccessURL(ctx context.Context, opts *AccessURLReportOptions) AccessURLReport
Websocket(ctx context.Context, opts *WebsocketReportOptions) WebsocketReport
Database(ctx context.Context, opts *DatabaseReportOptions) DatabaseReport
}
type DatabaseReport ¶
type DatabaseReport struct {
Healthy bool `json:"healthy"`
Reachable bool `json:"reachable"`
Latency string `json:"latency"`
LatencyMs int `json:"latency_ms"`
Error *string `json:"error"`
}
@typescript-generate DatabaseReport
func (*DatabaseReport) Run ¶
func (r *DatabaseReport) Run(ctx context.Context, opts *DatabaseReportOptions)
type DatabaseReportOptions ¶
type Report ¶
type Report struct {
// Time is the time the report was generated at.
Time time.Time `json:"time"`
// Healthy is true if the report returns no errors.
Healthy bool `json:"healthy"`
// FailingSections is a list of sections that have failed their healthcheck.
FailingSections []string `json:"failing_sections"`
DERP derphealth.Report `json:"derp"`
AccessURL AccessURLReport `json:"access_url"`
Websocket WebsocketReport `json:"websocket"`
Database DatabaseReport `json:"database"`
// The Coder version of the server that the report was generated on.
CoderVersion string `json:"coder_version"`
}
@typescript-generate Report
type ReportOptions ¶
type WebsocketEchoServer ¶
func (*WebsocketEchoServer) ServeHTTP ¶
func (s *WebsocketEchoServer) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type WebsocketReport ¶
type WebsocketReport struct {
Healthy bool `json:"healthy"`
Body string `json:"body"`
Code int `json:"code"`
Error *string `json:"error"`
}
@typescript-generate WebsocketReport
func (*WebsocketReport) Run ¶
func (r *WebsocketReport) Run(ctx context.Context, opts *WebsocketReportOptions)
Click to show internal directories.
Click to hide internal directories.