docs(selfhost): document ams-observability and backup in the compose PROFILES header - #6109
Conversation
…PROFILES header (JSONbored#5812) Both are real, wired --profile flags (ams-reporting-exporter and the backup/backup-exporter services) but were missing from docker-compose.yml's own top-of-file PROFILES banner, the first place an operator looks to discover what --profile flags exist. Realigns the whole table to accommodate ams-observability, the new longest entry. Adds a regression test (test/unit/docker-compose-profiles-header.test.ts) that parses every profiles: [...] a service actually declares and every --profile <name> token in the header banner, and asserts the two sets match -- so a future profile addition/removal that forgets the banner fails CI instead of shipping silent doc drift.
|
Superagent didn't find any vulnerabilities or security issues in this PR. |
|
Tip 🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩 ✅ LoopOver review result - approve/merge recommendedReview updated: 2026-07-15 09:50:42 UTC
✅ Suggested Action - Approve/Merge
Review summary Nits — 5 non-blocking
Linked issue satisfactionAddressed Review context
Contributor next steps
Signal definitions
🧪 Chat with LoopOverAsk LoopOver a question about this PR directly in a comment — grounded only in the same cached, public-safe facts shown above, never a new claim.
Full command reference: https://gittensory.aethereal.dev/docs/loopover-commands 🧪 Experimental — new and may change. 🟩 Safe / merged · 🟦 Advisory · 🟨 Held for review · 🟥 Blocked / closed 💰 Earn for open-source contributions like this. Gittensor lets GitHub contributors earn for the work they already do — register to start earning →. Checked by LoopOver, a quiet PR intelligence layer for OSS maintainers.
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #6109 +/- ##
=======================================
Coverage 95.24% 95.24%
=======================================
Files 595 595
Lines 47047 47067 +20
Branches 15015 15016 +1
=======================================
+ Hits 44809 44829 +20
Misses 1493 1493
Partials 745 745
Flags with carried forward coverage won't be shown. Click here to find out more. |
Summary
docker-compose.yml's top-of-filePROFILEScomment banner — the documented entry point for "which--profileflags does this file support" — was missing two real, wired profiles:ams-observability(used by theams-reporting-exporterservice, which exports AMS/loopover-miner attempt-log/prediction-ledger data to Grafana) andbackup(used by thebackupandbackup-exporterservices). Both are already documented elsewhere (.env.example, the website docs), just not in the one place an operator is most likely to look first.ams-observabilityis longer than any prior entry.test/unit/docker-compose-profiles-header.test.ts) that parses everyprofiles: [...]array any service actually declares and every--profile <name>token in the header banner, and asserts the two sets are equal — so a future profile addition/removal that forgets to update the banner fails CI instead of shipping silent doc drift.Scope
type(scope): short summaryConventional Commit format, for examplefix(api): restore profile access checks.CONTRIBUTING.mdand does not reintroduce GitHub Pages, VitePress,site/, orCNAME.Closes #123) — a linked open issue is required for every contributor PR.Closes #5812
Validation
git diff --checknpm run actionlintnpm run typechecknpm run test:coveragelocally;codecov/patchrequires ≥99% coverage of the lines AND branches you changed (aim for 100% on your diff so CI variance does not fail near the threshold). Global coverage is a non-blocking trend with a loose 90% backstop, not the gate.npm run test:workersnpm run build:mcpnpm run test:mcp-packnpm run ui:openapi:checknpm run ui:lintnpm run ui:typechecknpm run ui:buildnpm audit --audit-level=moderateIf any required check was skipped, explain why:
npm run test:cichain's localtsc --noEmitstep OOM-crashes reproducibly. This PR changes zero application.ts/.jssource logic — only a comment block indocker-compose.ymland one new self-contained test file (readFileSync/yaml'sparse, mirroringtest/unit/docker-compose-override-example.test.ts's owndocker-compose.yml-parsing pattern already in the suite). What I could run locally is green:actionlint,db:migrations:check,npm audit, and the new test file plus its siblingdocker-compose-override-example.test.tsin isolation vianpx vitest run— all pass, including both fail-case fixtures proving the new check works. CI'svalidate-code/validate-testsjobs run on GitHub's own isolated runners with no such contention and will independently confirm the rest (typecheck included) before merge — the same pattern used successfully for PRs fix(selfhost): correct stale gittensory_ metric names in .env.example #6079 and fix(observability): correct LoopoverOrbExportErrorRateHigh's stale runbook metric name #6094 earlier this session.Safety
UI Evidencesection below with JPG/JPEG or PNG screenshots arranged as organized, captioned, clickable thumbnails. SVG screenshots are not used as review evidence. Review-only screenshots or recordings are not committed to the repository.Not applicable: this is a compose-file comment + test-only change, no UI/auth/session/API surface touched.
Notes