docs: reword latency explanation for HA #8860
Conversation
Signed-off-by: Spike Curtis <spike@coder.com>
| to each other so that they can effectively relay traffic between users and workspaces no | ||
| matter which Coderd instance users or workspaces connect to. We make a best-effort attempt | ||
| to warn the user when inter-Coderd latency is too high, but if requests start dropping, this | ||
| is one metric to investigate. |
There was a problem hiding this comment.
suggestion: note specific metrics, link to https://coder.com/docs/v2/latest/admin/prometheus
There was a problem hiding this comment.
I don't think we expose this over Prometheus... @kylecarbs ?
| For Coder to operate correctly, Coderd instances should have low-latency connections | ||
| to each other so that they can effectively relay traffic between users and workspaces no | ||
| matter which Coderd instance users or workspaces connect to. We make a best-effort attempt | ||
| to warn the user when inter-Coderd latency is too high, but if requests start dropping, this |
There was a problem hiding this comment.
What do we consider "too high" for the health check? We might as well document this threshold as well.
There was a problem hiding this comment.
TBH, I'm not sure what this is referring to. @kylecarbs do you know?
There was a problem hiding this comment.
@bpmct this text is not being changed by this PR, just whitespace. I understand the desire to get better documentation around the health check, but it's scope creep for this PR. Can we agree on whether or not the changes this PR is making are appropriate so it can get merged?
There was a problem hiding this comment.
Ah I misunderstood it as a text change.
Removes references to a specific latency time, and instead explains what Coderd is doing that requires low-latency.