feat(historian): config-gated SqliteStoreAndForward→Wonderware sink (AddAlarmHistorian)

2026-06-11 11:30:31 -04:00
parent e9355e9514
commit 943c621371
5 changed files with 186 additions and 0 deletions
@@ -1,6 +1,7 @@
 using Akka.Actor;
 using Akka.Hosting;
 using Microsoft.EntityFrameworkCore;
+using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.DependencyInjection.Extensions;
 using Microsoft.Extensions.Logging;
@@ -48,6 +49,45 @@ public static class ServiceCollectionExtensions
        return services;
    }

+    /// <summary>
+    ///     Config-gated durable alarm-historian sink. When the <c>AlarmHistorian</c> section has
+    ///     <c>Enabled=true</c>, registers a <see cref="SqliteStoreAndForwardSink"/> (draining via the
+    ///     <paramref name="writerFactory"/>-supplied writer) as the <see cref="IAlarmHistorianSink"/>,
+    ///     overriding the <see cref="NullAlarmHistorianSink"/> default. Otherwise a no-op (Null stays).
+    ///     The writer is injected so the durable downstream (Wonderware named-pipe client) can be supplied
+    ///     by the Host, which is the only project that references it.
+    /// </summary>
+    /// <param name="services">The service collection to register with.</param>
+    /// <param name="configuration">The configuration carrying the <c>AlarmHistorian</c> section.</param>
+    /// <param name="writerFactory">
+    ///     Factory the Host supplies to build the concrete <see cref="IAlarmHistorianWriter"/>
+    ///     (the Wonderware named-pipe client) from the bound options + the resolving provider.
+    /// </param>
+    /// <returns>The same <paramref name="services"/> instance for chaining.</returns>
+    public static IServiceCollection AddAlarmHistorian(
+        this IServiceCollection services,
+        IConfiguration configuration,
+        Func<AlarmHistorianOptions, IServiceProvider, IAlarmHistorianWriter> writerFactory)
+    {
+        var opts = configuration.GetSection(AlarmHistorianOptions.SectionName).Get<AlarmHistorianOptions>();
+        if (opts is not { Enabled: true }) return services; // leave the Null default from AddOtOpcUaRuntime
+
+        services.AddSingleton<IAlarmHistorianSink>(sp =>
+        {
+            // SqliteStoreAndForwardSink takes a Serilog ILogger (not Microsoft.Extensions.Logging).
+            // Resolve it off the host's configured static logger so the drain worker's WARN/INFO
+            // lines land in the same sinks as the rest of the process.
+            var sink = new SqliteStoreAndForwardSink(
+                opts.DatabasePath,
+                writerFactory(opts, sp),
+                Serilog.Log.Logger.ForContext<SqliteStoreAndForwardSink>(),
+                batchSize: opts.BatchSize);
+            sink.StartDrainLoop(TimeSpan.FromSeconds(5));
+            return sink;
+        });
+        return services;
+    }
+
    /// <summary>
    /// Spawns the per-node driver-role actors on the host's <see cref="ActorSystem"/>:
    /// <see cref="DriverHostActor"/> (one per node), <see cref="DbHealthProbeActor"/>