diff options
Diffstat (limited to 'collectors/node.d.plugin/snmp/README.md')
| -rw-r--r-- | collectors/node.d.plugin/snmp/README.md | 67 |
1 files changed, 32 insertions, 35 deletions
diff --git a/collectors/node.d.plugin/snmp/README.md b/collectors/node.d.plugin/snmp/README.md index 832108b94..8fd66edb7 100644 --- a/collectors/node.d.plugin/snmp/README.md +++ b/collectors/node.d.plugin/snmp/README.md @@ -1,14 +1,14 @@ # SNMP Data Collector -Using this collector, netdata can collect data from any SNMP device. +Using this collector, Netdata can collect data from any SNMP device. This collector supports: -- any number of SNMP devices -- each SNMP device can be used to collect data for any number of charts -- each chart may have any number of dimensions -- each SNMP device may have a different update frequency -- each SNMP device will accept one or more batches to report values (you can set `max_request_size` per SNMP server, to control the size of batches). +- any number of SNMP devices +- each SNMP device can be used to collect data for any number of charts +- each chart may have any number of dimensions +- each SNMP device may have a different update frequency +- each SNMP device will accept one or more batches to report values (you can set `max_request_size` per SNMP server, to control the size of batches). ## Configuration @@ -16,10 +16,10 @@ You will need to create the file `/etc/netdata/node.d/snmp.conf` with data like In this example: - - the SNMP device is `10.11.12.8`. - - the SNMP community is `public`. - - we will update the values every 10 seconds (`update_every: 10` under the server `10.11.12.8`). - - we define 2 charts `snmp_switch.bandwidth_port1` and `snmp_switch.bandwidth_port2`, each having 2 dimensions: `in` and `out`. +- the SNMP device is `10.11.12.8`. +- the SNMP community is `public`. +- we will update the values every 10 seconds (`update_every: 10` under the server `10.11.12.8`). +- we define 2 charts `snmp_switch.bandwidth_port1` and `snmp_switch.bandwidth_port2`, each having 2 dimensions: `in` and `out`. ```json { @@ -88,7 +88,7 @@ In this example: `update_every` is the update frequency for each server, in seconds. -`max_request_size` limits the maximum number of OIDs that will be requested in a single call. The default is 50. Lower this number of you get `TooBig` errors in netdata error.log. +`max_request_size` limits the maximum number of OIDs that will be requested in a single call. The default is 50. Lower this number of you get `TooBig` errors in Netdata's `error.log`. `family` sets the name of the submenu of the dashboard each chart will appear under. @@ -100,7 +100,6 @@ The SNMP plugin supports Counter64 metrics with the only limitation that the `of <br> If you need to define many charts using incremental OIDs, you can use something like this: - ```json { "enable_autodetect": false, @@ -146,19 +145,18 @@ This is like the previous, but the option `multiply_range` given, will multiply Each of the 24 new charts will have its id (1-24) appended at: -1. its chart unique id, i.e. `snmp_switch.bandwidth_port1` to `snmp_switch.bandwidth_port24` -2. its `title`, i.e. `Switch Bandwidth for port 1` to `Switch Bandwidth for port 24` -3. its `oid` (for all dimensions), i.e. dimension `in` will be `1.3.6.1.2.1.2.2.1.10.1` to `1.3.6.1.2.1.2.2.1.10.24` -3. its priority (which will be incremented for each chart so that the charts will appear on the dashboard in this order) - +1. its chart unique id, i.e. `snmp_switch.bandwidth_port1` to `snmp_switch.bandwidth_port24` +2. its `title`, i.e. `Switch Bandwidth for port 1` to `Switch Bandwidth for port 24` +3. its `oid` (for all dimensions), i.e. dimension `in` will be `1.3.6.1.2.1.2.2.1.10.1` to `1.3.6.1.2.1.2.2.1.10.24` +4. its priority (which will be incremented for each chart so that the charts will appear on the dashboard in this order) The `options` given for each server, are: - - `timeout`, the time to wait for the SNMP device to respond. The default is 5000 ms. - - `version`, the SNMP version to use. `0` is Version 1, `1` is Version 2c. The default is Version 1 (`0`). - - `transport`, the default is `udp4`. - - `port`, the port of the SNMP device to connect to. The default is `161`. - - `retries`, the number of attempts to make to fetch the data. The default is `1`. +- `timeout`, the time to wait for the SNMP device to respond. The default is 5000 ms. +- `version`, the SNMP version to use. `0` is Version 1, `1` is Version 2c. The default is Version 1 (`0`). +- `transport`, the default is `udp4`. +- `port`, the port of the SNMP device to connect to. The default is `161`. +- `retries`, the number of attempts to make to fetch the data. The default is `1`. ## Retrieving names from snmp @@ -168,7 +166,6 @@ You can set a dimension name to a value retrieved from SNMP, by adding `oidname` Both of the above will participate in `multiply_range`. - ## Testing the configuration To test it, you can run: @@ -177,9 +174,9 @@ To test it, you can run: /usr/libexec/netdata/plugins.d/node.d.plugin 1 snmp ``` -The above will run it on your console and you will be able to see what netdata sees, but also errors. You can get a very detailed output by appending `debug` to the command line. +The above will run it on your console and you will be able to see what Netdata sees, but also errors. You can get a very detailed output by appending `debug` to the command line. -If it works, restart netdata to activate the snmp collector and refresh the dashboard (if your SNMP device responds with a delay, you may need to refresh the dashboard in a few seconds). +If it works, restart Netdata to activate the snmp collector and refresh the dashboard (if your SNMP device responds with a delay, you may need to refresh the dashboard in a few seconds). ## Data collection speed @@ -195,11 +192,11 @@ Use `snmpwalk`, like this: snmpwalk -t 20 -v 1 -O fn -c public 10.11.12.8 ``` -- `-t 20` is the timeout in seconds -- `-v 1` is the SNMP version -- `-O fn` will display full OIDs in numeric format (you may want to run it also without this option to see human readable output of OIDs) -- `-c public` is the SNMP community -- `10.11.12.8` is the SNMP device +- `-t 20` is the timeout in seconds +- `-v 1` is the SNMP version +- `-O fn` will display full OIDs in numeric format (you may want to run it also without this option to see human readable output of OIDs) +- `-c public` is the SNMP community +- `10.11.12.8` is the SNMP device Keep in mind that `snmpwalk` outputs the OIDs with a dot in front them. You should remove this dot when adding OIDs to the configuration file of this collector. @@ -207,10 +204,10 @@ Keep in mind that `snmpwalk` outputs the OIDs with a dot in front them. You shou This is what I use for my Linksys SRW2024P. It creates: -1. A chart for power consumption (it is a PoE switch) -2. Two charts for packets received (total packets received and packets received with errors) -3. One chart for packets output -4. 24 charts, one for each port of the switch. It also appends the port names, as defined at the switch, to the chart titles. +1. A chart for power consumption (it is a PoE switch) +2. Two charts for packets received (total packets received and packets received with errors) +3. One chart for packets output +4. 24 charts, one for each port of the switch. It also appends the port names, as defined at the switch, to the chart titles. This switch also reports various other metrics, like snmp, packets per port, etc. Unfortunately it does not report CPU utilization or backplane utilization. @@ -364,4 +361,4 @@ This switch has a very slow SNMP processors. To respond, it needs about 8 second } ``` -[]() +[](<>) |