healthcheck
package v0.27.3
Go to latest Published: Aug 1, 2023 License:AGPL-3.0
Opens a new window with list of versions in this module.
Latest LatestThis package is not in the latest version of its module.
Opens a new window with license information.
Imports:27 Opens a new window with list of imports.
Imported by:0 Opens a new window with list of known importers.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
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 (SectionDERPstring = "DERP"SectionAccessURLstring = "AccessURL"SectionWebsocketstring = "Websocket"SectionDatabasestring = "Database")
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeAccessURLReport¶added inv0.23.0
type AccessURLReport struct {AccessURLstring `json:"access_url"`Healthybool `json:"healthy"`Reachablebool `json:"reachable"`StatusCodeint `json:"status_code"`HealthzResponsestring `json:"healthz_response"`Error *string `json:"error"`}
func (*AccessURLReport)Run¶added inv0.23.0
func (r *AccessURLReport) Run(ctxcontext.Context, opts *AccessURLReportOptions)
typeAccessURLReportOptions¶added inv0.25.0
typeChecker¶added inv0.24.0
type Checker interface {DERP(ctxcontext.Context, opts *DERPReportOptions)DERPReportAccessURL(ctxcontext.Context, opts *AccessURLReportOptions)AccessURLReportWebsocket(ctxcontext.Context, opts *WebsocketReportOptions)WebsocketReportDatabase(ctxcontext.Context, opts *DatabaseReportOptions)DatabaseReport}
typeDERPNodeReport¶
type DERPNodeReport struct {Healthybool `json:"healthy"`Node *tailcfg.DERPNode `json:"node"`ServerInfoderp.ServerInfoMessage `json:"node_info"`CanExchangeMessagesbool `json:"can_exchange_messages"`RoundTripPingtime.Duration `json:"round_trip_ping"`UsesWebsocketbool `json:"uses_websocket"`ClientLogs [][]string `json:"client_logs"`ClientErrs [][]string `json:"client_errs"`Error *string `json:"error"`STUNDERPStunReport `json:"stun"`// contains filtered or unexported fields}
func (*DERPNodeReport)Run¶
func (r *DERPNodeReport) Run(ctxcontext.Context)
typeDERPRegionReport¶
type DERPRegionReport struct {Healthybool `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(ctxcontext.Context)
typeDERPReport¶
type DERPReport struct {Healthybool `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(ctxcontext.Context, opts *DERPReportOptions)
typeDERPStunReport¶
typeDatabaseReport¶added inv0.25.0
type DatabaseReport struct {Healthybool `json:"healthy"`Reachablebool `json:"reachable"`Latencytime.Duration `json:"latency"`Error *string `json:"error"`}
func (*DatabaseReport)Run¶added inv0.25.0
func (r *DatabaseReport) Run(ctxcontext.Context, opts *DatabaseReportOptions)
typeDatabaseReportOptions¶added inv0.25.0
typeReport¶
type Report struct {// Time is the time the report was generated at.Timetime.Time `json:"time"`// Healthy is true if the report returns no errors.Healthybool `json:"healthy"`// FailingSections is a list of sections that have failed their healthcheck.FailingSections []string `json:"failing_sections"`DERPDERPReport `json:"derp"`AccessURLAccessURLReport `json:"access_url"`WebsocketWebsocketReport `json:"websocket"`DatabaseDatabaseReport `json:"database"`// The Coder version of the server that the report was generated on.CoderVersionstring `json:"coder_version"`}
typeReportOptions¶
typeWebsocketEchoServer¶added inv0.24.0
func (*WebsocketEchoServer)ServeHTTP¶added inv0.24.0
func (s *WebsocketEchoServer) ServeHTTP(rwhttp.ResponseWriter, r *http.Request)
typeWebsocketReport¶
type WebsocketReport struct {Healthybool `json:"healthy"`ResponseWebsocketResponse `json:"response"`Error *string `json:"error"`}
func (*WebsocketReport)Run¶added inv0.23.0
func (r *WebsocketReport) Run(ctxcontext.Context, opts *WebsocketReportOptions)
typeWebsocketReportOptions¶added inv0.24.0
typeWebsocketResponse¶added inv0.24.0
Click to show internal directories.
Click to hide internal directories.