healthcheck

Documentation

Index

• Constants
• type AccessURLOptions
• type AccessURLReport
  • func (r *AccessURLReport) Run(ctx context.Context, opts *AccessURLOptions)
• type Checker
• type DERPNodeReport
  • func (r *DERPNodeReport) Run(ctx context.Context)
• type DERPRegionReport
  • func (r *DERPRegionReport) Run(ctx context.Context)
• type DERPReport
  • func (r *DERPReport) Run(ctx context.Context, opts *DERPReportOptions)
• type DERPReportOptions
• type DERPStunReport
• type Report
  • func Run(ctx context.Context, opts *ReportOptions) *Report
• type ReportOptions
• type WebsocketEchoServer
  • func (s *WebsocketEchoServer) ServeHTTP(rw http.ResponseWriter, r *http.Request)
• type WebsocketReport
  • func (r *WebsocketReport) Run(ctx context.Context, opts *WebsocketReportOptions)
• type WebsocketReportOptions
• type WebsocketResponse

Constants

const (
	SectionDERP      string = "DERP"
	SectionAccessURL string = "AccessURL"
	SectionWebsocket string = "Websocket"
)

Types

type AccessURLOptions

type AccessURLOptions struct {
	AccessURL *url.URL
	Client    *http.Client
}

type AccessURLReport

type AccessURLReport struct {
	Healthy         bool   `json:"healthy"`
	Reachable       bool   `json:"reachable"`
	StatusCode      int    `json:"status_code"`
	HealthzResponse string `json:"healthz_response"`
	Error           error  `json:"error"`
}

func (*AccessURLReport) Run

func (r *AccessURLReport) Run(ctx context.Context, opts *AccessURLOptions)

type Checker

type Checker interface {
	DERP(ctx context.Context, opts *DERPReportOptions) DERPReport
	AccessURL(ctx context.Context, opts *AccessURLOptions) AccessURLReport
	Websocket(ctx context.Context, opts *WebsocketReportOptions) WebsocketReport
}

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          [][]error              `json:"client_errs"`
	Error               error                  `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       error               `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  error            `json:"netcheck_err"`
	NetcheckLogs []string         `json:"netcheck_logs"`

	Error error `json:"error"`
}

func (*DERPReport) Run

func (r *DERPReport) Run(ctx context.Context, opts *DERPReportOptions)

type DERPReportOptions

type DERPReportOptions struct {
	DERPMap *tailcfg.DERPMap
}

type DERPStunReport

type DERPStunReport struct {
	Enabled bool
	CanSTUN bool
	Error   error
}

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 []string `json:"failing_sections"`

	DERP      DERPReport      `json:"derp"`
	AccessURL AccessURLReport `json:"access_url"`
	Websocket WebsocketReport `json:"websocket"`
}

func Run

func Run(ctx context.Context, opts *ReportOptions) *Report

type ReportOptions

type ReportOptions struct {
	// TODO: support getting this over HTTP?
	DERPMap   *tailcfg.DERPMap
	AccessURL *url.URL
	Client    *http.Client
	APIKey    string

	Checker Checker
}

type WebsocketEchoServer

type WebsocketEchoServer struct {
	Error error
	Code  int
}

func (*WebsocketEchoServer) ServeHTTP

func (s *WebsocketEchoServer) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type WebsocketReport

type WebsocketReport struct {
	Healthy  bool              `json:"healthy"`
	Response WebsocketResponse `json:"response"`
	Error    error             `json:"error"`
}

func (*WebsocketReport) Run

func (r *WebsocketReport) Run(ctx context.Context, opts *WebsocketReportOptions)

type WebsocketReportOptions

type WebsocketReportOptions struct {
	APIKey     string
	AccessURL  *url.URL
	HTTPClient *http.Client
}

type WebsocketResponse

type WebsocketResponse struct {
	Body string `json:"body"`
	Code int    `json:"code"`
}