An open API service indexing awesome lists of open source software.

https://github.com/zygiss/snmp-exporter-unifi

Prometheus SNMP exporter generator & SNMP configs for UniFi access points
https://github.com/zygiss/snmp-exporter-unifi

Last synced: 4 months ago
JSON representation

Prometheus SNMP exporter generator & SNMP configs for UniFi access points

Awesome Lists containing this project

README

        

# What

This repo will be useful to you if you have [Ubiquiti Networks
UniFi](https://unifi-sdn.ubnt.com/) devices and you use
[Prometheus](https://prometheus.io/) for your metrics.

# Scraping metrics from UniFi devices

The included `snmp.yml` is ready to go as is. Simply get the [SNMP
exporter](https://github.com/prometheus/snmp_exporter), start it and you
should be able to get metrics from your UniFi device.

Test with curl(1):
```
curl -s 'localhost:9116/snmp?target=X.X.X.X&module=unifi'
```

Now you can configure Prometheus to scrape this endpoint and you're
done.

# Customising what metrics are scraped

The included `generator.yml` can be updated to scrape any additional
metrics you need.

To use the generator, you'll need to get the Ubiquiti Networks MIBs from here:
https://dl.ubnt-ut.com/snmp/UBNT-MIB and
https://dl.ubnt-ut.com/snmp/UBNT-UniFi-MIB and place them into
`$HOME/.snmp/mibs`.

The generator
[docs](https://github.com/prometheus/snmp_exporter/tree/master/generator)
should have all you need.

# External links

[Prometheus SNMP exporter](https://github.com/prometheus/snmp_exporter)
has a great README. Make sure you read it thoroughly, as SNMP and MIBs can be
confusing.

The [using and loading
MIBs](https://net-snmp.sourceforge.io/wiki/index.php/TUT:Using_and_loading_MIBS)
section in Net-SNMP documentation is great as well.