feat(telemetry.serilog): AddZbSerilog bootstrap + identity enrichers

2026-06-01 07:38:07 -04:00
parent 3e4d4369bf
commit 1344f249d0
4 changed files with 211 additions and 0 deletions
@@ -0,0 +1,69 @@
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Hosting;
+using Serilog;
+using Serilog.Events;
+using ZB.MOM.WW.Telemetry;
+
+namespace ZB.MOM.WW.Telemetry.Serilog;
+
+/// <summary>
+/// Extension point for configuring the shared Serilog bootstrap on an
+/// <see cref="IHostApplicationBuilder"/>. Wires config-driven sinks
+/// (<c>ReadFrom.Configuration</c>), an explicit minimum level (<c>Serilog:MinimumLevel</c>,
+/// default <see cref="LogEventLevel.Information"/>), and the shared enricher/redaction/OTel-export
+/// set via <see cref="ZbSerilogConfig"/>. Does NOT configure OTel metrics/traces — call
+/// <c>AddZbTelemetry</c> in the core package for that.
+/// </summary>
+public static class ZbSerilogExtensions
+{
+    /// <summary>
+    /// Registers Serilog on the host with the shared ZB.MOM.WW configuration: sinks read from
+    /// <see cref="IConfiguration"/> (<c>ReadFrom.Configuration</c>), an explicit minimum level
+    /// (<c>Serilog:MinimumLevel</c>, default <see cref="LogEventLevel.Information"/>), and the
+    /// identity enrichers (<c>SiteId</c>/<c>NodeRole</c> from <paramref name="configure"/>,
+    /// <c>NodeHostname</c> = <see cref="System.Environment.MachineName"/>). The
+    /// <paramref name="configure"/> delegate receives the same <see cref="ZbTelemetryOptions"/>
+    /// used by <c>AddZbTelemetry</c> — typically share one options-population lambda across both.
+    /// </summary>
+    /// <param name="builder">The host application builder.</param>
+    /// <param name="configure">Populates the <see cref="ZbTelemetryOptions"/>.</param>
+    public static IHostApplicationBuilder AddZbSerilog(
+        this IHostApplicationBuilder builder,
+        Action<ZbTelemetryOptions> configure)
+    {
+        ArgumentNullException.ThrowIfNull(builder);
+        ArgumentNullException.ThrowIfNull(configure);
+
+        var options = new ZbTelemetryOptions();
+        configure(options);
+
+        var minimumLevel = ReadMinimumLevel(builder.Configuration);
+
+        builder.Services.AddSerilog((serviceProvider, loggerConfiguration) =>
+        {
+            loggerConfiguration
+                .ReadFrom.Configuration(builder.Configuration)
+                .MinimumLevel.Is(minimumLevel);
+
+            ZbSerilogConfig.Apply(loggerConfiguration, options, serviceProvider);
+        });
+
+        return builder;
+    }
+
+    /// <summary>
+    /// Reads <c>Serilog:MinimumLevel</c> (or the nested <c>Serilog:MinimumLevel:Default</c>) from
+    /// configuration, falling back to <see cref="LogEventLevel.Information"/> for missing or
+    /// unparseable values.
+    /// </summary>
+    private static LogEventLevel ReadMinimumLevel(IConfiguration configuration)
+    {
+        var raw = configuration["Serilog:MinimumLevel"]
+            ?? configuration["Serilog:MinimumLevel:Default"];
+
+        return Enum.TryParse<LogEventLevel>(raw, ignoreCase: true, out var parsed)
+            ? parsed
+            : LogEventLevel.Information;
+    }
+}