From 31befa1238bf508e9bc1cc9e2803590fd16d32f7 Mon Sep 17 00:00:00 2001 From: Joseph Doherty Date: Wed, 20 May 2026 08:41:22 -0400 Subject: [PATCH] docs(audit): register Audit Log (#23) in the README component table --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 4accec8..b4772c0 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,7 @@ This document serves as the master index for the SCADA system design. The system | 20 | Traefik Proxy | [docs/requirements/Component-TraefikProxy.md](docs/requirements/Component-TraefikProxy.md) | Reverse proxy/load balancer fronting central cluster, active node routing via `/health/active`, automatic failover. | | 21 | Notification Outbox | [docs/requirements/Component-NotificationOutbox.md](docs/requirements/Component-NotificationOutbox.md) | Central component ingesting store-and-forwarded notifications into the `Notifications` audit table, with `NotificationOutboxActor` singleton dispatcher, per-type delivery adapters, retry/parking, status tracking, daily purge, and delivery KPIs. | | 22 | Site Call Audit | [docs/requirements/Component-SiteCallAudit.md](docs/requirements/Component-SiteCallAudit.md) | Central component auditing site cached calls (`ExternalSystem.CachedCall`/`Database.CachedWrite`) into the `SiteCalls` audit table, with `SiteCallAuditActor` singleton, telemetry ingest, periodic reconciliation, point-in-time KPIs, daily purge, and central→site Retry/Discard relay for parked calls. | +| 23 | Audit Log | [docs/requirements/Component-AuditLog.md](docs/requirements/Component-AuditLog.md) | New central append-only AuditLog spanning every script-trust-boundary action (outbound API sync+cached, outbound DB sync+cached, notifications, inbound API). Site-local SQLite hot-path append + gRPC telemetry + central reconciliation; combined telemetry packet with Site Call Audit; central direct-write for Notification Outbox dispatch + Inbound API middleware; monthly partitioning, 365-day default retention. | ### Reference Documentation @@ -90,6 +91,17 @@ This document serves as the master index for the SCADA system design. The system │ │ Mgmt │ ◄── CLI (ClusterClient) │ │ │ Service │ ManagementActor + Receptionist │ │ └──────────┘ │ +│ ┌──────────┐ ┌──────────┐ ┌──────────┐ │ +│ │ Ntf │ │ Site │ │ Audit │ Observ. / │ +│ │ Outbox │ │ Call │ │ Log │ Audit area │ +│ │ (#21) │ │ Audit │ │ (#23) │ │ +│ │ │ │ (#22) │ │ │ │ +│ └────▲─────┘ └────▲─────┘ └────▲─────┘ │ +│ │ ingests │ ingests │ ingests │ +│ │ (S&F) │ (telemetry)│ (telemetry + │ +│ │ │ │ direct-write │ +│ │ │ │ from Ntf Outbox │ +│ │ │ │ & Inbound API) │ │ ┌───────────────────────────────────┐ │ │ │ Akka.NET Communication Layer │ │ │ │ ClusterClient: command/control │ │