Files
sencho/docs/features/dashboard.mdx
T
Anso 622c1f9262 feat: home dashboard and Settings Hub polish (#506)
* feat(dashboard): drop CPU column and relative timestamp from Stack Health and status bar

The Stack Health table's CPU column duplicated data already surfaced in
the top ResourceGauges and the CPU Usage historical chart. The health
status bar's 'just now' timestamp was cosmetic: no consumer relied on
lastUpdated state for polling, staleness detection, or conditional
rendering. Removing both tightens the dashboard and eliminates a dead
prop chain through useDashboardData.

* refactor: remove dead admin_email field from setup flow

The Setup form captured an admin email under 'Used for license recovery.
Never shared with third parties.' but the value was written to
global_settings and read nowhere: no license recovery, SMTP, or support
contact flow consumed it. Rather than building UI on top of the dead
field, delete the input, the payload key, and the backend persistence.
Any orphaned row from prior setups is harmless and the frontend ignores
unknown settings keys.

* feat(settings): use Radix ScrollArea with per-section scroll memory

Settings Hub used a native-scroll div that snapped to the top every time
the user switched subsections and exposed the default browser scrollbar.
Wrap the nav and content panes with the shadcn ScrollArea (Radix under
the hood, type='hover') and expose a viewportRef so the modal can stash
each section's scrollTop in a ref and restore it via useLayoutEffect on
switch. Style the thumb with translucent foreground tokens so it reads
as glass against popovers and dialogs. Replaces a hand-rolled scroll
hook and ad-hoc CSS utility.
2026-04-12 01:04:15 -04:00

70 lines
3.4 KiB
Plaintext

---
title: Dashboard
description: Real-time system stats, stack health, historical metrics, and recent alerts for your host machine.
---
The **Home** tab is the first thing you see after logging in. It provides a live overview of your node's health, resource usage, stack status, and recent alert activity.
<Frame>
<img src="/images/dashboard/dashboard-overview.png" alt="Sencho dashboard showing health status, resource gauges, stack health table, and historical charts" />
</Frame>
## Health status bar
The top bar provides an at-a-glance health assessment for the active node. Sencho evaluates CPU, RAM, disk usage, exited containers, and unread error alerts to derive one of three states:
| Status | Meaning |
|--------|---------|
| **Healthy** | All systems nominal. No resources above warning thresholds, no unread errors. |
| **Degraded** | At least one resource is above 80%, or there are unread error alerts. |
| **Critical** | At least one resource is above 90%, or there are exited containers with unread errors. |
The bar also shows the active node name, the number of running containers, and the current alert count.
## Resource gauges
Five compact cards display real-time host and container metrics:
| Card | What it shows |
|------|---------------|
| **CPU** | Current CPU usage percentage, core count, and a color-coded gauge bar |
| **Memory** | RAM usage percentage, used/total in GB, and a gauge bar |
| **Disk** | Disk usage percentage, used/total for the primary mount, and a gauge bar |
| **Containers** | Active container count (hover to see managed vs. external breakdown) and exited count |
| **Network** | Current RX (receive) and TX (transmit) throughput in bytes/second |
Gauge bars turn yellow at 80% usage and red at 90%.
## Stack health table
A table listing every stack in your `COMPOSE_DIR` with live status and resource usage:
| Column | Description |
|--------|-------------|
| **Stack** | Stack name (derived from the directory name) |
| **Status** | `UP` (running) or `DN` (exited) |
| **Memory** | Total memory allocated by the stack's containers |
Click any row to navigate directly to that stack's editor. Stacks are sorted with running stacks first, then alphabetically. If you have more than 8 stacks, the table paginates automatically. For fleet-wide CPU usage, see the **CPU** resource gauge card at the top of the dashboard and the **CPU Usage** historical chart below the table.
## Historical metrics charts
Two area charts display time-series data sampled at one-minute intervals, retained for up to 24 hours:
- **CPU Usage** - normalized total CPU percentage across all managed containers over host cores
- **RAM Usage** - total memory allocated by managed containers, in GB
Hover over a data point to see the exact value at that moment.
<Note>
Charts only show data from the moment Sencho started collecting. If you just installed Sencho, they will be mostly empty until metrics accumulate.
</Note>
## Recent alerts
The bottom section displays triggered alert notifications sorted by recency. Each entry shows the severity level (info, warning, or error), the alert message, and a relative timestamp.
Use the **Clear All Notifications** button to dismiss all alerts. If you have more than 8 alerts, the list paginates.
Alert thresholds are configured per stack in **Settings > Notifications**. See [Alerts & Notifications](/features/alerts-notifications) for setup details.