SG.HealthChecks.SqlServer 1.0.0

SG Health Check

English | Português (Brasil)

An ASP.NET Core stack for health checks with a web dashboard (Health Checks UI), aimed at monitoring APIs and dependencies on SG / Source Genesys platforms.

This repository is a brand- and package-oriented fork using the SG. prefix, based on the community project AspNetCore.Diagnostics.HealthChecks.

NuGet packages

Project references versus published packages

The projects under src/ use ProjectReference links to each other. That is the usual pattern for one solution: dotnet pack produces one .nupkg per packable project and records dependencies between the published package IDs (SG.*). You would switch to PackageReference only when consuming these libraries from another repository after they are available on a feed (for example NuGet.org).

Install from NuGet.org

After packages are published, add them to an ASP.NET Core project (examples):

dotnet add package SG.HealthChecks
dotnet add package SG.HealthChecks.UI
dotnet add package SG.HealthChecks.UI.Client

SG.HealthChecks is the meta-package at the repository root (SG.HealthCheck.csproj): it pulls in Microsoft health-check, EF Core SQL Server, HTTP, and related dependencies used across SG stacks. Individual features (dashboard, storage, checks) ship as SG.HealthChecks.* packages built from src/src.sln.

Controlling package version

Default library version in src/Directory.Build.props is 10.0.0 until you override it.

CI publish (NuGet.org Trusted Publishing)

The workflow .github/workflows/publish.yml restores, builds, tests, packs src/src.sln and the root meta-project, then authenticates with NuGet.org Trusted Publishing (GitHub OIDC via NuGet/login@v1) and pushes artifacts/nuget/*.nupkg to https://api.nuget.org/v3/index.json. No long-lived NUGET_AUTH_TOKEN repository secret is required.

GitHub: the job uses environment: production, permissions: id-token: write, and a repository variable NUGET_USERNAME (your NuGet.org profile user name — not your email). Configure the production environment under Settings → Environments if it does not exist yet.

NuGet.org: create a Trusted Publishing policy for the package owner, matching this repository, workflow file publish.yml, and (recommended) environment production. See Trusted Publishing.

Version resolution in CI (first match wins):

1. Manual run: input version on workflow_dispatch.
2. Push of a Git tag v* (for example v2.1.0 → version 2.1.0).
3. Repository variable PACKAGE_VERSION (Settings → Secrets and variables → Actions → Variables) to pin a default version for main when you do not use tags or manual input.
4. Otherwise on main: 1.0.0-ci.<GitHub run number> (unique prerelease builds).

Use PACKAGE_VERSION when you want every main build to use a fixed semver until you change the variable; leave it unset to keep the automatic 1.0.0-ci.* scheme.

Push command: dotnet nuget push uses --api-key with ${{ steps.nuget-login.outputs.NUGET_API_KEY }} — the short-lived key from Trusted Publishing via NuGet/login, not a long-lived repository secret. The dotnet nuget push docs describe -k / --api-key as how to supply the key; they do not state that NUGET_AUTH_TOKEN alone (with no --api-key) is a supported substitute for pushing to nuget.org. The setup-dotnet examples for publishing typically use -k $NUGET_AUTH_TOKEN, i.e. the key is still passed into the command explicitly. This workflow therefore uses --api-key with the OIDC step output (no secrets.NUGET_AUTH_TOKEN).

Upstream project (official documentation)

Full documentation—including the complete NuGet package list, Kubernetes, Docker, Azure DevOps, and samples—is in the official repository:

https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks

For package behavior, APIs, and appsettings configuration, use the upstream README and doc/ folder as the primary reference; this README focuses on what is specific to the SG fork.

What is included (this repo)

The SG logo is part of the open source project identity.

Requirements

• .NET SDK compatible with .NET 10 (net10.0 in the projects).
• Node.js (to rebuild React/Webpack UI assets when you change the front end).

Build

Libraries (.NET)

dotnet build src/src.sln -c Release

The repository also contains SGI.HealthCheck.slnx / SG.HealthCheck.csproj at the root (NuGet id SG.HealthChecks)—use whichever workflow fits your CI.

UI front end (optional, after changes under client/ or assets)

cd src/HealthChecks.UI
npm ci
npm run build

This regenerates the Webpack bundle consumed by the HealthChecks.UI package (DLL + production bundle).

Integrate into your API

1. Copy or adapt Program.cs.EXAMPLE into your Program.cs (register AddHealthChecks, AddHealthChecksUI, map /health, /healthchecks-ui, etc.).
2. Use appsettings.Example.json as a starting point for logging and configuration.
3. To persist dashboard history beyond memory, replace AddInMemoryStorage() with AddSqlServerStorage(connectionString) (see comments in the example).

Further details (polling, UIResponseWriter, webhooks, relative URLs) follow the same patterns described in the Xabaril README.

Typical endpoints

Adjust paths and titles to match your MapHealthChecksUI setup.

Security and secrets

• Do not commit connection strings, passwords, or tokens. Use User Secrets, environment variables, or a vault (e.g. Azure Key Vault) in production.
• .env files (Docker Compose / local dev) often hold credentials or placeholders—keep them out of Git (.gitignore) and share only a .env.example without sensitive values when needed.
• The dashboard and health endpoints expose service state. On internet-facing environments, protect them with restricted networking (VPN, private ingress), authentication, or equivalent policies—consistent with upstream guidance on sensitive UI and OpenID Connect protection.

License and attribution

This project is distributed under the Apache 2.0 license—see LICENSE.

Code derived from AspNetCore.Diagnostics.HealthChecks must comply with Apache 2.0 attribution practices and the original project.

Brand: the SG name and logo identify this fork; respect usage guidelines when redistributing.

Authors

Menphis Sistemas Inteligentes — packages and maintenance for SG platforms.

Jefferson Saul Gonçalves Motta — jsmotta.com.br

Contributions, issues, and improvements are welcome.