Repository navigation
docs(observability): the health check and the metrics endpoint - #2123
Merged
Merged
Conversation
The page explains GET /api/health (public, rate limited, 503 when a critical check fails), GET /api/metrics (administrators, Prometheus text 0.0.4 with stackiq_info, stackiq_up and stackiq_gebruik_total), the manifest's observability block as their source, and that /api/settings/status is a settings endpoint, not a health check. Ticks adopt-apphost task 4.1. Assisted-by: ClaudeCode:claude-opus-5-5
Contributor
Quality Report — ConductionNL/stackiq @
|
| Check | PHP | Vue | Security | License | Tests |
|---|---|---|---|---|---|
| lint | ✅ | ||||
| phpcs | ✅ | ||||
| phpmd | ❌ | ||||
| psalm | ❌ | ||||
| phpstan | ✅ | ||||
| phpmetrics | ✅ | ||||
| eslint | ❌ | ||||
| stylelint | ✅ | ||||
| build | ✅ | ||||
| check-manifest | ✅ | ||||
| check-vue-demi | ✅ | ||||
| test-l10n | ✅ | ||||
| format | ❌ | ||||
| check-schema-l10n | ❌ | ||||
| check-l10n-js | ✅ | ||||
| composer | ❌ | ✅ 150/150 | |||
| npm | ✅ | ✅ 811/811 | |||
| app:check-code | ⏭️ | ||||
| info.xml | ✅ | ||||
| REUSE | ❌ | ||||
| lockfile sync | ✅ | ||||
| PHPUnit | ⏭️ not run for this diff — no file in this diff matches the code globs, and none carries a source extension — the heavy tier has nothing to decide about it. | ||||
| Newman | ⏭️ | ||||
| Playwright | ⏭️ deferred: E2E runs locally and on the promotion path only. This pull request targets development, so the suite is asked once per promotion into beta and main rather than once per push per open pull request. Run it locally with npx playwright test, or from the Actions tab on a branch with no open pull request into development. |
||||
| Hydra gates | ❌ |
Quality workflow — 2026-11-22 03:17 UTC
Download the full PDF report from the workflow artifacts.
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
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.
Documents stackiq's health and metrics endpoints (adopt-apphost task 4.1).
What changes
docs/features/observability.md:GET /api/health(public, rate limited at 240 a minute,{status, app, version, checks}, 503 only when a critical check fails under theadr006policy),GET /api/metrics(administrators only, Prometheus text 0.0.4 withstackiq_info,stackiq_upandstackiq_gebruik_total), probe and scrape examples, the manifest'sobservabilityblock as the source of truth, and a note that/api/settings/statusis a settings endpoint, not a health check.docs/features/README.md; CHANGELOG entry under Unreleased.Checks
openregister-dependency-shape) with 2 findings inlib/Lifecycle/ArchitectureDecisionReviewGuard.phpandlib/Service/Registration/ServiceFactories.php, files this PR does not touch; the gate fails the same way on development.composer check:strict: lint, phpcs (warnings only) and phpstan pass. phpmd and psalm fail on development's code (psalm needs PHP 8.3.16, this run had 8.3.6). No PHP changes here.BaselineClassificationDeclarationTest::testTheUsageVersionRisesSoTheImportRuns,UsageParticipantReadRuleTest::testTheVersionMovesSoTheImportApplies), the same set as development; this PR changes no code or tests.npm run lint: 21 errors, all in files from development.Generated by Claude Code