STP Topology

Plugin: go.d.plugin Module: snmp_topology

Overview

See which Layer 2 links are forwarding and which are blocked. Netdata reads the Spanning Tree port table (BRIDGE-MIB dot1dStpPortTable) for port state, root bridge, and path cost.

Netdata reads the BRIDGE-MIB Spanning Tree port table over SNMP to annotate L2 links with their STP state.

This integration is supported on all platforms.

This integration runs as a single instance per Netdata Agent.

Default Behavior

Auto-Detection

Discovered automatically on switches that expose the STP port table.

Limits

The default configuration for this integration does not impose any limits.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Setup

The snmp_topology collector runs as a single instance: it does not take user-defined jobs, and the Netdata web interface offers no + to add one. Adjust its settings in go.d/snmp_topology.conf.

Prerequisites

SNMP devices configured

The devices must already be collected over SNMP (go.d/snmp.conf), and SNMP access must be reachable from the Netdata Agent acting as the site's SNMP hub.

Configuration

Options

Topology discovery needs no per-device configuration: it walks the devices already configured as SNMP collector jobs. The only settings are the two intervals below, and update_every has a minimum of 10.

Config options

Option	Description	Default	Required
update_every	How often to check for new or stale devices, in seconds.	60	no
refresh_every	How often to refresh topology data for each device.	30m	no

via File

The configuration file name for this integration is go.d/snmp_topology.conf.

The file format is YAML. A single-instance collector takes exactly one job, whose name is fixed:

jobs:
  - name: snmp_topology

Any other job name is rejected. Set the collector's own options alongside name. You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/snmp_topology.conf

Examples

There are no configuration examples.

Alerts

There are no alerts configured by default for this integration.

Metrics

Troubleshooting

Other Problems

Collect Diagnostics for Netdata Support

For SNMP metrics, BGP, licensing, or topology issues, follow Collect SNMP troubleshooting data to include built-in diagnostics in a support bundle. SNMP evidence is unsanitized; share the bundle through a restricted Netdata Support ticket.