c810bd0f7c
#120: Akka ILoggingAdapter lines used to bypass Serilog and go to stdout only. - BuildHocon sets akka.loggers = [Host.Actors.SerilogAkkaLogger] and keeps akka.loglevel = INFO, so Akka Debug chatter is still filtered at the adapter. The INFO+ lines that used to reach stdout now go through the Serilog pipeline instead, with no extra volume. - Lines reach the file sinks with the node enrichers. SourceContext is the logging class's full name, AkkaSource is the actor path, Akka's own timestamp is kept, and format arguments become structured properties. - The Akka logger actor writes on its own thread, after the logging actor's LogContext is gone. To keep the ExecutionId, the two DCL actors log through ExecutionAwareLogging.GetLogger(Context), which records ExecutionLogContext.Current (a new AsyncLocal mirror of the pushed id) in an ExecutionTaggedLogMessage. The logger actor pushes that id again while it writes the line. #56 remainder (coordinator decision: no replicated schema change): - The host pipeline gains ExecutionLogCaptureSink. - While a run is traced, its step logger registers its ExecutionId: the site ScriptLogger from the launcher (plus each inline CallShared child id), and the central InboundScriptLogger from the executor. - Each tagged line becomes a ScriptLog row with LogSource "node" and the new ScriptTraceExtra.LogCategory. - The rows count against the existing MaxLogLinesPerRun cap, are clipped at 2 000 chars, ride the low-priority collector lane and pass the same redactor. Untraced runs cost one volatile read. - Lines are never copied twice. The step loggers' own forwards run inside ExecutionLogCapture.Suppress(), and the sink suppresses itself while it calls a target. The registration is declared inside the launcher's and executor's try, so it ends before the catch blocks log the outcome, and FlushDropped closes it. - FlowGraphBuilder lists node lines in FlowGraph.NodeLogs and never folds them onto a step. - The Flow Debugger shows them in a Node log card (FlowNodeLogPanel): grouped per execution under its run step, with an All | Warn + filter. Live and Replay both read the same rows, so site scope and role rules apply unchanged. - CLI --show-logs prints them as a trailing block. Tests: Commons ExecutionLogCaptureTests, ExecutionLogContext.Current, FlowGraphBuilder node lines. SiteRuntime NodeLogCaptureTests covers cross-actor capture via the launcher, untraced runs capturing nothing, no double capture of script and runtime lines or of the launcher failure line, the shared cap, collector redaction, shared-script child ids and FlushDropped closing capture. InboundNodeLogCaptureTests covers the central path. DCL ExecutionAwareLoggingTests covers the DataConnectionActor write-path Debug line being tagged and an uncorrelated line not being tagged. Host SerilogAkkaLoggerTests covers mapping, the ExecutionId crossing the logger hop, HOCON, ActorSystem boot and the Akka line reaching a traced run's step log end to end. Host LoggerConfigurationTests checks that the sink is wired. bUnit FlowNodeLogPanelTests and a CLI projection test cover the UI and CLI. Every new assertion was mutation-proven. Docs: step-logs design section 12, Component-SiteRuntime, CentralUI, InboundAPI, Host, CLI README, CLAUDE.md. Claude-Session: https://claude.ai/code/session_01GT67AEHd2Acv1YPwGfXEoV
104 lines
4.9 KiB
C#
104 lines
4.9 KiB
C#
using Bunit;
|
|
using ZB.MOM.WW.ScadaBridge.CentralUI.Components.Deployment;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Types.Debugging;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.Deployment;
|
|
|
|
/// <summary>
|
|
/// ScadaBridge#56: the Flow Debugger's node-log section lists the lines other actors wrote for each
|
|
/// traced execution — grouped per execution under that execution's run step, with level filtering and
|
|
/// the logger category — and renders nothing when the graph has no node lines.
|
|
/// </summary>
|
|
public class FlowNodeLogPanelTests : BunitContext
|
|
{
|
|
private static readonly DateTimeOffset T0 = new(2026, 11, 10, 12, 0, 0, TimeSpan.Zero);
|
|
|
|
private static FlowStep Run(Guid execution, string title)
|
|
=> new(Guid.NewGuid(), execution, null, FlowStepKind.ScriptRun, FlowLane.Site, title, null, T0, 10,
|
|
FlowStepOutcome.Ok, null, null, null, "site-a", "node-a", "M1", title, null);
|
|
|
|
private static FlowLogLine Node(Guid execution, string level, string message, int ms,
|
|
string category = "ZB.MOM.WW.ScadaBridge.DataConnectionLayer.Actors.DataConnectionActor",
|
|
string? exceptionMessage = null)
|
|
=> new(Guid.NewGuid(), execution, T0.AddMilliseconds(ms), level, FlowLogLine.NodeSource, message,
|
|
exceptionMessage, exceptionMessage is null ? null : "System.Exception: " + exceptionMessage, null, ms, category);
|
|
|
|
private static FlowGraph Graph(IReadOnlyList<FlowStep> steps, IReadOnlyList<FlowLogLine>? nodeLogs)
|
|
=> new(steps, [], Predicted: false, Truncated: false, NodeLogs: nodeLogs);
|
|
|
|
/// <summary>No node lines (or no graph): the section is not rendered at all.</summary>
|
|
[Fact]
|
|
public void NoNodeLines_RendersNothing()
|
|
{
|
|
var execution = Guid.NewGuid();
|
|
Assert.Empty(Render<FlowNodeLogPanel>(p => p.Add(x => x.Graph, Graph([Run(execution, "Runner")], null)))
|
|
.FindAll("[data-test=flow-nodelog-panel]"));
|
|
Assert.Empty(Render<FlowNodeLogPanel>().FindAll("[data-test=flow-nodelog-panel]"));
|
|
}
|
|
|
|
/// <summary>Lines are grouped per execution, titled by its run step, with short category, level and counts.</summary>
|
|
[Fact]
|
|
public void Lines_AreGroupedPerExecution_UnderTheRunStep()
|
|
{
|
|
var a = Guid.NewGuid();
|
|
var b = Guid.NewGuid();
|
|
var graph = Graph([Run(a, "OnRecipe"), Run(b, "SharedHelper")],
|
|
[
|
|
Node(a, "debug", "Writing to tag T1", 1),
|
|
Node(b, "warn", "tag T2 bad quality", 2, category: "ZB.MOM.WW.ScadaBridge.SiteRuntime.Actors.InstanceActor"),
|
|
Node(a, "error", "write failed", 3, exceptionMessage: "timeout"),
|
|
]);
|
|
|
|
var cut = Render<FlowNodeLogPanel>(p => p.Add(x => x.Graph, graph));
|
|
|
|
Assert.Equal("3 lines · 1 error · 1 warning · 1 info/debug", cut.Find("[data-test=flow-nodelog-count]").TextContent);
|
|
var groups = cut.FindAll("[data-test=flow-nodelog-execution]");
|
|
Assert.Equal(2, groups.Count);
|
|
Assert.Contains("OnRecipe", groups[0].TextContent);
|
|
Assert.Contains(a.ToString(), groups[0].TextContent);
|
|
var aRows = groups[0].QuerySelectorAll("tbody tr");
|
|
Assert.Equal(2, aRows.Length);
|
|
Assert.Contains("DataConnectionActor", aRows[0].TextContent);
|
|
Assert.DoesNotContain("ZB.MOM.WW", aRows[0].TextContent);
|
|
Assert.Contains("timeout", aRows[1].TextContent);
|
|
Assert.Contains("InstanceActor", groups[1].TextContent);
|
|
Assert.Contains("tag T2 bad quality", groups[1].TextContent);
|
|
}
|
|
|
|
/// <summary>Warn + hides debug/info lines; an execution left with none says so; All restores them.</summary>
|
|
[Fact]
|
|
public void WarnPlusFilter_HidesLowLevels()
|
|
{
|
|
var a = Guid.NewGuid();
|
|
var b = Guid.NewGuid();
|
|
var graph = Graph([Run(a, "OnRecipe"), Run(b, "Other")],
|
|
[Node(a, "info", "connected", 1), Node(a, "warn", "slow write", 2), Node(b, "debug", "chatter", 3)]);
|
|
var cut = Render<FlowNodeLogPanel>(p => p.Add(x => x.Graph, graph));
|
|
|
|
cut.Find("[data-test=flow-nodelog-filter-warn]").Click();
|
|
|
|
var groups = cut.FindAll("[data-test=flow-nodelog-execution]");
|
|
Assert.Equal("warn", Assert.Single(groups[0].QuerySelectorAll("tbody tr")).GetAttribute("data-level"));
|
|
Assert.NotNull(groups[1].QuerySelector("[data-test=flow-nodelog-none-shown]"));
|
|
|
|
cut.Find("[data-test=flow-nodelog-filter-all]").Click();
|
|
Assert.Equal(3, cut.FindAll("[data-test=flow-nodelog-lines] tbody tr").Count);
|
|
}
|
|
|
|
/// <summary>Clicking the execution's title selects its run step.</summary>
|
|
[Fact]
|
|
public void ExecutionTitle_SelectsItsRunStep()
|
|
{
|
|
var a = Guid.NewGuid();
|
|
var run = Run(a, "OnRecipe");
|
|
FlowStep? selected = null;
|
|
var cut = Render<FlowNodeLogPanel>(p => p
|
|
.Add(x => x.Graph, Graph([run], [Node(a, "warn", "slow", 1)]))
|
|
.Add(x => x.OnSelectStep, s => selected = s));
|
|
|
|
cut.Find("[data-test=flow-nodelog-step]").Click();
|
|
|
|
Assert.Same(run, selected);
|
|
}
|
|
}
|