BGP Peering Topology

Plugin: go.d.plugin Module: snmp_topology

Overview

Map routers to their BGP neighbors. Netdata reads BGP peer tables (BGP4-MIB plus vendor MIBs) and renders router-to-router peering links with remote AS and session state.

Netdata reads the BGP4-MIB and vendor BGP peer tables over SNMP and renders the peering graph in the topology:snmp view.

This integration is supported on all platforms.

This integration supports multiple instances configured side-by-side.

Default Behavior

Auto-Detection

Discovered automatically on routers that expose BGP peer tables.

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

You can configure the snmp_topology collector in two ways:

Method	Best for	How to
UI	Fast setup without editing files	Go to Nodes → Configure this node → Collectors → Jobs, search for snmp_topology, then click + to add a job.
File	If you prefer configuring via file, or need to automate deployments (e.g., with Ansible)	Edit go.d/snmp.conf and add a job.

important

UI configuration requires paid Netdata Cloud plan.

Prerequisites

SNMP access

SNMP must be enabled on the device and reachable from the Netdata Agent acting as the site's SNMP hub.

Configuration

Options

Configure the SNMP collector with the device hostname and SNMP credentials. See the SNMP collector reference for all options.

via UI

Configure the snmp_topology collector from the Netdata web interface:

1. Go to Nodes.
2. Select the node where you want the snmp_topology data-collection job to run and click the ⚙ (Configure this node). That node will run the data collection.
3. The Collectors → Jobs view opens by default.
4. In the Search box, type snmp_topology (or scroll the list) to locate the snmp_topology collector.
5. Click the + next to the snmp_topology collector to add a new job.
6. Fill in the job fields, then click Test to verify the configuration and Submit to save.
   • Test runs the job with the provided settings and shows whether data can be collected.
   • If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.

via File

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

The file format is YAML. Generally, the structure is:

update_every: 1
autodetection_retry: 0
jobs:
  - name: some_name1
  - name: some_name2

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.conf

Examples

There are no configuration examples.

Alerts

There are no alerts configured by default for this integration.

Metrics