Backend: expose health checks via REST (GET /api/health) #108
Closed
opened 2026-07-02 19:44:03 +02:00 by timothy
·
2 comments
No Branch/Tag Specified
main
renovate/dotnet-monorepo
renovate/meziantou.analyzer-3.x
renovate/lucene.net
renovate/sqlitepclraw.bundle_e_sqlite3-3.x
renovate/cliwrap-3.x
913-scripted-playout-401
release/v26.15.0-notes
issue-806-guard-populations
scratch/767b-poisoned
scratch/767b-control
release/v26.14.0-notes
release/v26.14.0
docs/510-skill-logo-bug-policy
fix/510-watermark-resolution-policy
fix/629-verdict-classifier-falseopens
fix/609-decisions-edit-token-scope
issue-135-clear-to-none
release/v26.12.0-notes
fix/409b-lastscan-api-parity
fix/401-updatechannel-mirror-422
fix/327-playlist-rename-validation
fix/410-scancancel-log-level
fix/409-447-librariesscreen-neverscanned
fix/338-zap-exit-code
fix/367-plex-budget-message
fix/310-debom-legacy-cs
ci/604-lane-rebalance
feat/388-design-mirror
feat/247-test-ownership
feat/247-primary-action
feat/357-player-owned-playback
feat/357-jellyfin-plugin-poc
fix/289-mcp-hardening
issue58-mcp
feat/244-channels-extract
ci/auto-bump-prod-compose
feat/multi-rerun-collections-api
feat/collections-api
feat/quick-wins
feat/185-docs-part2
feat/140-collections-screen
feat/146-channel-edit
feat/147-classic-ui-link
issue22-renovate-dashboard
feat/91-cutover
feat/63-composite-create
feat/65-library-browse
feat/85-epg
feat/86-schedule-editor
feat/109-dashboard-data
feat/99-session-tracking
fix/dockerfile-node-tag
feat/59-spa-foundation
docs/59-ui-redesign-brief
feat/102-json-guide
feat/111-schedule-durations
feat/104-artwork-upload
feat/103-media-sources-api
feat/playouts-read-api
feat/108-health-api
feat/105-picker-list-endpoints
issue-97-channel-state-api
issue42-jellyfin-musicvideos
issue46-rest-api-error-contract
dependabot/nuget/ErsatzTV.FFmpeg.Tests/multi-d307a2e06f
qsv-improvements
hdr-vulkan-cuda-test
v26.16.0
v26.15.0
v26.14.0
v26.13.0
v26.12.0
v26.11.0
v26.10.0
v26.9.0
v26.8.0
v26.7.0
blazor-final
v26.6.0
v26.5.0
v26.4.0
v26.3.1
v26.3.0
v26.2.0
v26.1.1
v26.1.0
v25.9.0
v25.8.0
v25.7.1
v25.7.0
v25.6.0
v25.5.0
v25.4.0
v25.3.1
v25.3.0
v25.2.0
v25.1.0
v0.8.8-beta
v0.8.7-beta
v0.8.6-beta
v0.8.5-beta
v0.8.4-beta
v0.8.3-beta
v0.8.2-beta
v0.8.1-beta
v0.8.0-beta
v0.7.9-beta
v0.7.8-beta
v0.7.7-beta
v0.7.6-beta
v0.7.5-beta
v0.7.4-beta
v0.7.3-beta
v0.7.2-beta
v0.7.1-beta
v0.7.0-beta
v0.6.9-beta
v0.6.8-beta
v0.6.7-beta
v0.6.6-beta
v0.6.5-beta
v0.6.4-beta
v0.6.3-beta
v0.6.2-beta
v0.6.1-beta
v0.6.0-beta
v0.5.8-beta
v0.5.7-beta
v0.5.6-beta
v0.5.5-beta
v0.5.4-beta
v0.5.3-beta
v0.5.2-beta
v0.5.1-beta
v0.5.0-beta
v0.4.5-alpha
v0.4.4-alpha
v0.4.3-alpha
v0.4.2-alpha
v0.4.1-alpha
v0.4.0-alpha
v0.3.8-alpha
v0.3.7-alpha
develop
v0.3.6-alpha
v0.3.5-alpha
v0.3.4-alpha
v0.3.3-alpha
v0.3.2-alpha
v0.3.1-alpha
v0.3.0-alpha
v0.2.5-alpha
v0.2.4-alpha
v0.2.3-alpha
v0.2.2-alpha
v0.2.1-alpha
v0.2.0-alpha
v0.1.5-alpha
v0.1.4-alpha
v0.1.3-alpha
v0.1.2-alpha
v0.1.1-alpha
v0.1.0-alpha
v0.0.62-alpha
v0.0.61-alpha
v0.0.60-alpha
v0.0.59-alpha
v0.0.58-alpha
v0.0.57-alpha
v0.0.56-alpha
v0.0.55-alpha
v0.0.54-alpha
v0.0.53-alpha
v0.0.52-alpha
v0.0.51-alpha
v0.0.50-alpha
v0.0.49-prealpha
v0.0.48-prealpha
v0.0.47-prealpha
v0.0.46-prealpha
v0.0.45-prealpha
v0.0.44-prealpha
v0.0.43-prealpha
v0.0.42-prealpha
v0.0.41-prealpha
v0.0.40-prealpha
v0.0.39-prealpha
v0.0.38-prealpha
v0.0.37-prealpha
v0.0.36-prealpha
v0.0.35-prealpha
v0.0.34-prealpha
v0.0.33-prealpha
v0.0.32-prealpha
v0.0.31-prealpha
v0.0.30-prealpha
v0.0.29-prealpha
v0.0.28-prealpha
v0.0.27-prealpha
v0.0.26-prealpha
v0.0.25-prealpha
v0.0.24-prealpha
v0.0.23-prealpha
v0.0.22-prealpha
v0.0.21-prealpha
v0.0.20-prealpha
v0.0.19-prealpha
v0.0.18-prealpha
v0.0.17-prealpha
v0.0.16-prealpha
v0.0.15-prealpha
v0.0.14-prealpha
v0.0.13-prealpha
v0.0.12-prealpha
v0.0.11-prealpha
v0.0.10-prealpha
v0.0.9-prealpha
v0.0.8-prealpha
v0.0.7-prealpha
v0.0.6-prealpha
v0.0.5-prealpha
v0.0.4-prealpha
v0.0.3-prealpha
v0.0.2-prealpha
v0.0.1-prealpha
Labels
Clear labels
ad-hoc
api
bug
ci-cd
content
dependencies
enhancement
frontend
in-progress
jellyfin
parked
priority: high
priority: low
priority: medium
review
security
One-off / ad-hoc work not tracked by a dedicated issue
REST API / HTTP endpoints
Something isn't working
Build, test, deploy pipeline
Channel content / schedules / playlists
Dependency updates (Renovate)
New feature or improvement
ChicoryTV React SPA frontend
Claimed by an active session — do not pick up
Jellyfin tuner / IPTV integration
Excluded from automatic queue pickup; work only when explicitly selected
Adversarial review finding
Security / vulnerability fix
Milestone
No items
No Milestone
Projects
Clear projects
No projects
No Assignees
Notifications
Due Date
No due date set.
Blocks
Reference: timothy/ersatztv#108
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
From the ChicoryTV plan audit (epic #59, 2026-07-02).
A full health-check engine exists (
GetAllHealthCheckResults+ErsatzTV.Core/Health/Checks/*— the exact checks the Dashboard prototype mocked) but it is a MediatR query consumed only by Blazor. The shipped SPA Dashboard consequently fabricates its health panel from entity counts, and the shell footer hardcodes "Healthy".Scope
GET /api/healthreturning check results{title, status (pass/info/warn/fail), detail, link?}fromGetAllHealthCheckResults.Unblocks: Dashboard follow-up (real health panel + fail/warn badge counts), shell footer status dot. Related: #72 (channel lineup health — distinct, per-channel concept).
Effort: S (pure wrapper).
Picking this up. Reviewed the salvaged WIP on
feat/108-health-apiagainst the issue + API conventions:Keeping: query/handler/mapper structure (delegates to
IHealthCheckService.PerformHealthChecks, filtersNotApplicable, maps enum → lowercasepass|fail|warn|info), handler tests, controller tests.Fixing:
HealthCheckResponseModel.Linkshould bestring?(with file-scoped#nullable enable— Core has Nullable=disable) since the mapper emits null when no link.Nameon the route,[Tags],[EndpointSummary],[EndpointGroupName("general")]) per the #97/#105 pattern.Design note: each
GET /api/healthre-runs all ~14 checks (same as the Blazor dashboard per page load; only the warn/error summary is cached). Fine for on-demand loads, but the SPA footer/dashboard should not poll this endpoint aggressively — noting this for #109.Closing summary (PR #114, merged to main, CI green):
What was done:
GET /api/health(route nameGetHealthChecks, groupgeneral) returning[{title, status, detail, link?}]withstatus∈pass|fail|warn|info, sourced fromIHealthCheckService.PerformHealthChecks— identical semantics to the Blazor dashboard (NotApplicablefiltered, cancellation returns empty list,detail= the longMessagefield). Started from the salvaged WIP, rebased onto post-#113 main.Root cause of WIP bug: the draft used
Option<HealthCheckLink>.Matchwith a null-returning branch — LanguageExt guardsMatchagainst null results (ResultIsNullException), so every check without a link would have thrown at runtime. Fixed withMatchUnsafe(the sanctioned nullable-result variant). Caught because the tests were actually run (3/4 handler tests failed on the draft).Files changed:
ErsatzTV.Application/Health/{Mapper,Queries/GetAllHealthCheckResultsForApi,Queries/GetAllHealthCheckResultsForApiHandler}.cs,ErsatzTV.Core/Api/Health/HealthCheckResponseModel.cs(first#nullable enableDTO in Core/Api — pattern for future nullable fields),ErsatzTV/Controllers/Api/HealthController.cs, handler + controller tests,v1.jsonregen. 278/278 tests pass.Review: adversarial review verdict APPROVE (no blockers/majors); applied the one minor — the unreachable
NotApplicable→\"info\"mapper arm now throws instead of masking a missing filter.Deferred / notes for #109: each request re-runs all ~14 health checks (same as Blazor per page load; only the warn/error summary is cached in memory) — the SPA footer/Dashboard should load on demand or poll gently, not aggressively. No caching added (kept scope to the issue; add a TTL later if polling needs it).
Docs: none needed beyond the OpenAPI regen (endpoint is self-describing in
/docs); handoff queue doc updated for the next session.