chore: Proxy health status checks + endpoint #7233
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
At a given interval will check the reachability of workspace proxies.
Comment on lines
+81
to
+88
| healthCheckDuration := prometheus.NewHistogram(prometheus.HistogramOpts{ | ||
| Namespace: "coderd", | ||
| Subsystem: "proxyhealth", | ||
| Name: "health_check_duration_seconds", | ||
| Help: "Histogram for duration of proxy health collection in seconds.", | ||
| Buckets: []float64{0.001, 0.005, 0.010, 0.025, 0.050, 0.100, 0.500, 1, 5, 10, 30}, | ||
| }) | ||
| opts.Prometheus.MustRegister(healthCheckDuration) |
There was a problem hiding this comment.
Should probably have a labeled metric too with the proxy name.
There was a problem hiding this comment.
This is the total duration to check all proxies. I just wanted to make sure this routine doesn't end up taking forever
| ProxyToken: fullToken, | ||
| }) | ||
|
|
||
| // Update the proxy health cache to include this new proxy. | ||
| go api.forceWorkspaceProxyHealthUpdate(api.ctx) |
There was a problem hiding this comment.
This won't do anything since it's not registered yet.
There was a problem hiding this comment.
It adds the "Unregistered" to the cache. Before you call this, the proxy is not in the cache since the cache pulls it's list from the database.
So subsequent calls to proxy will now return this unregistered.
deansheather
approved these changes
Apr 24, 2023
| } | ||
| // A switch statement felt easier to categorize the different cases than | ||
| // if else statements or nested if statements. | ||
| switch { |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this does
Workspace proxy feature (currently experimental) needs a health check to determine which workspace proxies are currently available. Without this, users could be directed to unreachable proxies.
This instantiates an in-memory cache that periodically checks the reach-ability of all workspace proxies and saves them. The endpoints that return workspace proxies now include health information.
Fixes #6909