Skip to content

Health Checks Aggregator — organizational overview

The Health Checks Aggregator template runs a dedicated operations host that polls many downstream health endpoints, surfaces a Health Checks UI, exposes JSON APIs, and can drive readiness gates and webhooks for alerting. It is not a domain microservice—it exists for fleet visibility.

Why use this template

  • One pane of glass for SRE and platform teams during incidents, maintenance windows, and major releases.
  • Safer rollouts: orchestration (Kubernetes, deployment pipelines) can key readiness on aggregated rules, not a single green ping on one pod.
  • Faster diagnosis: dependency-oriented views and history (when enabled) narrow “what broke?” conversations.
  • Shared investment: every product team stops building its own half-broken health dashboard host.

Typical use cases

  • Platform or NOC visibility over tens or hundreds of internal HTTP health endpoints.
  • Release gating where a rollout should not complete until critical dependencies report healthy together.
  • Alert routing when a dependency tier flips (e.g., notify ChatOps/webhook targets on state transitions).

Capabilities (what you get)

  • Aggregation host that polls a catalog of downstream HTTP health URLs (timeouts, retries, caching, and optional “critical” flags) so stakeholders see fleet status, not one service at a time.
  • Health Checks UI for operators (with SQL-backed history or in-memory storage for lighter environments), plus template switches for Docker, API docs, rate limiting, and CORS aligned with other ConnectSoft web templates.
  • Readiness “gate” strategies—for example everything healthy, only critical dependencies, minimum percentage healthy, or tag-based rules—so pipelines and orchestrators can trust /api/health/readiness-style evaluation instead of ad-hoc scripts.
  • Webhooks to notify ChatOps or ticketing when status changes, with configurable payloads and filters (see technical reference for field-level detail).
  • HTTP JSON APIs for automation: roll-up health, per-service views, tag filters, and dependency graph payloads (including human-friendly graph export where supported).
  • Standard probe endpoints (/health, /alive, /startup) so Kubernetes and load balancers integrate the same way as other ASP.NET hosts.
  • Observability options when enabled (structured logging, OpenTelemetry, metrics, resource monitoring) through the same baseline as Base Template—without mixing product domain code into this host.

Architecture, full dotnet new parameter tables, exact HealthCheckAggregator settings, OpenAPI paths, webhook schema, authentication, resilience, testing, development notes, runbooks, and Kubernetes examples are not duplicated here.

→ Health Checks Aggregator — Features (ConnectSoft.Documentation) — parameters, configuration, REST surface, readiness strategies, webhooks

→ Health Checks Aggregator — technical hub / full navigation (ConnectSoft.Documentation)