fix ui readme
This commit is contained in:
28
README.md
28
README.md
@@ -68,6 +68,9 @@ It is organized around the operational workflow:
|
|||||||
readiness, data quality, and normalized top fields.
|
readiness, data quality, and normalized top fields.
|
||||||
11. Mark findings as `Expected`, `False positive`, or `Confirmed` so repeated
|
11. Mark findings as `Expected`, `False positive`, or `Confirmed` so repeated
|
||||||
known behavior is labeled and lower priority in later refreshes.
|
known behavior is labeled and lower priority in later refreshes.
|
||||||
|
12. Watch `Baseline DB size` in `Overview`. If it keeps growing quickly, lower
|
||||||
|
baseline retention or max values in `Settings`, then run baseline
|
||||||
|
maintenance during a planned stop.
|
||||||
|
|
||||||
The UI also includes a `How To` tab with the same operational checklist. Use it
|
The UI also includes a `How To` tab with the same operational checklist. Use it
|
||||||
when adding new streams or when the dashboard has data but it is unclear what
|
when adding new streams or when the dashboard has data but it is unclear what
|
||||||
@@ -97,6 +100,8 @@ The top status badges are health indicators:
|
|||||||
`N` source entities. Profile readiness is checked separately per stream field.
|
`N` source entities. Profile readiness is checked separately per stream field.
|
||||||
- `Ollama: cached` or `ok` means local LLM output is available. It is supporting
|
- `Ollama: cached` or `ok` means local LLM output is available. It is supporting
|
||||||
evidence, not the source of truth.
|
evidence, not the source of truth.
|
||||||
|
- `Baseline DB size` is the local SQLite baseline on disk. Retention deletes old
|
||||||
|
rows, but SQLite only returns disk space after a manual `VACUUM`.
|
||||||
|
|
||||||
Use `Diagnostics -> Stream Coverage` to decide whether the monitor is healthy:
|
Use `Diagnostics -> Stream Coverage` to decide whether the monitor is healthy:
|
||||||
|
|
||||||
@@ -113,6 +118,29 @@ Use `Diagnostics -> Stream Coverage` to decide whether the monitor is healthy:
|
|||||||
- `sample capped`: aggregate mode counted the full window, but raw events were
|
- `sample capped`: aggregate mode counted the full window, but raw events were
|
||||||
intentionally capped to keep context queries manageable.
|
intentionally capped to keep context queries manageable.
|
||||||
|
|
||||||
|
Baseline storage settings are in `Settings`:
|
||||||
|
|
||||||
|
- `Baseline training days`: how old a field baseline must be before deviations
|
||||||
|
are promoted into triage.
|
||||||
|
- `Baseline bucket retention days`: how long five-minute rate/count buckets are
|
||||||
|
kept.
|
||||||
|
- `Baseline value retention days`: how long stale one-off categorical values are
|
||||||
|
kept.
|
||||||
|
- `Max values per entity field`: cap for distinct values per
|
||||||
|
stream/entity/field. Lower this if `profile_values` grows too fast.
|
||||||
|
|
||||||
|
For a large existing baseline, stop the service before compacting:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./start.sh stop
|
||||||
|
signalscope baseline-maintenance --baseline-db state/fgai-baseline.sqlite3 --retention-days 7 --value-retention-days 3 --max-values-per-field 500 --vacuum
|
||||||
|
./start.sh start
|
||||||
|
```
|
||||||
|
|
||||||
|
`--vacuum` can take time and needs free disk space close to the current DB size.
|
||||||
|
Run maintenance without `--vacuum` first if you only want to inspect row counts,
|
||||||
|
deleted rows, and reclaimable bytes.
|
||||||
|
|
||||||
`Ready Fields` is shown as `ready/tracked`, for example `0/8`. The stream profile
|
`Ready Fields` is shown as `ready/tracked`, for example `0/8`. The stream profile
|
||||||
tracks 8 fields, but none of those fields are mature yet. A field needs at least
|
tracks 8 fields, but none of those fields are mature yet. A field needs at least
|
||||||
12 five-minute buckets and the configured `Baseline training days` before it is
|
12 five-minute buckets and the configured `Baseline training days` before it is
|
||||||
|
|||||||
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user