docs: add wireless monitoring to README, user guide, API ref, and website
Document the Wireless tab, wireless alert rules, APs Needing Attention dashboard card, and wireless-issues API endpoints across all docs. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
Jason Staack
@@ -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 |
|
||||
|
||||
@@ -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).
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -141,7 +141,7 @@
|
||||
<ul>
|
||||
<li><strong>Fleet</strong> — Dashboard with at-a-glance fleet health, virtual-scrolled device table, geographic map, and subnet scanner for device discovery.</li>
|
||||
<li><strong>Configuration</strong> — Config Editor with two-phase safe apply, batch configuration across devices, bulk CLI commands, reusable templates, Simple Config (Linksys/Ubiquiti-style UI), and git-backed config backup with diff viewer.</li>
|
||||
<li><strong>Monitoring</strong> — Interactive network topology (ReactFlow + Dagre), real-time metrics via SSE/NATS, configurable alert rules, notification channels (email, webhook, Slack), audit trail, KMS transparency dashboard, and PDF reports.</li>
|
||||
<li><strong>Monitoring</strong> — Interactive network topology (ReactFlow + Dagre), real-time metrics via SSE/NATS (including wireless signal, CCQ, and client count), configurable alert rules, notification channels (email, webhook, Slack), audit trail, KMS transparency dashboard, and PDF reports.</li>
|
||||
<li><strong>Security</strong> — 1Password-style zero-knowledge architecture with SRP-6a auth, 2SKD key derivation, Secret Key with Emergency Kit, OpenBao KMS for per-tenant envelope encryption, Internal CA with SFTP cert deployment, WireGuard VPN, and AES-256-GCM credential encryption.</li>
|
||||
<li><strong>Remote Access</strong> — One-click WinBox tunnel launch via NATS request-reply, browser-based SSH terminal (xterm.js over WebSocket), per-device session management with idle timeouts, and full audit logging of remote sessions.</li>
|
||||
<li><strong>Administration</strong> — Full multi-tenancy with PostgreSQL RLS, user management with RBAC, API keys (<code>mktp_</code> prefix), firmware management, maintenance windows, and setup wizard.</li>
|
||||
@@ -727,7 +727,7 @@ open http://localhost</code></pre>
|
||||
<tr><th>Item</th><th>Description</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><strong>Dashboard</strong></td><td>Overview of your fleet with device status cards, active alerts, and metrics sparklines. The landing page after login.</td></tr>
|
||||
<tr><td><strong>Dashboard</strong></td><td>Overview of your fleet with device status cards, active alerts, metrics sparklines, and “APs Needing Attention” wireless health card. The landing page after login.</td></tr>
|
||||
<tr><td><strong>Devices</strong></td><td>Fleet table with search, sort, and filter. Click any device row to open its detail page.</td></tr>
|
||||
<tr><td><strong>Map</strong></td><td>Geographic map view of device locations.</td></tr>
|
||||
</tbody>
|
||||
@@ -828,6 +828,7 @@ open http://localhost</code></pre>
|
||||
<tr><td><strong>DHCP</strong></td><td>Active DHCP leases, server configuration, and address pools.</td></tr>
|
||||
<tr><td><strong>Backups</strong></td><td>Configuration backup timeline with side-by-side diff viewer to compare changes over time.</td></tr>
|
||||
<tr><td><strong>Clients</strong></td><td>Connected clients and wireless registrations.</td></tr>
|
||||
<tr><td><strong>Wireless</strong></td><td>Wireless metrics charts — client count, signal strength (dBm), and CCQ per interface over time.</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
@@ -942,7 +943,7 @@ open http://localhost</code></pre>
|
||||
<h2>Alert Rules</h2>
|
||||
<p>Create threshold-based rules that fire when device metrics cross defined boundaries:</p>
|
||||
<ul>
|
||||
<li>Select the metric to monitor (CPU, memory, disk, interface traffic, uptime, etc.).</li>
|
||||
<li>Select the metric to monitor (CPU, memory, disk, interface traffic, wireless signal, wireless CCQ, uptime, etc.).</li>
|
||||
<li>Set the threshold value and comparison operator.</li>
|
||||
<li>Choose severity: <strong>info</strong>, <strong>warning</strong>, or <strong>critical</strong>.</li>
|
||||
<li>Assign one or more notification channels.</li>
|
||||
@@ -1201,7 +1202,8 @@ open http://localhost</code></pre>
|
||||
<tr><td>Devices</td><td><code>/api/devices/*</code></td><td>Device CRUD, scanning, status</td></tr>
|
||||
<tr><td>Device Groups</td><td><code>/api/device-groups/*</code></td><td>Logical device grouping</td></tr>
|
||||
<tr><td>Device Tags</td><td><code>/api/device-tags/*</code></td><td>Tag-based device labeling</td></tr>
|
||||
<tr><td>Metrics</td><td><code>/api/metrics/*</code></td><td>TimescaleDB device metrics (CPU, memory, traffic)</td></tr>
|
||||
<tr><td>Metrics</td><td><code>/api/metrics/*</code></td><td>TimescaleDB device metrics (CPU, memory, traffic, wireless)</td></tr>
|
||||
<tr><td>Wireless Issues</td><td><code>/api/fleet/wireless-issues</code></td><td>APs with degraded signal, CCQ, or dropped clients</td></tr>
|
||||
<tr><td>Config Backups</td><td><code>/api/config-backups/*</code></td><td>Automated RouterOS config backup history</td></tr>
|
||||
<tr><td>Config Editor</td><td><code>/api/config-editor/*</code></td><td>Live RouterOS config browsing and editing</td></tr>
|
||||
<tr><td>Firmware</td><td><code>/api/firmware/*</code></td><td>RouterOS firmware version management and upgrades</td></tr>
|
||||
|
||||
@@ -190,7 +190,7 @@
|
||||
<div class="feature-card" id="feature-monitoring">
|
||||
<div class="feature-icon">📈</div>
|
||||
<h3 class="feature-title">Real-Time Monitoring</h3>
|
||||
<p class="feature-desc">Live CPU, memory, disk, and interface traffic metrics via Server-Sent Events. Configurable alert rules with email, webhook, and Slack notifications.</p>
|
||||
<p class="feature-desc">Live CPU, memory, disk, interface traffic, and wireless metrics (signal, CCQ, client count) via Server-Sent Events. Configurable alert rules with email, webhook, and Slack notifications. Dashboard highlights APs needing attention.</p>
|
||||
</div>
|
||||
|
||||
<div class="feature-card" id="feature-security">
|
||||
|
||||
Reference in New Issue
Block a user