docs: update architecture documentation and manifests
Refine technical documentation to reflect current architecture, component structure, and routing conventions for the vcon console.
This commit is contained in:
1 parent
bb938c33c0
commit
367dd819f8
64 files changed
+910
-2661
No files matched your search
+7
-9
@@ -1,12 +1,10 @@
|
||||
# Storage Data Manifest
|
||||
# Storage Directory Manifest (`storage/`)
|
||||
|
||||
## Purpose
|
||||
Root directory for all collected realtime CSV datasets.
|
||||
Root storage directory for partitioned CSV event datasets written by the Next.js and Port 4000 ingestion engines.
|
||||
|
||||
## Directory Structure
|
||||
`/storage/data/{clientId}/{YYYY-MM-DD}.csv`
|
||||
|
||||
## Rotation Rules
|
||||
- Daily partition by ISO date string (`YYYY-MM-DD.csv`)
|
||||
- Size rotation partition (`{YYYY-MM-DD}-part{N}.csv`) when any single file reaches 100MB threshold.
|
||||
- Row schema: `clientId, eventId, timestamp, payload`
|
||||
## Partition Layout
|
||||
- **File Path**: `/storage/data/{clientId}/{YYYY-MM-DD}.csv`
|
||||
- **Overflow Rotation**: `/storage/data/{clientId}/{YYYY-MM-DD}-part{N}.csv` when a partition reaches the configured `fileRotationMb` size limit (default `100MB`).
|
||||
- **CSV Header**: `clientId,eventId,timestamp,payload`
|
||||
- **Git Policy**: Runtime data files under `storage/data/` are ignored by Git (`.gitignore`).
|
||||
Reference in new issue
Block a user