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>
100 lines
4.8 KiB
C#
100 lines
4.8 KiB
C#
using Microsoft.EntityFrameworkCore;
|
|
using Microsoft.Extensions.Configuration;
|
|
using Microsoft.Extensions.DependencyInjection;
|
|
using Microsoft.Extensions.Hosting;
|
|
using Microsoft.Extensions.Logging;
|
|
using Serilog;
|
|
using Serilog.Formatting.Compact;
|
|
using ZB.MOM.WW.OtOpcUa.Configuration;
|
|
using ZB.MOM.WW.OtOpcUa.Configuration.LocalCache;
|
|
using ZB.MOM.WW.OtOpcUa.Core.Hosting;
|
|
using ZB.MOM.WW.OtOpcUa.Server;
|
|
using ZB.MOM.WW.OtOpcUa.Server.OpcUa;
|
|
using ZB.MOM.WW.OtOpcUa.Server.Security;
|
|
|
|
var builder = Host.CreateApplicationBuilder(args);
|
|
|
|
// Per Phase 6.1 Stream C.3: SIEMs (Splunk, Datadog) ingest the JSON file without a
|
|
// regex parser. Plain-text rolling file stays on by default for human readability;
|
|
// JSON file is opt-in via appsetting `Serilog:WriteJson = true`.
|
|
var writeJson = builder.Configuration.GetValue<bool>("Serilog:WriteJson");
|
|
var loggerBuilder = new LoggerConfiguration()
|
|
.ReadFrom.Configuration(builder.Configuration)
|
|
.Enrich.FromLogContext()
|
|
.WriteTo.Console()
|
|
.WriteTo.File("logs/otopcua-.log", rollingInterval: RollingInterval.Day);
|
|
|
|
if (writeJson)
|
|
{
|
|
loggerBuilder = loggerBuilder.WriteTo.File(
|
|
new CompactJsonFormatter(),
|
|
"logs/otopcua-.json.log",
|
|
rollingInterval: RollingInterval.Day);
|
|
}
|
|
|
|
Log.Logger = loggerBuilder.CreateLogger();
|
|
|
|
builder.Services.AddSerilog();
|
|
builder.Services.AddWindowsService(o => o.ServiceName = "OtOpcUa");
|
|
|
|
var nodeSection = builder.Configuration.GetSection(NodeOptions.SectionName);
|
|
var options = new NodeOptions
|
|
{
|
|
NodeId = nodeSection.GetValue<string>("NodeId")
|
|
?? throw new InvalidOperationException("Node:NodeId not configured"),
|
|
ClusterId = nodeSection.GetValue<string>("ClusterId")
|
|
?? throw new InvalidOperationException("Node:ClusterId not configured"),
|
|
ConfigDbConnectionString = nodeSection.GetValue<string>("ConfigDbConnectionString")
|
|
?? throw new InvalidOperationException("Node:ConfigDbConnectionString not configured"),
|
|
LocalCachePath = nodeSection.GetValue<string>("LocalCachePath") ?? "config_cache.db",
|
|
};
|
|
|
|
var opcUaSection = builder.Configuration.GetSection(OpcUaServerOptions.SectionName);
|
|
var ldapSection = opcUaSection.GetSection("Ldap");
|
|
var ldapOptions = new LdapOptions
|
|
{
|
|
Enabled = ldapSection.GetValue<bool?>("Enabled") ?? false,
|
|
Server = ldapSection.GetValue<string>("Server") ?? "localhost",
|
|
Port = ldapSection.GetValue<int?>("Port") ?? 3893,
|
|
UseTls = ldapSection.GetValue<bool?>("UseTls") ?? false,
|
|
AllowInsecureLdap = ldapSection.GetValue<bool?>("AllowInsecureLdap") ?? true,
|
|
SearchBase = ldapSection.GetValue<string>("SearchBase") ?? "dc=lmxopcua,dc=local",
|
|
ServiceAccountDn = ldapSection.GetValue<string>("ServiceAccountDn") ?? string.Empty,
|
|
ServiceAccountPassword = ldapSection.GetValue<string>("ServiceAccountPassword") ?? string.Empty,
|
|
GroupToRole = ldapSection.GetSection("GroupToRole").Get<Dictionary<string, string>>() ?? new(StringComparer.OrdinalIgnoreCase),
|
|
};
|
|
|
|
var opcUaOptions = new OpcUaServerOptions
|
|
{
|
|
EndpointUrl = opcUaSection.GetValue<string>("EndpointUrl") ?? "opc.tcp://0.0.0.0:4840/OtOpcUa",
|
|
ApplicationName = opcUaSection.GetValue<string>("ApplicationName") ?? "OtOpcUa Server",
|
|
ApplicationUri = opcUaSection.GetValue<string>("ApplicationUri") ?? "urn:OtOpcUa:Server",
|
|
PkiStoreRoot = opcUaSection.GetValue<string>("PkiStoreRoot")
|
|
?? Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.CommonApplicationData), "OtOpcUa", "pki"),
|
|
AutoAcceptUntrustedClientCertificates = opcUaSection.GetValue<bool?>("AutoAcceptUntrustedClientCertificates") ?? true,
|
|
SecurityProfile = Enum.TryParse<OpcUaSecurityProfile>(opcUaSection.GetValue<string>("SecurityProfile"), true, out var p)
|
|
? p : OpcUaSecurityProfile.None,
|
|
Ldap = ldapOptions,
|
|
};
|
|
|
|
builder.Services.AddSingleton(options);
|
|
builder.Services.AddSingleton(opcUaOptions);
|
|
builder.Services.AddSingleton(ldapOptions);
|
|
builder.Services.AddSingleton<IUserAuthenticator>(sp => ldapOptions.Enabled
|
|
? new LdapUserAuthenticator(ldapOptions, sp.GetRequiredService<ILogger<LdapUserAuthenticator>>())
|
|
: new DenyAllUserAuthenticator());
|
|
builder.Services.AddSingleton<ILocalConfigCache>(_ => new LiteDbConfigCache(options.LocalCachePath));
|
|
builder.Services.AddSingleton<DriverHost>();
|
|
builder.Services.AddSingleton<NodeBootstrap>();
|
|
builder.Services.AddSingleton<OpcUaApplicationHost>();
|
|
builder.Services.AddHostedService<OpcUaServerService>();
|
|
|
|
// Central-config DB access for the host-status publisher (LMX follow-up #7). Scoped context
|
|
// so per-heartbeat change-tracking stays isolated; publisher opens one scope per tick.
|
|
builder.Services.AddDbContext<OtOpcUaConfigDbContext>(opt =>
|
|
opt.UseSqlServer(options.ConfigDbConnectionString));
|
|
builder.Services.AddHostedService<HostStatusPublisher>();
|
|
|
|
var host = builder.Build();
|
|
await host.RunAsync();
|