docs(telemetry): update README and architecture docs to reflect seamless UI telemetry
Validate Documentation / lint-docs (push) Successful in 11s

This commit is contained in:
Lukas Holzner
2026-09-04 13:44:29 +02:00
parent aa68a2956c
commit da26aef6ac
11 changed files with 11 additions and 10 deletions
+3 -3
View File
@@ -39,10 +39,10 @@ Zero-data-loss **Appliance Setup & Migration Wizard** safely detecting and impor
![NaxOS Migration Wizard](docs/images/migration-wizard.png) ![NaxOS Migration Wizard](docs/images/migration-wizard.png)
### 4. Embedded CNCF Perses Native Analytics ### 4. Seamless Integrated Real-Time Telemetry
CNCF Perses embedded dashboards replacing standalone Grafana for real-time ZFS ARC hit ratios (98.6%), IOPS latency, 10GbE network traffic with BBR congestion control, and CPU distribution. Embedded live telemetry replacing standalone Grafana for real-time ZFS ARC hit ratios (98.6%), storage pool I/O bandwidth, multi-core CPU load, and dynamic RAM footprint directly woven into the appliance interface.
![NaxOS Perses Analytics](docs/images/perses-analytics.png) ![NaxOS System Telemetry](docs/images/system-telemetry.png)
### 5. App Store & Tri-Tier Workload Runtime Engine ### 5. App Store & Tri-Tier Workload Runtime Engine
Curated 1-click self-hosted application catalog with hardware-accelerated Immich (Intel QuickSync QSV / OpenCL), Nextcloud, Jellyfin, and Vaultwarden. Supports runtime toggling between **Native Systemd**, **Rootless Docker**, and **K3s**. Curated 1-click self-hosted application catalog with hardware-accelerated Immich (Intel QuickSync QSV / OpenCL), Nextcloud, Jellyfin, and Vaultwarden. Supports runtime toggling between **Native Systemd**, **Rootless Docker**, and **K3s**.
+8 -7
View File
@@ -1,18 +1,19 @@
# CNCF Perses Native Analytics Architecture # Integrated Real-Time Telemetry & Metrics Architecture
## Why Perses over Standalone Grafana? ## Seamless In-App Telemetry vs. Standalone Grafana
Traditional NAS appliances that provide telemetry either bundle a heavy standalone Grafana instance (which requires its own SQLite/PostgreSQL database, user accounts, and separate session cookies) or write rudimentary, un-configurable charts into their dashboard. Traditional NAS appliances that provide telemetry either bundle a heavy standalone Grafana instance (which requires its own SQLite/PostgreSQL database, user accounts, and separate session cookies) or isolate graphs into a disconnected, foreign tab.
NaxOS takes a pioneering approach by integrating **Perses** (a Cloud Native Computing Foundation project): NaxOS takes a pioneering approach by integrating **Perses** (a Cloud Native Computing Foundation project) as the underlying declarative telemetry engine, weaving real-time metrics directly into the core appliance dashboard and storage views:
1. **GitOps & Declarative Native**: 1. **GitOps & Declarative Native**:
- Perses dashboards and datasources are written in clean JSON/CUE manifests. - Perses dashboards and datasources are written in clean declarative JSON/CUE manifests.
- Dashboards are checked into `/var/lib/perses/projects/naxos/dashboards` as code. - Dashboards are checked into `/var/lib/perses/projects/naxos/dashboards` as code.
2. **Embedded Direct Visualization**: 2. **Embedded Direct Visualization**:
- The NaxOS Web Dashboard communicates with the internal Perses metrics API. - The NaxOS Web Dashboard seamlessly communicates with the internal Perses metrics API.
- Eliminates Grafana's multi-megabyte bundle overhead, auth barriers, and database schema migrations. - Eliminates Grafana's multi-megabyte bundle overhead, auth barriers, and database schema migrations.
- Telemetry widgets live naturally alongside storage pool management, active workloads, and system status.
3. **Optimized for OpenZFS Metrics**: 3. **Optimized for OpenZFS Metrics**:
- Out-of-the-box panels monitor OpenZFS ARC hits, misses, ARC target sizing, IOPS, and disk latencies scraped from Prometheus and Node Exporter. - Out-of-the-box panels monitor OpenZFS ARC hits, misses, ARC target sizing, IOPS, and disk latencies scraped from Prometheus and Node Exporter.
![Embedded CNCF Perses Analytics](../images/perses-analytics.png) ![Seamless Integrated Telemetry in NaxOS](../images/system-telemetry.png)
Binary file not shown.

Before

Width:  |  Height:  |  Size: 168 KiB

After

Width:  |  Height:  |  Size: 223 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 206 KiB

After

Width:  |  Height:  |  Size: 272 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 116 KiB

After

Width:  |  Height:  |  Size: 166 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 100 KiB

After

Width:  |  Height:  |  Size: 158 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 138 KiB

After

Width:  |  Height:  |  Size: 272 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 92 KiB

After

Width:  |  Height:  |  Size: 144 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 92 KiB

After

Width:  |  Height:  |  Size: 144 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 99 KiB

After

Width:  |  Height:  |  Size: 148 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 271 KiB