diff --git a/docs/API.md b/docs/API.md index 747d587..a1e04f6 100644 --- a/docs/API.md +++ b/docs/API.md @@ -43,7 +43,8 @@ All API routes are mounted under the `/api` prefix. | Devices | `/api/devices/*` | Device CRUD, scanning, status | | Device Groups | `/api/device-groups/*` | Logical device grouping | | Device Tags | `/api/device-tags/*` | Tag-based device labeling | -| Metrics | `/api/metrics/*` | TimescaleDB device metrics (CPU, memory, traffic) | +| Metrics | `/api/metrics/*` | TimescaleDB device metrics (CPU, memory, traffic, wireless) | +| Wireless Issues | `/api/fleet/wireless-issues`, `/api/tenants/{id}/fleet/wireless-issues` | APs with degraded signal, CCQ, or dropped clients | | Config Backups | `/api/config-backups/*` | Automated RouterOS config backup history | | Config Editor | `/api/config-editor/*` | Live RouterOS config browsing and editing | | Firmware | `/api/firmware/*` | RouterOS firmware version management and upgrades | diff --git a/docs/README.md b/docs/README.md index caa8674..6990f6a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -10,7 +10,7 @@ The Other Dude is a self-hosted, multi-tenant platform that gives you centralize ### Fleet -- **Dashboard** -- At-a-glance fleet health with device counts, uptime sparklines, and status breakdowns per organization. +- **Dashboard** -- At-a-glance fleet health with device counts, uptime sparklines, status breakdowns per organization, and an "APs Needing Attention" card highlighting wireless issues. - **Device Management** -- Detailed device pages with system info, interfaces, routes, firewall rules, DHCP leases, and real-time resource metrics. - **Fleet Table** -- Virtual-scrolled table (TanStack Virtual) that handles hundreds of devices without breaking a sweat. - **Device Map** -- Geographic view of device locations. @@ -28,8 +28,8 @@ The Other Dude is a self-hosted, multi-tenant platform that gives you centralize ### Monitoring - **Network Topology** -- Interactive topology map (ReactFlow + Dagre layout) showing device interconnections and shared subnets. -- **Real-Time Metrics** -- Live CPU, memory, disk, and interface traffic via Server-Sent Events (SSE) backed by NATS JetStream. -- **Alert Rules** -- Configurable threshold-based alerts for any metric (CPU > 90%, interface down, uptime reset, etc.). +- **Real-Time Metrics** -- Live CPU, memory, disk, interface traffic, and wireless stats (client count, signal strength, CCQ) via Server-Sent Events (SSE) backed by NATS JetStream. +- **Alert Rules** -- Configurable threshold-based alerts for any metric (CPU > 90%, signal < -75 dBm, CCQ < 60%, interface down, uptime reset, etc.). Default wireless alert rules are seeded automatically for new tenants. - **Notification Channels** -- Route alerts to email, webhooks, or Slack. - **Audit Trail** -- Immutable log of every action taken in the portal, with user attribution and exportable records. - **Transparency Dashboard** -- KMS access event monitoring for tenant admins (who accessed what encryption keys, when). diff --git a/docs/USER-GUIDE.md b/docs/USER-GUIDE.md index 3865011..e359b14 100644 --- a/docs/USER-GUIDE.md +++ b/docs/USER-GUIDE.md @@ -34,7 +34,7 @@ TOD uses a collapsible sidebar with four sections. Press `[` to toggle the sideb | Item | Description | |------|-------------| -| **Dashboard** | Overview of your fleet with device status cards, active alerts, and metrics sparklines. The landing page after login. | +| **Dashboard** | Overview of your fleet with device status cards, active alerts, metrics sparklines, and "APs Needing Attention" wireless health card. The landing page after login. | | **Devices** | Fleet table with search, sort, and filter. Click any device row to open its detail page. | | **Map** | Geographic map view of device locations. | @@ -118,6 +118,7 @@ Click any device in the fleet table to open its detail page. Tabs include: | **DHCP** | Active DHCP leases, server configuration, and address pools. | | **Backups** | Configuration backup timeline with side-by-side diff viewer to compare changes over time. | | **Clients** | Connected clients and wireless registrations. | +| **Wireless** | Wireless metrics charts -- client count, signal strength (dBm), and CCQ per interface over time. | ### Config Editor @@ -155,7 +156,7 @@ Toggle between **Simple** (guided) and **Standard** (full config editor) modes a Create threshold-based rules that fire when device metrics cross defined boundaries: -- Select the metric to monitor (CPU, memory, disk, interface traffic, uptime, etc.). +- Select the metric to monitor (CPU, memory, disk, interface traffic, wireless signal, wireless CCQ, uptime, etc.). - Set the threshold value and comparison operator. - Choose severity: **info**, **warning**, or **critical**. - Assign one or more notification channels. @@ -170,6 +171,8 @@ Alerts can be delivered through multiple channels: | **Webhook** | HTTP POST to any URL with a JSON payload containing alert details. | | **Slack** | Slack incoming webhook with Block Kit formatting for rich alert messages. | +Default wireless alert rules (Signal Degraded at -75 dBm, CCQ Low at 50%) are automatically created when a new tenant is added. + ### Maintenance Windows Schedule maintenance periods to suppress alerts during planned work: diff --git a/docs/website/docs.html b/docs/website/docs.html index cc967c4..c96316d 100644 --- a/docs/website/docs.html +++ b/docs/website/docs.html @@ -141,7 +141,7 @@