9dd5e4e745
Closes Stream C per docs/v2/implementation/phase-6-1-resilience-and-observability.md. Core.Observability (new namespace): - DriverHealthReport — pure-function aggregation over DriverHealthSnapshot list. Empty fleet = Healthy. Any Faulted = Faulted. Any Unknown/Initializing (no Faulted) = NotReady. Any Degraded or Reconnecting (no Faulted, no NotReady) = Degraded. Else Healthy. HttpStatus(verdict) maps to the Stream C.1 state matrix: Healthy/Degraded → 200, NotReady/Faulted → 503. - LogContextEnricher — Serilog LogContext wrapper. Push(id, type, capability, correlationId) returns an IDisposable scope; inner log calls carry DriverInstanceId / DriverType / CapabilityName / CorrelationId structured properties automatically. NewCorrelationId = 12-hex-char GUID slice for cases where no OPC UA RequestHeader.RequestHandle is in flight. CapabilityInvoker — now threads LogContextEnricher around every ExecuteAsync / ExecuteWriteAsync call site. OtOpcUaServer passes driver.DriverType through so logs correlate to the driver type too. Every capability call emits structured fields per the Stream C.4 compliance check. Server.Observability: - HealthEndpointsHost — standalone HttpListener on http://localhost:4841/ (loopback avoids Windows URL-ACL elevation; remote probing via reverse proxy or explicit netsh urlacl grant). Routes: /healthz → 200 when (configDbReachable OR usingStaleConfig); 503 otherwise. Body: status, uptimeSeconds, configDbReachable, usingStaleConfig. /readyz → DriverHealthReport.Aggregate + HttpStatus mapping. Body: verdict, drivers[], degradedDrivers[], uptimeSeconds. anything else → 404. Disposal cooperative with the HttpListener shutdown. - OpcUaApplicationHost starts the health host after the OPC UA server comes up and disposes it on shutdown. New OpcUaServerOptions knobs: HealthEndpointsEnabled (default true), HealthEndpointsPrefix (default http://localhost:4841/). Program.cs: - Serilog pipeline adds Enrich.FromLogContext + opt-in JSON file sink via `Serilog:WriteJson = true` appsetting. Uses Serilog.Formatting.Compact's CompactJsonFormatter (one JSON object per line — SIEMs like Splunk, Datadog, Graylog ingest without a regex parser). Server.Tests: - Existing 3 OpcUaApplicationHost integration tests now set HealthEndpointsEnabled=false to avoid port :4841 collisions under parallel execution. - New HealthEndpointsHostTests (9): /healthz healthy empty fleet; stale-config returns 200 with flag; unreachable+no-cache returns 503; /readyz empty/ Healthy/Faulted/Degraded/Initializing drivers return correct status and bodies; unknown path → 404. Uses ephemeral ports via Interlocked counter. Core.Tests: - DriverHealthReportTests (8): empty fleet, all-healthy, any-Faulted trumps, any-NotReady without Faulted, Degraded without Faulted/NotReady, HttpStatus per-verdict theory. - LogContextEnricherTests (8): all 4 properties attach; scope disposes cleanly; NewCorrelationId shape; null/whitespace driverInstanceId throws. - CapabilityInvokerEnrichmentTests (2): inner logs carry structured properties; no context leak outside the call site. Full solution dotnet test: 1016 passing (baseline 906, +110 for Phase 6.1 so far across Streams A+B+C). Pre-existing Client.CLI Subscribe flake unchanged. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
54 lines
2.4 KiB
C#
54 lines
2.4 KiB
C#
using Serilog.Context;
|
|
using ZB.MOM.WW.OtOpcUa.Core.Abstractions;
|
|
|
|
namespace ZB.MOM.WW.OtOpcUa.Core.Observability;
|
|
|
|
/// <summary>
|
|
/// Convenience wrapper around Serilog <see cref="LogContext"/> — attaches the set of
|
|
/// structured properties a capability call should carry (DriverInstanceId, DriverType,
|
|
/// CapabilityName, CorrelationId). Callers wrap their call-site body in a <c>using</c>
|
|
/// block; inner <c>Log.Information</c> / <c>Log.Warning</c> calls emit the context
|
|
/// automatically via the Serilog enricher chain.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Per <c>docs/v2/implementation/phase-6-1-resilience-and-observability.md</c> §Stream C.2.
|
|
/// The correlation ID should be the OPC UA <c>RequestHeader.RequestHandle</c> when in-flight;
|
|
/// otherwise a short random GUID. Callers supply whichever is available.
|
|
/// </remarks>
|
|
public static class LogContextEnricher
|
|
{
|
|
/// <summary>Attach the capability-call property set. Dispose the returned scope to pop.</summary>
|
|
public static IDisposable Push(string driverInstanceId, string driverType, DriverCapability capability, string correlationId)
|
|
{
|
|
ArgumentException.ThrowIfNullOrWhiteSpace(driverInstanceId);
|
|
ArgumentException.ThrowIfNullOrWhiteSpace(driverType);
|
|
ArgumentException.ThrowIfNullOrWhiteSpace(correlationId);
|
|
|
|
var a = LogContext.PushProperty("DriverInstanceId", driverInstanceId);
|
|
var b = LogContext.PushProperty("DriverType", driverType);
|
|
var c = LogContext.PushProperty("CapabilityName", capability.ToString());
|
|
var d = LogContext.PushProperty("CorrelationId", correlationId);
|
|
return new CompositeScope(a, b, c, d);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Generate a short correlation ID when no OPC UA RequestHandle is available.
|
|
/// 12-hex-char slice of a GUID — long enough for log correlation, short enough to
|
|
/// scan visually.
|
|
/// </summary>
|
|
public static string NewCorrelationId() => Guid.NewGuid().ToString("N")[..12];
|
|
|
|
private sealed class CompositeScope : IDisposable
|
|
{
|
|
private readonly IDisposable[] _inner;
|
|
public CompositeScope(params IDisposable[] inner) => _inner = inner;
|
|
|
|
public void Dispose()
|
|
{
|
|
// Reverse-order disposal matches Serilog's stack semantics.
|
|
for (var i = _inner.Length - 1; i >= 0; i--)
|
|
_inner[i].Dispose();
|
|
}
|
|
}
|
|
}
|