You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Collecting Metrics/Collectors/Networking/SNMP devices.mdx
+47Lines changed: 47 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -450,6 +450,53 @@ Network interface metrics from cached SNMP data, including traffic rates, packet
450
450
| Multicast In | float | packets/s | hidden | Rate of multicast packets (destined for a group) received per second. Common in video streaming, multicast applications, and routing protocols. |
451
451
| Multicast Out | float | packets/s | hidden | Rate of multicast packets transmitted per second. |
452
452
453
+
### Network Topology
454
+
455
+
Provides the agent-wide SNMP topology view built from all currently running topology-enabled SNMP jobs.
456
+
457
+
This function reads cached LLDP/CDP data collected by the independent topology refresh loop and returns a topology schema (devices, links, and stats). No additional SNMP requests are triggered when calling this function.
458
+
459
+
Use cases:
460
+
- Discover Layer 2 neighbors and link mapping
461
+
- Validate cabling and port connections
462
+
- Identify adjacent devices that are discovered but not monitored
463
+
464
+
465
+
| Aspect | Description |
466
+
|:-------|:------------|
467
+
| Name | `Snmp:topology` |
468
+
| Require Cloud | no |
469
+
| Performance | Uses cached SNMP data only, no additional SNMP requests are triggered:<br/>• Responses are instantaneous from memory cache<br/>• Large devices with many discovered neighbors may return many rows |
470
+
| Security | Exposes discovered device identifiers, interface/port identifiers, and management addresses only:<br/>• No packet payloads or authentication credentials are exposed<br/>• No device configuration details are exposed |
471
+
| Availability | Available when:<br/>• The collector has completed at least one successful topology refresh cycle<br/>• LLDP/CDP topology data is present in cache from the last successful topology refresh<br/>• Returns HTTP 503 if topology cache is not ready yet |
| Nodes Identity | select | Choose actor identity strategy. `ip` collapses nodes by management IP and removes non-IP inferred actors. `mac` keeps MAC-oriented identities. | yes | ip | IP (default), MAC |
482
+
| Map | select | Select the topology map mode. Defaults to the managed-device LLDP/CDP view. Other modes progressively include inferred devices and lower-confidence links. | yes | lldp_cdp_managed | LLDP/CDP/Managed Devices Map (default), High Confidence Inferred Map, All Devices (Low Confidence) |
| Focus On | multiselect | Limit depth filtering to selected managed SNMP roots. The static default is `all_devices`; additional `ip:<address>` options are supplied dynamically from the current managed SNMP jobs. | yes | all_devices | All Devices (default) |
485
+
| Focus Depth | select | Limit topology expansion hops from the focus roots. `all` disables depth filtering. | yes | all | All (default), 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 |
486
+
487
+
#### Returns
488
+
489
+
Agent-wide topology data in a JSON schema suitable for cross-agent aggregation.
490
+
491
+
| Column | Type | Unit | Visibility | Description |
| `extract_value` | Extract a substring via regex (first group). | `"RouterOS CCR2004-16G-2S+" → "CCR2004-16G-2S+"` |
1261
1262
| `match_pattern` + `match_value` | Replace the value using regex groups or static. | `"Palo Alto Networks VM-Series firewall" → "VM-Series firewall"` |
@@ -1302,6 +1303,50 @@ They work the same in **both** places:
1302
1303
port: $4
1303
1304
```
1304
1305
1306
+
- `format`
1307
+
```yaml
1308
+
symbol:
1309
+
OID: 1.3.6.1.2.1.17.1.1
1310
+
name: dot1dBaseBridgeAddress
1311
+
format: hex
1312
+
```
1313
+
1314
+
### Format
1315
+
1316
+
Use `format` when the raw SNMP value must be converted before tag or metadata processing.
1317
+
1318
+
**The collector**:
1319
+
1320
+
- Applies `format` when converting the raw SNMP value to a string.
1321
+
- Then applies the configured tag or metadata transformations to that formatted string.
1322
+
- Supports the same `format` values accepted by `symbol` definitions elsewhere in the profile.
1323
+
1324
+
**Where it can be used**:
1325
+
1326
+
- `metadata.device.fields.<field>.symbol`
1327
+
- `metadata.device.fields.<field>.symbols[]`
1328
+
- `metric_tags[].symbol`
1329
+
1330
+
**Currently used by this profile set**:
1331
+
1332
+
- `format: hex` for octet-string values such as:
1333
+
- MAC addresses
1334
+
- binary management-address values
1335
+
- capability bitmaps
1336
+
1337
+
**Example**:
1338
+
1339
+
```yaml
1340
+
metadata:
1341
+
device:
1342
+
fields:
1343
+
bridge_base_address:
1344
+
symbol:
1345
+
OID: 1.3.6.1.2.1.17.1.1
1346
+
name: dot1dBaseBridgeAddress
1347
+
format: hex
1348
+
```
1349
+
1305
1350
### Mapping
1306
1351
1307
1352
Use `mapping` to replace raw tag values with **human-readable text labels**.
|`NETDATA_USER_CONFIG_DIR`| The directory where all Netdata-related user configuration should be stored. If the plugin requires custom user configuration, this is the place the user has saved it (normally under `/etc/netdata`). |
174
174
|`NETDATA_STOCK_CONFIG_DIR`| The directory where all Netdata -related stock configuration should be stored. If the plugin is shipped with configuration files, this is the place they can be found (normally under `/usr/lib/netdata/conf.d`). |
175
+
|`NETDATA_STOCK_DATA_DIR`| The directory where immutable Netdata stock data files are stored. Plugins can use this for packaged data assets such as MMDB files (normally under `/usr/share/netdata`). |
175
176
|`NETDATA_PLUGINS_DIR`| The directory where all Netdata plugins are stored. |
176
177
|`NETDATA_USER_PLUGINS_DIRS`| The list of directories where custom plugins are stored. |
177
178
|`NETDATA_WEB_DIR`| The directory where the web files of Netdata are saved. |
|[Judy Arrays](https://sourceforge.net/projects/judy/)| Copyright (C) 2000 - 2002 Hewlett-Packard Company |[LGPLv2](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html)|
32
32
|[dlib](https://github.com/davisking/dlib/)| Copyright (C) 2019 Davis E. King (davis@dlib.net), Nils Labugt |[Boost Software License](https://github.com/davisking/dlib/blob/master/dlib/LICENSE.txt)|
33
+
|[DB-IP ASN Lite](https://db-ip.com/db/download/ip-to-asn-lite)| DB-IP.com |[CC BY 4.0](https://db-ip.com/db/lite.php)|
34
+
|[DB-IP City Lite](https://db-ip.com/db/download/ip-to-city-lite)| DB-IP.com |[CC BY 4.0](https://db-ip.com/db/lite.php)|
| config |`/etc/netdata`| The directory configuration files are kept. |
155
155
| stock config |`/usr/lib/netdata/conf.d`||
156
+
| stock data |`/usr/share/netdata`| The directory Netdata uses for immutable stock data files shipped with the installation. |
156
157
| log |`/var/log/netdata`| The directory in which the [log files](/docs/netdata-agent/daemon#logging) are kept. |
157
158
| web |`/usr/share/netdata/web`| The directory the web static files are kept. |
158
159
| cache |`/var/cache/netdata`| The directory the memory database will be stored if and when Netdata exits. Netdata will re-read the database when it will start again, to continue from the same point. |
0 commit comments