Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

refactor(coderd/healthcheck): make Warnings an object with { Code, Message }#10950

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.

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

Already on GitHub?Sign in to your account

Merged
johnstcn merged 6 commits intomainfromcj/healthcheck-warnings-refactor
Nov 30, 2023
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
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
62 changes: 56 additions & 6 deletionscoderd/apidoc/docs.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.

62 changes: 56 additions & 6 deletionscoderd/apidoc/swagger.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.

21 changes: 10 additions & 11 deletionscoderd/healthcheck/accessurl.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,15 @@ import (
"time"

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

// @typescript-generate AccessURLReport
type AccessURLReport struct {
// Healthy is deprecated and left for backward compatibility purposes, use `Severity` instead.
Healthy bool `json:"healthy"`
Severity health.Severity `json:"severity" enums:"ok,warning,error"`
Warnings []string `json:"warnings"`
Dismissed bool `json:"dismissed"`
Healthy bool`json:"healthy"`
Severity health.Severity`json:"severity" enums:"ok,warning,error"`
Warnings []health.Message `json:"warnings"`
Dismissed bool`json:"dismissed"`

AccessURL string `json:"access_url"`
Reachable bool `json:"reachable"`
Expand All@@ -38,11 +37,11 @@ func (r *AccessURLReport) Run(ctx context.Context, opts *AccessURLReportOptions)
defer cancel()

r.Severity = health.SeverityOK
r.Warnings = []string{}
r.Warnings = []health.Message{}
r.Dismissed = opts.Dismissed

if opts.AccessURL == nil {
r.Error =ptr.Ref(health.Messagef(health.CodeAccessURLNotSet, "Access URL not set"))
r.Error = health.Errorf(health.CodeAccessURLNotSet, "Access URL not set")
r.Severity = health.SeverityError
return
}
Expand All@@ -54,29 +53,29 @@ func (r *AccessURLReport) Run(ctx context.Context, opts *AccessURLReportOptions)

accessURL, err := opts.AccessURL.Parse("/healthz")
if err != nil {
r.Error =ptr.Ref(health.Messagef(health.CodeAccessURLInvalid, "parse healthz endpoint: %s", err))
r.Error = health.Errorf(health.CodeAccessURLInvalid, "parse healthz endpoint: %s", err)
r.Severity = health.SeverityError
return
}

req, err := http.NewRequestWithContext(ctx, "GET", accessURL.String(), nil)
if err != nil {
r.Error =ptr.Ref(health.Messagef(health.CodeAccessURLFetch, "create healthz request: %s", err))
r.Error = health.Errorf(health.CodeAccessURLFetch, "create healthz request: %s", err)
r.Severity = health.SeverityError
return
}

res, err := opts.Client.Do(req)
if err != nil {
r.Error =ptr.Ref(health.Messagef(health.CodeAccessURLFetch, "get healthz endpoint: %s", err))
r.Error = health.Errorf(health.CodeAccessURLFetch, "get healthz endpoint: %s", err)
r.Severity = health.SeverityError
return
}
defer res.Body.Close()

body, err := io.ReadAll(res.Body)
if err != nil {
r.Error =ptr.Ref(health.Messagef(health.CodeAccessURLFetch, "read healthz response: %s", err))
r.Error = health.Errorf(health.CodeAccessURLFetch, "read healthz response: %s", err)
r.Severity = health.SeverityError
return
}
Expand Down
2 changes: 1 addition & 1 deletioncoderd/healthcheck/accessurl_test.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -131,7 +131,7 @@ func TestAccessURL(t *testing.T) {
assert.Equal(t, string(resp), report.HealthzResponse)
assert.Nil(t, report.Error)
if assert.NotEmpty(t, report.Warnings) {
assert.Contains(t, report.Warnings[0], health.CodeAccessURLNotOK)
assert.Equal(t, report.Warnings[0].Code, health.CodeAccessURLNotOK)
}
})

Expand Down
17 changes: 8 additions & 9 deletionscoderd/healthcheck/database.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,10 @@ import (
"context"
"time"

"golang.org/x/exp/slices"

"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/healthcheck/health"
"github.com/coder/coder/v2/coderd/util/ptr"

"golang.org/x/exp/slices"
)

const (
Expand All@@ -18,10 +17,10 @@ const (
// @typescript-generate DatabaseReport
type DatabaseReport struct {
// Healthy is deprecated and left for backward compatibility purposes, use `Severity` instead.
Healthy bool `json:"healthy"`
Severity health.Severity `json:"severity" enums:"ok,warning,error"`
Warnings []string `json:"warnings"`
Dismissed bool `json:"dismissed"`
Healthy bool`json:"healthy"`
Severity health.Severity`json:"severity" enums:"ok,warning,error"`
Warnings []health.Message `json:"warnings"`
Dismissed bool`json:"dismissed"`

Reachable bool `json:"reachable"`
Latency string `json:"latency"`
Expand All@@ -38,7 +37,7 @@ type DatabaseReportOptions struct {
}

func (r *DatabaseReport) Run(ctx context.Context, opts *DatabaseReportOptions) {
r.Warnings = []string{}
r.Warnings = []health.Message{}
r.Severity = health.SeverityOK
r.Dismissed = opts.Dismissed

Expand All@@ -55,7 +54,7 @@ func (r *DatabaseReport) Run(ctx context.Context, opts *DatabaseReportOptions) {
for i := 0; i < pingCount; i++ {
pong, err := opts.DB.Ping(ctx)
if err != nil {
r.Error =ptr.Ref(health.Messagef(health.CodeDatabasePingFailed, "ping database: %s", err))
r.Error = health.Errorf(health.CodeDatabasePingFailed, "ping database: %s", err)
r.Severity = health.SeverityError

return
Expand Down
2 changes: 1 addition & 1 deletioncoderd/healthcheck/database_test.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -143,7 +143,7 @@ func TestDatabase(t *testing.T) {
assert.Equal(t, time.Second.Milliseconds(), report.ThresholdMS)
assert.Nil(t, report.Error)
if assert.NotEmpty(t, report.Warnings) {
assert.Contains(t, report.Warnings[0], health.CodeDatabasePingSlow)
assert.Equal(t, report.Warnings[0].Code, health.CodeDatabasePingSlow)
}
})
}
Loading
[8]ページ先頭
©2009-2025 Movatter.jp