There is no need to install the Generator as it comes with the SNMP exporter. But if you have a device that supplies it’s own MIB (and many do), you should add that to the default location.
# Mibs are often named SOMETHING-MIB.txt sudo cp -n *MIB.txt /usr/share/snmp/mibs/
You must identify the values you want to capture. Using
snmpwalk is a good way to see what’s available, but it helps to have a little context.
The data is arranged like a folder structure that you drill-down though. The folder names are all numeric, with ‘.’ instead of slashes. So if you wanted to get a device’s sysName you’d click down through 184.108.40.206.220.127.116.11 and look in the file 0.
When you use
snmpwalk it starts wherever you tell it and then starts drilling-down, printing out everything it finds.
How do you know that’s where sysName is at? A bunch of folks got together (the ISO folks) and decided everything in advance. Then they made some handy files (MIBs) and passed them out so you didn’t have to remember all the numbers.
They allow vendors to create their own sections as well, for things that might not fit anywhere else.
A good place to start is looking at what the vendor made available. You see this by walking their section and including their MIB so you get descriptive names - only the ISO System MIB is included by default.
# The SysobjectID identifies the vendor section # Note use of the MIB name without the .txt $ snmpwalk -m +SOMEVENDOR-MIB -v 2c -c public some.address SysobjectID SNMPv2-MIB::sysObjectID.0 = OID: SOMEVENDOR-MIB::somevendoramerica # Then walk the vendor section using the name from above $ snmpwalk -m +SOMEVENDOR-MIB -v 2c -c some.address somevendoramerica SOMEVENDOR-MIB::model.0 = STRING: SOME-MODEL SOMEVENDOR-MIB::power.0 = INTEGER: 0 ... ... # Also check out the general System section $ snmpwalk -m +SOMEVENDOR-MIB -v 2c -c public some.address system # You can also walk the whole ISO tree. In some cases, # there are thousands of entries and it's indeciperable $ snmpwalk -m +SOMEVENDOR-MIB -v 2c -c public some.system iso
This can be a lot of information and you’ll need to do some homework to see what data you want to collect.
The exporter’s default configuration file is
snmp.yml and contains about 57 Thousand lines of config. It’s designed to pull data from whatever you point it at. Basically, it doesn’t know what device it’s talking to, so it tries to cover all the bases.
This isn’t a file you should edit by hand. Instead, you create instructions for the generator and it look though the MIBs and create one for you. Here’s an example for a Samlex Invertor.
modules: samlex: walk: - sysLocation - inverterMode - power - vin - tempDD - tempDA
prometheus-snmp-generator generate sudo cp /etc/prometheus/snmp.yml /etc/prometheus/snmp.yml.orig sudo cp ~/snmp.yml /etc/prometheus sudo systemctl reload prometheus-snmp-exporter.service
Configuration in Prometheus remains the same - but since we picked a new module name we need to adjust that.
... ... params: module: [samlex] ... ...
sudo systemctl reload prometheus.service
Adding Data Prefixes
by default, the names are all over the place. The SNMP Exporter Devs leave it this way because there are a lot of pre-built dashboards on downstream systems that expect the existing names.
If you are building your own downstream systems you can prefix (as is best-practice) as you like with a post generation step. This example cases them all to be prefixed with samlex_.
prometheus-snmp-generator generate sed -i 's/name: /name: samlex_/' snmp.yml
You can combine multiple systems in the generator file to create one snmp.yml file, and refer to them by the module name in the Prometheus file.
modules: samlex: walk: - sysLocation - inverterMode - power - vin - tempDD - tempDA ubiquiti: walk: - something - somethingElse
As before, you can get a preview directly from the exporter (using a link like below). This data should show up in the Web UI too.
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.