Documentation
¶
Index ¶
- Constants
- type AccessURLReport
- type AccessURLReportOptions
- type Checker
- type DERPNodeReport
- type DERPRegionReport
- type DERPReport
- type DERPReportOptions
- type DERPStunReport
- type DatabaseReport
- type DatabaseReportOptions
- type Report
- type ReportOptions
- type WebsocketEchoServer
- type WebsocketReport
- type WebsocketReportOptions
- type WebsocketResponse
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 ¶ added in v0.23.0
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"`
}
func (*AccessURLReport) Run ¶ added in v0.23.0
func (r *AccessURLReport) Run(ctx context.Context, opts *AccessURLReportOptions)
type AccessURLReportOptions ¶ added in v0.25.0
type Checker ¶ added in v0.24.0
type Checker interface {
DERP(ctx context.Context, opts *DERPReportOptions) DERPReport
AccessURL(ctx context.Context, opts *AccessURLReportOptions) AccessURLReport
Websocket(ctx context.Context, opts *WebsocketReportOptions) WebsocketReport
Database(ctx context.Context, opts *DatabaseReportOptions) DatabaseReport
}
type DERPNodeReport ¶
type DERPNodeReport struct {
Healthy bool `json:"healthy"`
Node *tailcfg.DERPNode `json:"node"`
ServerInfo derp.ServerInfoMessage `json:"node_info"`
CanExchangeMessages bool `json:"can_exchange_messages"`
RoundTripPing time.Duration `json:"round_trip_ping"`
UsesWebsocket bool `json:"uses_websocket"`
ClientLogs [][]string `json:"client_logs"`
ClientErrs [][]string `json:"client_errs"`
Error *string `json:"error"`
STUN DERPStunReport `json:"stun"`
// contains filtered or unexported fields
}
func (*DERPNodeReport) Run ¶
func (r *DERPNodeReport) Run(ctx context.Context)
type DERPRegionReport ¶
type DERPRegionReport struct {
Healthy bool `json:"healthy"`
Region *tailcfg.DERPRegion `json:"region"`
NodeReports []*DERPNodeReport `json:"node_reports"`
Error *string `json:"error"`
// contains filtered or unexported fields
}
func (*DERPRegionReport) Run ¶
func (r *DERPRegionReport) Run(ctx context.Context)
type DERPReport ¶
type DERPReport struct {
Healthy bool `json:"healthy"`
Regions map[int]*DERPRegionReport `json:"regions"`
Netcheck *netcheck.Report `json:"netcheck"`
NetcheckErr *string `json:"netcheck_err"`
NetcheckLogs []string `json:"netcheck_logs"`
Error *string `json:"error"`
}
func (*DERPReport) Run ¶
func (r *DERPReport) Run(ctx context.Context, opts *DERPReportOptions)
type DERPReportOptions ¶
type DERPStunReport ¶
type DatabaseReport ¶ added in v0.25.0
type DatabaseReport struct {
Healthy bool `json:"healthy"`
Reachable bool `json:"reachable"`
Latency time.Duration `json:"latency"`
Error *string `json:"error"`
}
func (*DatabaseReport) Run ¶ added in v0.25.0
func (r *DatabaseReport) Run(ctx context.Context, opts *DatabaseReportOptions)
type DatabaseReportOptions ¶ added in v0.25.0
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 DERPReport `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"`
}
type ReportOptions ¶
type WebsocketEchoServer ¶ added in v0.24.0
func (*WebsocketEchoServer) ServeHTTP ¶ added in v0.24.0
func (s *WebsocketEchoServer) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type WebsocketReport ¶
type WebsocketReport struct {
Healthy bool `json:"healthy"`
Response WebsocketResponse `json:"response"`
Error *string `json:"error"`
}
func (*WebsocketReport) Run ¶ added in v0.23.0
func (r *WebsocketReport) Run(ctx context.Context, opts *WebsocketReportOptions)
type WebsocketReportOptions ¶ added in v0.24.0
type WebsocketResponse ¶ added in v0.24.0
Click to show internal directories.
Click to hide internal directories.