Skip to content

Fix health monitoring service reporting #824

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
StuartFerguson merged 1 commit into from
Oct 1, 2026
Merged

Fix health monitoring service reporting #824

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 51 additions & 2 deletions ScheduledTasks/DailySupportCheck/Invoke-DailySupportCheck.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,22 @@ function Test-HealthMonitoring {
$provider = $Context.HealthMonitoringProvider
}

$services = @(& $provider $uri $timeoutSeconds)
$services = @((& $provider $uri $timeoutSeconds))
$serviceIdValue = if ($services.Count -eq 1 -and $services[0].PSObject.Properties['ServiceId']) { $services[0].ServiceId }
$isServiceCollection = $serviceIdValue -is [System.Collections.IEnumerable] -and $serviceIdValue -isnot [string]
if ($services.Count -eq 1 -and $isServiceCollection) {
$wrappedServices = $services[0]
$serviceCount = @($serviceIdValue).Count
$services = for ($index = 0; $index -lt $serviceCount; $index++) {
$service = [ordered]@{}
foreach ($property in $wrappedServices.PSObject.Properties) {
$value = $property.Value
$isCollection = $value -is [System.Collections.IEnumerable] -and $value -isnot [string]
$service[$property.Name] = if ($isCollection -and @($value).Count -eq $serviceCount) { @($value)[$index] } else { $value }
}
[pscustomobject] $service
}
}
if ($services.Count -eq 0) {
return Get-CheckResult -Name 'HealthMonitoring' -Status Warning -Summary 'HealthMonitoring returned no monitored services.' -Details @()
}
Expand All @@ -403,6 +418,13 @@ function Test-HealthMonitoring {
if ([string]::IsNullOrWhiteSpace($status)) {
$status = 'Unknown'
}
$status = switch ($status) {
'0' { 'Unknown' }
'1' { 'Healthy' }
'2' { 'Degraded' }
'3' { 'Unhealthy' }
default { $status }
}
$status = (Get-Culture).TextInfo.ToTitleCase($status.ToLowerInvariant())
[pscustomobject]@{
ServiceId = [string] $service.ServiceId
Expand Down Expand Up @@ -980,17 +1002,44 @@ function Write-SupportReports {
[void] $subscriptionDetails.AppendLine('</tbody></table></div>')
}

$healthMonitoringDetails = [System.Text.StringBuilder]::new()
$healthMonitoringCheck = @($Report.Checks | Where-Object Name -eq 'HealthMonitoring') | Select-Object -First 1
$healthMonitoringItems = if ($null -ne $healthMonitoringCheck) {
@($healthMonitoringCheck.Details | Where-Object { $_.PSObject.Properties['ServiceId'] })
}
$healthMonitoringItems = @($healthMonitoringItems)
if ($healthMonitoringItems.Count -gt 0) {
[void] $healthMonitoringDetails.AppendLine('<h2>HealthMonitoring details</h2>')
[void] $healthMonitoringDetails.AppendLine('<div class="table-scroll"><table class="health-monitoring-table"><thead><tr><th>Service ID</th><th>Name</th><th>Status</th><th>Last observed</th><th>Last error</th></tr></thead><tbody>')
foreach ($service in $healthMonitoringItems) {
$detailStatus = ConvertTo-HtmlEncodedText $service.Status
$detailStatusClass = [System.Net.WebUtility]::HtmlEncode("status-$([string] $service.Status)")
$detailStatusIcon = switch ([string] $service.Status) {
'Passed' { '🟢' }
'Healthy' { '🟢' }
'Warning' { '🟠' }
'Degraded' { '🟠' }
'Failed' { '🔴' }
'Unhealthy' { '🔴' }
default { '⚪' }
}
[void] $healthMonitoringDetails.AppendLine("<tr class=`"$detailStatusClass`"><td>$(ConvertTo-HtmlEncodedText $service.ServiceId)</td><td>$(ConvertTo-HtmlEncodedText $service.Name)</td><td><span class=`"status-icon`" role=`"img`" aria-label=`"$detailStatus`">$detailStatusIcon</span> $detailStatus</td><td>$(ConvertTo-HtmlEncodedText $service.LastObservedAtUtc)</td><td>$(ConvertTo-HtmlEncodedText $service.LastError)</td></tr>")
}
[void] $healthMonitoringDetails.AppendLine('</tbody></table></div>')
}

$overallStatus = [System.Net.WebUtility]::HtmlEncode([string] $Report.OverallStatus)
$html = @"
<!doctype html>
<html lang="en">
<head><meta charset="utf-8"><title>Daily Support Check</title>
<style>body{font-family:Segoe UI,Arial,sans-serif;color:#222}table{border-collapse:collapse;width:100%}th,td{border:1px solid #ccc;padding:8px;text-align:left;vertical-align:top}th{background:#eee}h2{font-size:1.1em;margin:22px 0 8px}.table-scroll{overflow-x:auto}.subscription-table{font-size:.9em;min-width:760px}.status-Failed{background:#fde2e2}.status-Warning{background:#fff4cc}.status-Passed{background:#e4f4e4}.status-icon{font-size:1.15em;white-space:nowrap}</style>
<style>body{font-family:Segoe UI,Arial,sans-serif;color:#222}table{border-collapse:collapse;width:100%}th,td{border:1px solid #ccc;padding:8px;text-align:left;vertical-align:top}th{background:#eee}h2{font-size:1.1em;margin:22px 0 8px}.table-scroll{overflow-x:auto}.subscription-table,.health-monitoring-table{font-size:.9em;min-width:760px}.status-Failed,.status-Unhealthy{background:#fde2e2}.status-Warning,.status-Degraded{background:#fff4cc}.status-Passed,.status-Healthy{background:#e4f4e4}.status-icon{font-size:1.15em;white-space:nowrap}</style>
</head>
<body><h1>Daily Support Check</h1><p><strong>Overall status:</strong> $overallStatus</p>
<p><strong>Started:</strong> $([System.Net.WebUtility]::HtmlEncode([string] $Report.StartedAt))<br><strong>Completed:</strong> $([System.Net.WebUtility]::HtmlEncode([string] $Report.CompletedAt))</p>
<table><thead><tr><th>Check</th><th>Status</th><th>Summary</th></tr></thead><tbody>$rows</tbody></table>
$subscriptionDetails
$healthMonitoringDetails
</body></html>
"@
$html | Set-Content -LiteralPath $htmlPath -Encoding UTF8
Expand Down
95 changes: 95 additions & 0 deletions ScheduledTasks/DailySupportCheck/Tests/Invoke-DailySupportCheck.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,42 @@ Describe 'Daily support check' {
$html | Should -Match 'Main &amp; Ordered'
}

It 'renders health-monitoring service details beneath the check summary in the HTML report' {
$outputPath = Join-Path $testOutputRoot 'health-monitoring-details'
$details = @(
[pscustomobject]@{
ServiceId = 'orders'
Name = 'Orders & Payments'
Status = 'Healthy'
LastObservedAtUtc = '2026-10-01T15:00:00Z'
LastError = $null
}
[pscustomobject]@{
ServiceId = 'payments'
Name = 'Payments'
Status = 'Unhealthy'
LastObservedAtUtc = '2026-10-01T14:59:00Z'
LastError = 'Health endpoint unavailable'
}
)
$check = Get-CheckResult -Name 'HealthMonitoring' -Status Failed -Summary '1 monitored service(s) are unhealthy or unknown.' -Details $details
$report = Get-SupportReport -StartedAt ([datetime]::UtcNow) -Results @($check)

$paths = Write-SupportReports -Report $report -OutputPath $outputPath
$html = Get-Content -Raw -Path $paths.HtmlPath

$html | Should -Match 'HealthMonitoring details'
$html | Should -Match '<th>Service ID</th><th>Name</th><th>Status</th>'
$html | Should -Match 'orders'
$html | Should -Match 'Orders &amp; Payments'
$html | Should -Match 'Health endpoint unavailable'
$html | Should -Match 'status-Healthy'
$html | Should -Match 'status-Unhealthy'
$html | Should -Match '🔴</span> Unhealthy'
$html | Should -Match '\.status-Passed,.status-Healthy\{background:#e4f4e4\}'
$html | Should -Match '\.status-Failed,.status-Unhealthy\{background:#fde2e2\}'
}

It 'removes matching reports older than the configured retention period' {
$outputPath = Join-Path $testOutputRoot 'retention'
New-Item -ItemType Directory -Path $outputPath -Force | Out-Null
Expand Down Expand Up @@ -456,6 +492,65 @@ Describe 'Daily support check' {
$result.Summary | Should -Match '2 monitored service'
}

It 'expands wrapped enumerable health-monitoring services returned by the API' {
$context = [pscustomobject]@{
Configuration = [pscustomobject]@{
HealthMonitoring = [pscustomobject]@{
Enabled = $true
BaseUrl = 'http://health-monitoring'
ServicesPath = '/api/services'
TimeoutSeconds = 10
}
}
HealthMonitoringProvider = {
[pscustomobject]@{
ServiceId = [System.Collections.ArrayList]::new(@('orders', 'payments'))
Name = [System.Collections.ArrayList]::new(@('Orders', 'Payments'))
Status = [System.Collections.ArrayList]::new(@(1, 1))
LastObservedAtUtc = $null
LastError = $null
}
}
}

$result = Test-HealthMonitoring -Context $context

$result.Status | Should -Be 'Passed'
$result.Details.Count | Should -Be 2
$result.Details[0].ServiceId | Should -Be 'orders'
$result.Details[0].Name | Should -Be 'Orders'
$result.Details[0].Status | Should -Be 'Healthy'
$result.Details[1].ServiceId | Should -Be 'payments'
$result.Details[1].Name | Should -Be 'Payments'
$result.Details[1].Status | Should -Be 'Healthy'
}

It 'unwraps an array returned as one health-monitoring provider result' {
$context = [pscustomobject]@{
Configuration = [pscustomobject]@{
HealthMonitoring = [pscustomobject]@{
Enabled = $true
BaseUrl = 'http://health-monitoring'
ServicesPath = '/api/services'
TimeoutSeconds = 10
}
}
HealthMonitoringProvider = {
$apiResponse = @(
[pscustomobject]@{ ServiceId = 'orders'; Name = 'Orders'; Status = 1 }
[pscustomobject]@{ ServiceId = 'payments'; Name = 'Payments'; Status = 1 }
)
,$apiResponse
}
}

$result = Test-HealthMonitoring -Context $context

$result.Status | Should -Be 'Passed'
$result.Details.Count | Should -Be 2
$result.Details.ServiceId | Should -Be @('orders', 'payments')
}

It 'returns Warning for degraded services and Failed for unhealthy services' {
$configuration = [pscustomobject]@{
HealthMonitoring = [pscustomobject]@{
Expand Down
Loading