Integrations
Where topologies come from, where monitoring data comes from, and how the two are mapped.
Topology sources
Shumoku Server builds topologies from device and connection data. Describe the network in a file, use what is registered in NetBox, or discover neighbor relationships between devices.
| Source | Used for the diagram | What you need |
|---|---|---|
| YAML | The devices, ports and links you describe | A definition file |
| NetBox | Registered devices and cables | NetBox connection details and API access |
| SNMP and LLDP discovery | Devices and neighbor links | A seed device, reachability and SNMP settings |
| Zabbix | Hosts and LLDP neighbor data | Zabbix connection settings and the required collected data |
Discovery can only draw the connections that devices report. Some links have no LLDP neighbor data, so check that the source covers the area you want to draw.
Monitoring data
Server fetches traffic and alerts from your existing monitoring tools and shows them on the topology. What can be shown depends on the data your monitoring tool collects and on Shumoku’s integration.
| Source | Main data |
|---|---|
| Zabbix | Traffic, host information, alerts |
| Prometheus | Metrics, host information, Alertmanager alerts |
| Grafana | Alerts via webhook or Alertmanager |
| Aruba Instant On | Host information, metrics, alerts |
| Arista CV-CUE | AP and switch information, metrics, alerts |
Set the endpoint URL, credentials and targets in Server’s data source settings. The required fields differ by source.
To connect your own inventory or API, write a data source plugin that extends how configuration and monitoring data are imported. The plugin converts the source’s data into Shumoku configuration and monitoring data.
Mapping and updates
To overlay monitoring values, map each device in the diagram to a monitored host and each link to an interface. For example, the line connected to xe-0/0/0 on edge-01 gets that interface’s values.
To reflect cabling or device changes, import the configuration again. Traffic and alerts update according to the settings of each monitoring source. Values fetched from an API on a schedule and alerts arriving by webhook are updated by different triggers.
If monitoring values do not appear, check the device and interface mapping, the data source connection and data collection at the source.