|
| 1 | +# Health Dashboard Plan |
| 2 | + |
| 3 | +**Status**: DRAFT / DESIGN ONLY |
| 4 | +**Scope**: visualization and monitoring plan for the Riverbraid constellation |
| 5 | +**Implementation status**: NOT_IMPLEMENTED |
| 6 | +**Security claim**: NONE |
| 7 | + |
| 8 | +## Executive summary |
| 9 | + |
| 10 | +The Riverbraid Health Dashboard is a proposed visualization and monitoring interface for the Riverbraid constellation. |
| 11 | + |
| 12 | +Its purpose is to make coherence, verification state, registry alignment, drift, and evidence status easier to inspect. |
| 13 | + |
| 14 | +This document is a plan. It does not create a dashboard or a real-time monitoring claim. |
| 15 | + |
| 16 | +## Core principles |
| 17 | + |
| 18 | +- **Transparency**: relevant health metrics should be visible and understandable. |
| 19 | +- **Actionability**: dashboard findings should route to corrective action or evidence review. |
| 20 | +- **Customizability**: users should be able to focus on repositories, evidence paths, or time windows. |
| 21 | +- **Scalability**: dashboard design should support the growing constellation. |
| 22 | +- **Security**: sensitive data and configuration should be gated. |
| 23 | +- **Claim-boundedness**: visualizations must not imply stronger claims than the underlying evidence supports. |
| 24 | + |
| 25 | +## View 1 - Constellation overview |
| 26 | + |
| 27 | +High-level summary of the Riverbraid constellation. |
| 28 | + |
| 29 | +| Metric | Description | Visualization | Possible source | |
| 30 | +|---|---|---|---| |
| 31 | +| Overall coherence status | Summary of evidence state across tracked repositories. | Scorecard | readiness matrix / evidence ledger | |
| 32 | +| Verification status | Percentage or count of repositories with current evidence. | Donut or table | evidence packet outputs | |
| 33 | +| Drift incidents | Active or unresolved drift events. | Line or table | drift monitoring outputs | |
| 34 | +| Registry alignment | Relationship between active repos and Evaluation Kit registry. | Status badges | registry scope gap | |
| 35 | + |
| 36 | +Boundary: an aggregate score is only a visualization. It is not a certification or proof of safety. |
| 37 | + |
| 38 | +## View 2 - Repository detail |
| 39 | + |
| 40 | +Repository-specific status. |
| 41 | + |
| 42 | +| Metric | Description | Visualization | Possible source | |
| 43 | +|---|---|---|---| |
| 44 | +| Repository evidence state | Current evidence status for a selected repo. | Scorecard | evidence ledger | |
| 45 | +| Latest verification result | Most recent verification output. | Table | evidence packet outputs | |
| 46 | +| Drift history | Prior drift events for the repo. | Timeline | drift monitoring plan outputs | |
| 47 | +| Dependency vulnerabilities | Known dependency issue counts if scans exist. | Bar chart | future audit results | |
| 48 | +| CI/CD health | Recent workflow status. | Status icons | GitHub Actions | |
| 49 | + |
| 50 | +Boundary: repository status must distinguish registry-listed, support, experimental, scaffold-only, and unknown-pending-evidence states. |
| 51 | + |
| 52 | +## View 3 - Drift monitoring |
| 53 | + |
| 54 | +Dedicated drift surface. |
| 55 | + |
| 56 | +| Metric | Description | Visualization | Possible source | |
| 57 | +|---|---|---|---| |
| 58 | +| Active drift alerts | Current unresolved drift signals. | Table | drift monitoring output | |
| 59 | +| Drift trends | Historical patterns by category. | Area chart | drift monitoring output | |
| 60 | +| Time to resolution | Average or median time to resolve drift. | Bar chart | issue/evidence history | |
| 61 | + |
| 62 | +## Suggested architecture |
| 63 | + |
| 64 | +Potential design: |
| 65 | + |
| 66 | +- frontend: React, Vue, or static dashboard |
| 67 | +- backend: Node.js or FastAPI if dynamic aggregation is needed |
| 68 | +- storage: static JSON first; database only if needed later |
| 69 | +- ingestion: evidence packets, GitHub Actions metadata, registry files, readiness matrix |
| 70 | +- access: public read-only dashboard first; restricted admin surfaces later if needed |
| 71 | + |
| 72 | +## Static-first rule |
| 73 | + |
| 74 | +The first dashboard should be static or static-generated if possible. |
| 75 | + |
| 76 | +A static dashboard is easier to audit, easier to reproduce, and less likely to introduce unnecessary security exposure. |
| 77 | + |
| 78 | +## Data boundaries |
| 79 | + |
| 80 | +Dashboard data should come from explicit artifacts: |
| 81 | + |
| 82 | +- evidence packets |
| 83 | +- readiness matrix |
| 84 | +- claim ledger |
| 85 | +- evidence ledger |
| 86 | +- registry scope gap |
| 87 | +- GitHub Actions status |
| 88 | +- drift monitoring output |
| 89 | + |
| 90 | +Do not scrape private or sensitive data into the dashboard. |
| 91 | + |
| 92 | +## Future enhancements |
| 93 | + |
| 94 | +- predictive drift analysis |
| 95 | +- role-specific dashboard views |
| 96 | +- public read-only dashboard for reviewers |
| 97 | +- integration with external compliance frameworks only after appropriate boundary docs exist |
| 98 | + |
| 99 | +## Non-claim |
| 100 | + |
| 101 | +This document does not create a dashboard, real-time monitoring system, security guarantee, external audit surface, or production readiness claim. |
0 commit comments