dohertj2/scadalink-design
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs(audit): fix Ingestion Paths count and Purpose conjunction wording

Browse Source 
Code-review feedback on c334de0:
- Ingestion Paths intro said 'Three write paths' but the section has four
  subsections (site hot-path append + 3 central writers). Reword to 'Four
  paths feed the central AuditLog -- one site originator and three central
  writers'.
- Purpose: 'dashboards plus drilldowns plus filter queries' read awkwardly;
  switch to standard comma list.
This commit is contained in:
Joseph Doherty
2026-05-20 07:44:54 -04:00
parent c334de03f4
commit 08ccd72365
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/requirements/Component-AuditLog.md
View File

@@ -5,7 +5,7 @@
Provides a single, append-only, forensic + operational record of every Provides a single, append-only, forensic + operational record of every
integration action initiated by, or terminating in, a script — across outbound integration action initiated by, or terminating in, a script — across outbound
API, outbound DB, notifications, and inbound API. One row per lifecycle event, API, outbound DB, notifications, and inbound API. One row per lifecycle event,
rich payloads, long retention, dashboards plus drilldowns plus filter queries, rich payloads, long retention, dashboards, drilldowns, and filter queries,
answering both forensic questions ("did instance X send notification Y on date answering both forensic questions ("did instance X send notification Y on date
Z, with what body?") and operational ones ("which inbound caller is hammering Z, with what body?") and operational ones ("which inbound caller is hammering
us right now?"). us right now?").
@@ -143,8 +143,8 @@ guarantee.
## Ingestion Paths ## Ingestion Paths
Three write paths converge on the central `AuditLog`, all idempotent on Four paths feed the central `AuditLog` — one site originator and three central
`EventId`. writers — all idempotent on `EventId`.
### Site hot-path append (site-originated events) ### Site hot-path append (site-originated events)