Joseph Doherty
9cff87fe85
Remove project bookkeeping citations from shipped code comments across the solution: hyphenated task IDs (WP-14, StoreAndForward-025), milestone/task/ issue refs (M3, Task 4, Audit Log #23, #21), Bundle X task-bundle labels, and C/D/K/S/T phase labels. Comment text only — no code logic, string/log literals, or XML-doc structure changed. Genuine descriptions are preserved (only the citation is stripped), and technical lookalikes are retained (UTF-8, SHA-256, T00:00:00, M365, UTC-5, pre-C4/pre-C5 schema versions). Flagged by the new CommentChecker TaskReferenceInComment / TrackingReferenceInComment checks plus targeted grep passes; full solution builds clean, append-only guard tests pass.
50 lines
2.3 KiB
C#
50 lines
2.3 KiB
C#
using ZB.MOM.WW.ScadaBridge.AuditLog.Payload;
|
|
using ZB.MOM.WW.ScadaBridge.HealthMonitoring;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.AuditLog.Site;
|
|
|
|
/// <summary>
|
|
/// Bridges
|
|
/// <see cref="IAuditRedactionFailureCounter"/> (incremented by
|
|
/// <see cref="ZB.MOM.WW.ScadaBridge.AuditLog.Redaction.ScadaBridgeAuditRedactor"/> every time
|
|
/// a header / body / SQL parameter redactor stage throws and the redactor has
|
|
/// to over-redact the offending field) into <see cref="ISiteHealthCollector"/>
|
|
/// so the count surfaces in the site health report payload as
|
|
/// <c>SiteHealthReport.AuditRedactionFailure</c>.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// <para>
|
|
/// Registered by <see cref="ServiceCollectionExtensions.AddAuditLogHealthMetricsBridge"/>;
|
|
/// callers must register <c>AddHealthMonitoring()</c> first so
|
|
/// <see cref="ISiteHealthCollector"/> resolves. The default <see cref="ServiceCollectionExtensions.AddAuditLog"/>
|
|
/// registration keeps <see cref="NoOpAuditRedactionFailureCounter"/> for nodes
|
|
/// where Site Health Monitoring is not wired (the silent-sink contract —
|
|
/// redaction failures must NEVER abort the user-facing action, alog.md §7).
|
|
/// </para>
|
|
/// <para>
|
|
/// Mirrors the <see cref="HealthMetricsAuditWriteFailureCounter"/>
|
|
/// shape one-for-one so the two health-metric bridges age together.
|
|
/// </para>
|
|
/// <para>
|
|
/// Site-side only: the redaction filter also runs on the central
|
|
/// writers (CentralAuditWriter + AuditLogIngestActor); the central
|
|
/// health-metric surface exposing <c>AuditRedactionFailure</c> is bridged
|
|
/// separately by <c>CentralAuditRedactionFailureCounter</c>, which the
|
|
/// central composition root registers in place of the NoOp default.
|
|
/// </para>
|
|
/// </remarks>
|
|
public sealed class HealthMetricsAuditRedactionFailureCounter : IAuditRedactionFailureCounter
|
|
{
|
|
private readonly ISiteHealthCollector _collector;
|
|
|
|
/// <summary>Initializes the counter with the site health collector it bridges into.</summary>
|
|
/// <param name="collector">The site health collector that receives the incremented redaction-failure count.</param>
|
|
public HealthMetricsAuditRedactionFailureCounter(ISiteHealthCollector collector)
|
|
{
|
|
_collector = collector ?? throw new ArgumentNullException(nameof(collector));
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
public void Increment() => _collector.IncrementAuditRedactionFailure();
|
|
}
|