DotNetDiag HealthChecks
Reference Manual
Start from a supported integration path, then open package references when you need provider-specific options, overloads, or implementation notes.
The generated package reference section remains part of the manual, but it now sits behind the main narrative instead of looking like a second top-level documentation area.
Read by scenario
Supported integration paths
Follow the path that matches the rollout you are doing today, then branch into chapter or appendix detail only when needed.
Minimal service
Health checks only
Register checks, choose provider packages, and expose health endpoints with the smallest footprint.
Dashboard rollout
Add the UI
Configure dashboard storage, polling, notifications, branding, and runtime deployment.
Cluster rollout
Add Kubernetes
Combine probes, discovery, and operator-based deployment in cluster environments.
Core manual
Read by topic
These chapters form the main narrative path of the manual.
Getting Started
Minimal registration patterns, endpoint exposure, and the first package decision.
Package Catalog
Choose the right package family before you drill into provider-specific package reference pages.
Publishers and Metrics
Outbound publishing, Prometheus scraping, and observability-focused integrations.
HealthChecks UI Manual
Dashboard configuration, storage providers, polling cadence, and UI runtime behavior.
Deployment and Integrations
Kubernetes, Azure DevOps, Docker-adjacent deployment, and operational integration notes.
Tutorials and Samples
Walkthroughs and sample-oriented guidance for teams validating an adoption path.
Package references
Package references and supporting material
The generated package reference section keeps package, extension, and sample documentation inside the manual without creating a second top-level area.