Skip to content

docs(observability): the health check and the metrics endpoint - #2123

Merged
rubenvdlinde merged 1 commit into
developmentfrom
cloud/b-stackiq-observability-docs
Nov 22, 2026
Merged

rubenvdlinde merged 1 commit into
developmentfrom
cloud/b-stackiq-observability-docs

Conversation

@rubenvdlinde

Copy link
Copy Markdown
Contributor

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 the adr006 policy), GET /api/metrics (administrators only, Prometheus text 0.0.4 with stackiq_info, stackiq_up and stackiq_gebruik_total), probe and scrape examples, the manifest's observability block as the source of truth, and a note that /api/settings/status is a settings endpoint, not a health check.
  • Linked from docs/features/README.md; CHANGELOG entry under Unreleased.
  • Ticks adopt-apphost task 4.1.

Checks

  • hydra diff check: floor and phpunit pass. gates report gate-66 (openregister-dependency-shape) with 2 findings in lib/Lifecycle/ArchitectureDecisionReviewGuard.php and lib/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.
  • PHPUnit unit: 4413 tests, 2 failures (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

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
@rubenvdlinde
rubenvdlinde merged commit 0224354 into development Nov 22, 2026
5 of 7 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

Quality Report — ConductionNL/stackiq @ 8e6e00b

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant