Health check api by hazel-bohon · Pull Request #5952 · Particular/ServiceControl

hazel-bohon · 2026-10-05T16:13:12Z

Addresses the first part of Replace internal platform health custom checks with an explicit API #5860
Defines a new API endpoint for the frontend to use.

Copilot

Copilot review overview

🟡 Changes recommended

Five-second polling currently forces license discovery and persistence access for every open ServicePulse client.

Review effort: Balanced
Findings: 1

Open (1)

Avoid full license refresh on every platform-health poll · New

What changed in this PR

Adds a dedicated Platform Health API for ServicePulse, separating internal health reporting from customer custom checks.

Changes:

Adds platform health inventory, alerts, licensing, and remote-instance metadata.
Extends configuration discovery and remote probing.
Adds unit, acceptance, authorization, and API approval coverage.

Reviewed against issue #5860, docs/platform-health.md, and the linked ServicePulse models/store. No private context was provided.

File	Description
`src/ServiceControl/ServiceControlApiHostBuilderExtensions.cs`	Registers license information provider.
`src/ServiceControl/PlatformHealth/PlatformHealthState.cs`	Tracks internal health-check state.
`src/ServiceControl/PlatformHealth/PlatformHealthController.cs`	Exposes the health endpoint.
`src/ServiceControl/PlatformHealth/PlatformHealthApi.cs`	Builds platform health responses.
`src/ServiceControl/PlatformHealth.http`	Adds manual API requests.
`src/ServiceControl/Licensing/LicenseInfoProvider.cs`	Extracts shared license mapping.
`src/ServiceControl/Licensing/LicenseController.cs`	Uses the shared provider.
`src/ServiceControl/Infrastructure/WebApi/RemoteInstanceServiceCollectionExtensions.cs`	Preserves remote URL prefixes.
`src/ServiceControl/Infrastructure/Api/ConfigurationApi.cs`	Adds discovery metadata and robust remote probing.
`src/ServiceControl/CustomChecks/CustomChecksComponent.cs`	Registers platform health services.
`src/ServiceControl/CustomChecks/CustomCheckResultProcessor.cs`	Records internal health reports.
`src/ServiceControl.UnitTests/ScatterGather/RemoteInstanceHttpClientTests.cs`	Tests remote configuration requests.
`src/ServiceControl.UnitTests/PlatformHealth/PlatformHealthStateTests.cs`	Tests health-state behavior.
`src/ServiceControl.UnitTests/PlatformHealth/PlatformHealthApiTests.cs`	Tests response assembly and failures.
`src/ServiceControl.UnitTests/Licensing/ActiveLicenseTests.cs`	Tests extracted license mapping.
`src/ServiceControl.UnitTests/ApprovalFiles/APIApprovals.RootPathValue.approved.txt`	Approves discovery URL addition.
`src/ServiceControl.UnitTests/ApprovalFiles/APIApprovals.HttpApiRoutes.approved.txt`	Approves the new route.
`src/ServiceControl.UnitTests/API/APIApprovals.cs`	Tests primary configuration metadata.
`src/ServiceControl.MultiInstance.AcceptanceTests/Infrastructure/When_inspecting_platform_health.cs`	Exercises multi-instance health behavior.
`src/ServiceControl.Audit/Infrastructure/WebApi/RootController.cs`	Publishes audit identity metadata.
`src/ServiceControl.Audit.UnitTests/API/APIApprovals.cs`	Tests audit configuration metadata.
`src/ServiceControl.Api/IPlatformHealthApi.cs`	Defines the health API abstraction.
`src/ServiceControl.Api/Contracts/RootUrls.cs`	Advertises platform health discovery.
`src/ServiceControl.Api/Contracts/PlatformHealthView.cs`	Defines response contracts.
`src/ServiceControl.AcceptanceTests/WebApi/When_the_configuration_page_is_read.cs`	Verifies configuration metadata.
`src/ServiceControl.AcceptanceTests/Security/OpenIdConnect/When_authentication_is_enabled.cs`	Verifies endpoint authorization.
`src/ServiceControl.AcceptanceTests/Monitoring/CustomChecks/When_custom_checks_are_classified.cs`	Verifies health/custom-check separation.
`docs/README.md`	Indexes the design documentation.
`docs/platform-health.md`	Documents the API contract and rationale.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Co-authored-by: hazel-bohon <2416062+hazel-bohon@users.noreply.github.com>

mchamberlin77 · 2026-10-06T17:34:19Z

+| `transport_type`, `error_queue`, `error_log_queue`, `forward_error_messages` | Available transport configuration; a known `false` forwarding setting is preserved |
+| `audit_queue`, `audit_log_queue`, `forward_audit_messages` | Available audit transport configuration |


Are these multiple fields listed in the same row? They read like the possible values for a field and not the field name themselves.

mchamberlin77 · 2026-10-07T00:04:19Z

                client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
                // Application settings might contain remote URLs with /api. We strip that away to be a real base address.
-                client.BaseAddress = new Uri(remoteInstance.BaseAddress);
+                client.BaseAddress = new Uri(remoteInstance.BaseAddress.TrimEnd('/') + "/");


This change does not make sense.

It ensures that there's a "/" but not a double slash at the end of the base url.

afprtclr · 2026-10-07T09:30:28Z

                {
-                    using var response = await httpClient.GetAsync("/api/configuration", cancellationToken);
+                    using var response = await httpClient.GetAsync("api/configuration", cancellationToken);
+                    response.EnsureSuccessStatusCode();


I think this changes the behavior. Previously, a non-200 response was considered "online" but now it's "unavailable". That might affect consumers. I think both AuditThroughput/AuditQuery.cs and AuditThroughputCollectorHostedService.cs are good, but maybe I missed something else.

afprtclr · 2026-10-07T09:30:28Z

+        return new PlatformHealthInstance
+        {
+            Id = remote.InstanceId,
+            Name = new Uri(remote.BaseAddress).Host,


This can fail if the address is invalid. Probably worth wrapping with try+catch or other validation.

afprtclr · 2026-10-07T09:30:28Z

+    static DateTimeOffset? ParseDate(string value) =>
+        DateTimeOffset.TryParse(value, CultureInfo.InvariantCulture, DateTimeStyles.AssumeUniversal, out var date) ? date : null;
+
+    readonly ConcurrentDictionary<string, PlatformHealthInstance> lastKnownRemotes = new(StringComparer.Ordinal);


I think this dictionary is never cleared? I'm not sure if we ever get "way too many" of those, but wanted to mention that.

Co-authored-by: Michelle Chamberlin <michelle.chamberlin@particular.net>

… tests for instance ID handling

Co-authored-by: hazel-bohon <2416062+hazel-bohon@users.noreply.github.com>

mchamberlin77 · 2026-10-07T15:19:57Z

            var patch = new PatchByQueryOperation(query, new QueryOperationOptions
            {
-                AllowStale = true,
+                AllowStale = false,


Why does this need to be changed?

mchamberlin77 · 2026-10-07T15:30:04Z

Changes to the license api should be in a sperate PR.

hazel-bohon added 2 commits September 30, 2026 15:04

first pass

91735c5

Separate internal checks from the custom checks

8ecd9bb

internalautomation Bot assigned hazel-bohon Oct 5, 2026

This comment was marked as duplicate.

Sign in to view

hazel-bohon requested review from afprtclr and mchamberlin77 and a balanced review from Copilot October 5, 2026 16:15

Copilot started reviewing on behalf of hazel-bohon October 5, 2026 16:16 View session

Copilot AI reviewed Oct 5, 2026

View reviewed changes

Comment thread src/ServiceControl/PlatformHealth/PlatformHealthApi.cs Outdated

Copilot started work on behalf of hazel-bohon October 6, 2026 11:51 View session

Pin Azure CLI on Windows CI

e1ceaa9

Co-authored-by: hazel-bohon <2416062+hazel-bohon@users.noreply.github.com>

Copilot finished work on behalf of hazel-bohon October 6, 2026 12:00

mchamberlin77 reviewed Oct 6, 2026

View reviewed changes

Comment thread docs/platform-health.md Outdated

mchamberlin77 reviewed Oct 6, 2026

View reviewed changes

Comment thread docs/platform-health.md Outdated

mchamberlin77 reviewed Oct 6, 2026

View reviewed changes

Comment thread docs/README.md Outdated

mchamberlin77 reviewed Oct 6, 2026

View reviewed changes

Comment thread src/ServiceControl.Api/Contracts/PlatformHealthView.cs Outdated

mchamberlin77 reviewed Oct 7, 2026

View reviewed changes

afprtclr reviewed Oct 7, 2026

View reviewed changes

hazel-bohon and others added 4 commits October 7, 2026 06:23

Remvoe license checking information from the API.

7e21069

Update docs/README.md

2fc4229

Co-authored-by: Michelle Chamberlin <michelle.chamberlin@particular.net>

Refactor PlatformHealthView to enforce required properties and update…

c80678f

… tests for instance ID handling

Move .record call into try block.

dacd308

Copilot started work on behalf of hazel-bohon October 7, 2026 12:04 View session

Wait for current index during range unarchive

5ca6de3

Co-authored-by: hazel-bohon <2416062+hazel-bohon@users.noreply.github.com>

Copilot finished work on behalf of hazel-bohon October 7, 2026 12:16

mchamberlin77 reviewed Oct 7, 2026

View reviewed changes

Comment thread src/ServiceControl/Licensing/LicenseInfoProvider.cs

mchamberlin77 Oct 7, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes to the license api should be in a sperate PR.

Navigation Menu

Repository navigation

Health check api - #5952

Health check api#5952
hazel-bohon wants to merge 8 commits into
masterfrom
health-check-api

hazel-bohon commented Oct 5, 2026 •

edited

Loading

Uh oh!

This comment was marked as duplicate.

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

mchamberlin77 Oct 6, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mchamberlin77 Oct 7, 2026

Uh oh!

hazel-bohon Oct 7, 2026

Uh oh!

Uh oh!

afprtclr Oct 7, 2026

Uh oh!

afprtclr Oct 7, 2026

Uh oh!

afprtclr Oct 7, 2026

Uh oh!

mchamberlin77 Oct 7, 2026

Uh oh!

mchamberlin77 Oct 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

		\| `transport_type`, `error_queue`, `error_log_queue`, `forward_error_messages` \| Available transport configuration; a known `false` forwarding setting is preserved \|
		\| `audit_queue`, `audit_log_queue`, `forward_audit_messages` \| Available audit transport configuration \|

Conversation

hazel-bohon commented Oct 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as duplicate.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

hazel-bohon commented Oct 5, 2026 •

edited

Loading