Skip to content

feat: include health severity in reports #10817

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 21 commits into from
Nov 23, 2023
Merged

feat: include health severity in reports #10817

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
205a224
Severity definition
mtojek Nov 21, 2023
1bcad04
WIP
mtojek Nov 21, 2023
e1978f2
use model struct for base health summary
mtojek Nov 21, 2023
0e3bc17
The best I can do
mtojek Nov 21, 2023
f8af18c
fix imports
mtojek Nov 21, 2023
baae564
severity
mtojek Nov 21, 2023
3d17eb5
WIP
mtojek Nov 21, 2023
984d3e1
Merge branch 'main' into 9754-severity
mtojek Nov 22, 2023
b373cc2
Merge branch 'main' into 9754-severity
mtojek Nov 22, 2023
8dcbafd
WIP
mtojek Nov 22, 2023
d00802e
more rules
mtojek Nov 22, 2023
7b3945a
Fix: database
mtojek Nov 22, 2023
af2d0dc
WIP
mtojek Nov 22, 2023
6c59dc3
Reports
mtojek Nov 22, 2023
aba2a9e
DERP servers partially unhealthy
mtojek Nov 22, 2023
c15ea21
warning: failover to websockets
mtojek Nov 22, 2023
8d32194
Merge branch 'main' into 9754-severity
mtojek Nov 23, 2023
b77763a
Deprecation notice
mtojek Nov 23, 2023
5f6d7a6
Switch to unhealthy
mtojek Nov 23, 2023
1542296
simplify
mtojek Nov 23, 2023
140b5c6
Missing node report
mtojek Nov 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
use model struct for base health summary
  • Loading branch information
@mtojek
mtojek committed Nov 21, 2023
commit e1978f22c240d6e0785730be806d82b0084400a5
5 changes: 2 additions & 3 deletions coderd/healthcheck/accessurl.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,13 @@ import (

"golang.org/x/xerrors"

"github.com/coder/coder/v2/coderd/healthcheck/model"
"github.com/coder/coder/v2/coderd/util/ptr"
)

// @typescript-generate AccessURLReport
type AccessURLReport struct {
Healthy bool `json:"healthy"`
Severity Severity `json:"severity" enums:"ok,warning,error"`
Warnings []string `json:"warnings"`
model.HealthSummary

AccessURL string `json:"access_url"`
Reachable bool `json:"reachable"`
Expand Down
5 changes: 2 additions & 3 deletions coderd/healthcheck/database.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"golang.org/x/xerrors"

"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/healthcheck/model"
)

const (
Expand All @@ -16,9 +17,7 @@ const (

// @typescript-generate DatabaseReport
type DatabaseReport struct {
Healthy bool `json:"healthy"`
Severity Severity `json:"severity" enums:"ok,warning,error"`
Warnings []string `json:"warnings"`
model.HealthSummary

Reachable bool `json:"reachable"`
Latency string `json:"latency"`
Expand Down
28 changes: 8 additions & 20 deletions coderd/healthcheck/derphealth/derp.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import (
"tailscale.com/types/key"
tslogger "tailscale.com/types/logger"

"github.com/coder/coder/v2/coderd/healthcheck/model"
"github.com/coder/coder/v2/coderd/util/ptr"
)

Expand All @@ -29,20 +30,9 @@ const (
oneNodeUnhealthy = "Region is operational, but performance might be degraded as one node is unhealthy."
)

const (
SeverityOK Severity = "ok"
SeverityWarning Severity = "warning"
SeverityError Severity = "error"
)

// @typescript-generate Severity
type Severity string

// @typescript-generate Report
type Report struct {
Healthy bool `json:"healthy"`
Severity Severity `json:"severity" enums:"ok,warning,error"`
Warnings []string `json:"warnings"`
model.HealthSummary

Regions map[int]*RegionReport `json:"regions"`

Expand All @@ -57,9 +47,7 @@ type Report struct {
type RegionReport struct {
mu sync.Mutex

Healthy bool `json:"healthy"`
Severity Severity `json:"severity" enums:"ok,warning,error"`
Warnings []string `json:"warnings"`
model.HealthSummary

Region *tailcfg.DERPRegion `json:"region"`
NodeReports []*NodeReport `json:"node_reports"`
Expand All @@ -71,9 +59,7 @@ type NodeReport struct {
mu sync.Mutex
clientCounter int

Healthy bool `json:"healthy"`
Severity Severity `json:"severity" enums:"ok,warning,error"`
Warnings []string `json:"warnings"`
model.HealthSummary

Node *tailcfg.DERPNode `json:"node"`

Expand Down Expand Up @@ -167,8 +153,10 @@ func (r *RegionReport) Run(ctx context.Context) {
var (
node = node
nodeReport = NodeReport{
Node: node,
Healthy: true,
Node: node,
HealthSummary: model.HealthSummary{
Healthy: true,
},
}
)

Expand Down
5 changes: 5 additions & 0 deletions coderd/healthcheck/derphealth/doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
package derphealth

// DERP healthcheck is kept in a separate package as it is used by `cli/netcheck.go`,
// which is part of the slim binary. Slim binary can't have dependency on `database`,
// which is used by the database healthcheck.
11 changes: 2 additions & 9 deletions coderd/healthcheck/healthcheck.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (

"github.com/coder/coder/v2/buildinfo"
"github.com/coder/coder/v2/coderd/healthcheck/derphealth"
"github.com/coder/coder/v2/coderd/healthcheck/model"
"github.com/coder/coder/v2/coderd/util/ptr"
)

Expand All @@ -18,14 +19,6 @@ const (
SectionDatabase string = "Database"
)

const (
SeverityOK Severity = "ok"
SeverityWarning Severity = "warning"
SeverityError Severity = "error"
)

type Severity string

type Checker interface {
DERP(ctx context.Context, opts *derphealth.ReportOptions) derphealth.Report
AccessURL(ctx context.Context, opts *AccessURLReportOptions) AccessURLReport
Expand All @@ -40,7 +33,7 @@ type Report struct {
// Healthy is true if the report returns no errors.
Healthy bool `json:"healthy"`
// Severity indicates the status of Coder health.
Severity Severity `json:"severity" enums:"ok,warning,error"`
Severity model.Severity `json:"severity" enums:"ok,warning,error"`
// FailingSections is a list of sections that have failed their healthcheck.
FailingSections []string `json:"failing_sections"`

Expand Down
16 changes: 16 additions & 0 deletions coderd/healthcheck/model/base.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
package model

const (
SeverityOK Severity = "ok"
SeverityWarning Severity = "warning"
SeverityError Severity = "error"
)

// @typescript-generate Severity
type Severity string

type HealthSummary struct {
Healthy bool `json:"healthy"`
Severity Severity `json:"severity" enums:"ok,warning,error"`
Warnings []string `json:"warnings"`
}
6 changes: 3 additions & 3 deletions coderd/healthcheck/websocket.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ import (

"golang.org/x/xerrors"
"nhooyr.io/websocket"

"github.com/coder/coder/v2/coderd/healthcheck/model"
)

type WebsocketReportOptions struct {
Expand All @@ -21,9 +23,7 @@ type WebsocketReportOptions struct {

// @typescript-generate WebsocketReport
type WebsocketReport struct {
Healthy bool `json:"healthy"`
Severity Severity `json:"severity" enums:"ok,warning,error"`
Warnings []string `json:"warnings"`
model.HealthSummary

Body string `json:"body"`
Code int `json:"code"`
Expand Down