Skip to content

chore: add debug information to wsproxy errors #9683

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 2 commits into from
Sep 20, 2023
Merged

chore: add debug information to wsproxy errors #9683

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9eb11ce
chore: add debug information to wsproxy errors
Emyrk Sep 14, 2023
bad257b
Use codersdk.ReadBodyAsError
Emyrk Sep 20, 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
Next Next commit
chore: add debug information to wsproxy errors
  • Loading branch information
@Emyrk
Emyrk committed Sep 14, 2023
commit 9eb11ce052f3fa5b3043226ee27d2053ce8e1a6d
28 changes: 27 additions & 1 deletion enterprise/coderd/proxyhealth/proxyhealth.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"context"
"encoding/json"
"fmt"
"io"
"net/http"
"net/url"
"strings"
Expand Down Expand Up @@ -289,7 +290,32 @@ func (p *ProxyHealth) runOnce(ctx context.Context, now time.Time) (map[uuid.UUID
case err == nil && resp.StatusCode != http.StatusOK:
// Unhealthy as we did reach the proxy but it got an unexpected response.
status.Status = Unhealthy
status.Report.Errors = []string{fmt.Sprintf("unexpected status code %d", resp.StatusCode)}
var builder strings.Builder
builder.WriteString(fmt.Sprintf("unexpected status code %d. ", resp.StatusCode))
contentType := resp.Header.Get("content-type")
body, _ := io.ReadAll(resp.Body)

switch {
case strings.Contains(contentType, "html"):
// Showing html payloads is useful, but we display this error message
// on our FE. An html payload is quite large and would be hard to
// format decently. Just tell the user to make the request themselves
// to observe the response.
builder.WriteString(fmt.Sprintf("\nThe response was html, which is unexpected. "+
"Send a request to %s from the Coderd environment to debug this issue.", reqURL))
case strings.Contains(contentType, "json"):
builder.WriteString(fmt.Sprintf("\nJSON response payload: %s", string(body)))
default:
// Just set an arbitrary cutoff point. The user can always debug with a manual request.
if len(body) < 1000 {
builder.WriteString(fmt.Sprintf("\n%q response payload: %s", contentType, string(body)))
} else {
builder.WriteString(fmt.Sprintf("\nThe response content type was %q, which is unexpected. "+
"Send a request to %s from the Coderd environment to debug this issue.", contentType, reqURL))
}
}

status.Report.Errors = []string{builder.String()}
case err != nil:
// Request failed, mark the proxy as unreachable.
status.Status = Unreachable
Expand Down