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

docs(notification-outbox): trim Site Event Logging notification row, de-duplicate rationale

Browse Source
This commit is contained in:
Joseph Doherty
2026-05-18 23:21:23 -04:00
parent a59f5ec1ff
commit 0dd3be0bd8
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/requirements/Component-SiteEventLogging.md
View File

@@ -25,7 +25,7 @@ Site clusters (event recording and storage). Central cluster (remote query acces
| Data Connection Status | Connected, disconnected, reconnected (per connection) | | Data Connection Status | Connected, disconnected, reconnected (per connection) |
| Store-and-Forward | Message queued, delivered, retried, parked | | Store-and-Forward | Message queued, delivered, retried, parked |
| Instance Lifecycle | Instance enabled, disabled, deleted | | Instance Lifecycle | Instance enabled, disabled, deleted |
| Notification | Site→central forward failure, long-buffered notification (notification still in the site Store-and-Forward buffer past a threshold). Routine enqueue and successful forward events are **not** logged — central holds the authoritative `Notifications` table; site-side logging covers only the in-transit blind spot when the site cannot reach central. | | Notification | Site→central forward failure, long-buffered notification (still in the site buffer past a threshold) |
## Event Entry Schema ## Event Entry Schema
@@ -70,5 +70,5 @@ Each event entry contains:
- **All site subsystems**: Event logging is a cross-cutting concern — any subsystem that produces notable events calls the Event Logging service. - **All site subsystems**: Event logging is a cross-cutting concern — any subsystem that produces notable events calls the Event Logging service.
- **Communication Layer**: Receives remote queries from central and returns results. - **Communication Layer**: Receives remote queries from central and returns results.
- **Central UI**: Site Event Log Viewer displays queried events. - **Central UI**: Site Event Log Viewer displays queried events.
- **Store-and-Forward Engine**: Its notification path (the site→central forward of script-generated notifications) reports forward failures and long-buffered notifications as Notification-category events. Routine enqueue/forward-success events are deliberately not logged — the central Notification Outbox's `Notifications` table is the authoritative audit record; site-side logging covers only the in-transit blind spot when central is unreachable. - **Store-and-Forward Engine**: Its notification path (the site→central forward of script-generated notifications) reports forward failures and long-buffered notifications as Notification-category events. Routine enqueue and forward-success events are deliberately not logged — central's authoritative `Notifications` table (owned by the Notification Outbox component) is the audit record of record; site-side logging covers only the in-transit blind spot when central is unreachable.
- **Health Monitoring**: Script error rates and alarm evaluation error rates can be derived from event log data. - **Health Monitoring**: Script error rates and alarm evaluation error rates can be derived from event log data.