Repository navigation
feat(ops): monitoring endpoints and a status page link - #99
Merged
Merged
Conversation
Adds GET /api/health to the dashboard so uptime monitors have an unauthenticated target, a STATUS_PAGE_URL setting that shows "System status" in the user menu, and a self-hosting page listing what to monitor (with the responses each check should get) and how to publish a status page with Upptime or Uptime Kuma. Refs #69
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Part of #69. The status page itself (hosting, DNS for
status.sendlit.app, links on the sendlit.app site) is outside this repo; see "Left to do" below.What
apps/web:GET /api/healthreturns200 {status:"ok"}withno-storeand needs no sign-in. This gives monitors a dashboard check; until now/only redirected to login.STATUS_PAGE_URL(web, server-only, http(s) only) adds System status to the user menu on every dashboard page. Documented in.env.exampleandapps/web/.env.example.Docs:
self-hosting/monitoringlists every check with its expected response, all verified against a running stack:/health/ready/api/healthPOST /mcpwithout credentials/track/open/unsubscribe/<invalid>/openapi.jsonIt also covers publishing a status page with Upptime or Uptime Kuma.
Verification
check.sh(format, lint, typecheck, 715 API tests, web tests incl. new route, config and nav-user tests); docs build./api/healthloads in a signed-out browser without redirecting.STATUS_PAGE_URLin a new tab, on the home page and on other dashboard pages. This step caught that the home page renders its own sidebar outside the dashboard layout; fixed.Left to do (needs an owner decision and outside access)
app.sendlit.app,api.sendlit.appanddocs.sendlit.app.status.sendlit.appCNAME to the status host.STATUS_PAGE_URL=https://status.sendlit.appon the hosted web app./help(marketing site, not in this repo).