Repository navigation
feat: add pubsub section to the health page - #31788
spikecurtis merged 1 commit into
Conversation
65f846c to
c9e83fe
Compare
…the wait (#32097) The doc-check chat keeps running in Coder after the job stops waiting at 40 minutes, and it posts its own comment when it is done. When the local model is busy, reviews run past the wait and the check goes red even though nothing failed. 33 of 46 doc-check runs today ended red this way, including on #32088, #31788, #31621 and #31620. ## Changes - `continue-on-error` on the agents-chat-action step. - New step that ends with a notice when the wait timed out and the chat is still `running` or `pending`, and fails the job for every other error. Generated by Coder Agents on behalf of @bpmct.
cstyan
left a comment
There was a problem hiding this comment.
Approving, I think I understand the typescript code + chain of PRs enough to say this will work. I'm not very familiar with the go -> ts types generation though.
A couple questions, but none are blocking:
- I think none of the docs/swagger changes are needed here in this PR?
make genis failing in earlier parts of the stack so shouldn't those changes be there? - I think the PR description about the ordering of the sub pages is incorrect? technically we did put pubsub in after database in the list, but AFAICT we sort the visible sections
- Do we want to do any mapping of go backend name to something nicer? currently we'd just print
postgres,nats,memory. Should those bePostgres/PostgeSQL,In-memory`, etc.?
Documentation CheckBoth findings below are about Blocking
Suggestions
Findings for agents- id: learner-1
persona: learner
class: missing
blocking: true
file: docs/admin/monitoring/health-check.md
line: 333
quote: "This section appears in the [JSON response](../../reference/api/debug.md#debug-info-deployment-health)."
evidence:
- site/src/router.tsx:821
- site/src/pages/HealthPage/HealthLayout.tsx:50
- site/src/pages/HealthPage/PubsubPage.tsx:17-63
rule: null
problem: The sentence tells the reader Pubsub is JSON-only; this PR adds a dashboard page for it, unlike every sibling section's plain dashboard introduction.
fix: Drop or rephrase the sentence so Pubsub is introduced like its peer sections.
verified: true
- id: learner-2
persona: learner
class: suggestion
blocking: false
file: docs/admin/monitoring/health-check.md
line: 332
quote: "The health check reports which pubsub backend the Coder replica uses, either `nats` for the embedded NATS server or `postgres` for PostgreSQL, and whether that backend is connected."
evidence:
- site/src/pages/HealthPage/PubsubPage.tsx:54-57
rule: null
problem: The Backend field can show "Unknown" (empty backend), a state the docs don't name.
fix: Add a sentence naming the "Unknown" state.
verified: trueAutomated review via Coder Agents. Reply to a finding's thread with the reason if the finding is wrong. |
86b885c to
fb16d48
Compare
Shows the pubsub backend, any error, and each warning with a docs link, and lets admins mute the section like the others.
fb16d48 to
9cd74ca
Compare
Yeah, fixed below in the stack.
Dropped it from the description.
Personally, I don't mind showing "debug" looking stuff in the health check page. Zero of our Coder operators are going to see "postgres" as having a different meaning than "PostgreSQL". |
Stacked on #31621.
Adds a Pubsub section to the deployment health page (
/health/pubsub). It shows:postgresornats).The section is added to the health sidebar. Storybook stories cover the default, warning (NATS), and error states.
Plan and decisions
DatabasePage: it reads the report from the outlet context and renders warnings as dismissible Alerts withHealthMessageDocsLink.code-messageinstead ofcode. The NATS backend can report the same code (EPS01) once for each publish and subscribe connection, so a key oncodealone could repeat.pubsub.erroras an error Alert, because the server setserrorwhen the report cannot be produced.sectionsmap inHealthLayout, so the severity dot and the dismissed state work the same way as in other sections.Pubsub(default MockHealth),WithWarnings(NATS with EPS02 and two EPS01 warnings),WithError.Generated by Coder Agents on behalf of @spikecurtis.