dohertj2/ScadaBridge
1
0
Fork 0
Code Issues 15 Pull Requests Actions Packages Projects Releases Wiki Activity

docs(audit-log): list all audit channels and their kinds, incl. Cluster and ScriptTrace (ScadaBridge#102 item 5)

Browse Source 
Claude-Session: https://claude.ai/code/session_01GT67AEHd2Acv1YPwGfXEoV
This commit is contained in:
Joseph Doherty
2026-11-09 15:27:48 -05:00
parent 3b0c2b3bfa
commit 47af424c2e
1 changed files with 16 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/components/AuditLog.md
+16 -1
View File
@@ -18,7 +18,22 @@ The same DI entry point, `ServiceCollectionExtensions.AddAuditLog`, registers th
### Script trust boundary
The audited scope is the script trust boundary, not framework traffic. The four channels are modelled by the `AuditChannel` enum (`ApiOutbound`, `DbOutbound`, `Notification`, `ApiInbound`), and the specific action by `AuditKind` (for example `ApiCall`, `DbWriteCached`, `NotifySend`, `InboundRequest`). Every row is built through `ScadaBridgeAuditEventFactory.Create`, which maps the domain vocabulary onto the canonical record: `Channel`/`Kind`/`Status` become `Action`/`Category`/`Outcome` plus a `DetailsJson` extension bag carrying every other domain field.
The audited scope is the script trust boundary, not framework traffic, plus a small set of operator-initiated central acts. Channels are modelled by the `AuditChannel` enum and the specific action by `AuditKind`. Every row is built through `ScadaBridgeAuditEventFactory.Create`, which maps the domain vocabulary onto the canonical record: `Channel`/`Kind`/`Status` become `Action`/`Category`/`Outcome` plus a `DetailsJson` extension bag carrying every other domain field.
The channels and the kinds each one carries (derived from `AuditChannel.cs` / `AuditKind.cs` and the emitting call sites):
| Channel | Kinds | What it records |
|---|---|---|
| `ApiOutbound` | `ApiCall`, `ApiCallCached`, `CachedSubmit`, `CachedResolve` | Script calls to external systems; cached variants emit several rows per operation. |
| `DbOutbound` | `DbWrite`, `DbWriteCached`, `CachedSubmit`, `CachedResolve` | Script database writes. |
| `Notification` | `NotifySend`, `NotifyDeliver` | Notification submit and delivery. |
| `ApiInbound` | `InboundRequest`, `InboundAuthFailure` | Inbound API requests and auth failures. |
| `SecuredWrite` | `SecuredWriteSubmit`, `SecuredWriteApprove`, `SecuredWriteReject`, `SecuredWriteExecute`, `SecuredWriteExpire` | Two-person secured-write lifecycle; `Expire` is a system-emitted TTL lapse. |
| `Cluster` | `ManualFailover` | An administrator's manual failover of the central pair (Health page); one row per invocation, written before the Leave is issued. |
| `ScriptTrace` | `RouteCall`, `ScriptRun`, `AttributeWrite`, `AttributeWait`, `ScriptLog` | Flow Debugger trace rows. `RouteCall` is always-on; the others are emitted only for traced executions. `ScriptLog` is folded into its owning step by the Flow Debugger and is never a node. |
| `Security` | `CertTrust`, `CertTrustRemove` | Operator trust decisions for OPC UA server certificates (Gitea #43). |
`ReconciliationAbandoned` (a permanently-lost reconciliation-pull row, emitted once by `SiteAuditReconciliationActor`) is a synthetic row that reuses the channel of the row that was lost (falling back to `ApiOutbound`), so it appears under whichever channel above lost the data.
### Canonical `AuditEvent` and `DetailsJson`