Files
OrbitWard/docs/discovery-design.md
T
2026-05-26 21:24:54 -06:00

1.9 KiB

Discovery Design

Guided discovery is a core OrbitWard workflow.

Add target
Choose target type
Enter address and credentials
Test connection
Discover available items
Show friendly list of discovered items
User selects what to monitor
User selects what should alert
Create monitors and optional alert rules

Monitor vs Alert Separation

OrbitWard must allow monitoring without alerting. Every discovered item should eventually support separate choices:

  • Collect metric
  • Graph metric
  • Show on dashboard
  • Alert on condition

This prevents every monitor from automatically becoming an alert source.

Friendly SNMP

SNMP is part of the v0.1 guided discovery scope. A user should be able to add a device, test SNMP access, discover what the device exposes, and choose what to monitor.

The normal UI must not show raw OIDs. SNMP profiles should translate implementation details into friendly labels such as interface names, traffic counters, status, errors, uptime, CPU, and memory.

Initial SNMP discovery workflow:

Add device
Enter host/IP and SNMP credential profile
Test SNMP access
Identify device basics
Load available friendly profiles
Discover monitorable items
Show interfaces and device health items with friendly names
User selects what to monitor
User separately selects what should alert
Create monitors and optional alert rules

Initial monitorable SNMP items:

  • Device uptime
  • Interface admin and operational status
  • Interface speed and friendly description
  • Interface inbound and outbound traffic counters
  • Interface errors and discards
  • CPU and memory when supported by a device profile

SNMP versions:

  • SNMPv2c can be the first implementation path for simple networks.
  • SNMPv3 should be supported once the credential workflow can store reusable authenticated/encrypted profiles safely.

Out of v0.1 scope:

  • SNMP traps
  • Topology mapping
  • NetFlow/sFlow
  • Config backup
  • Full NMS-style device templates