Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/patagonaa/prometheus-mikrotik-swos-exporter
Mikrotik SwOS exporter for Prometheus (non-SNMP-data only)
https://github.com/patagonaa/prometheus-mikrotik-swos-exporter
mikrotik mikrotik-swos nodejs prometheus
Last synced: about 2 months ago
JSON representation
Mikrotik SwOS exporter for Prometheus (non-SNMP-data only)
- Host: GitHub
- URL: https://github.com/patagonaa/prometheus-mikrotik-swos-exporter
- Owner: patagonaa
- License: mit
- Created: 2019-06-30T14:51:02.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T04:12:13.000Z (almost 2 years ago)
- Last Synced: 2024-08-02T15:53:25.431Z (5 months ago)
- Topics: mikrotik, mikrotik-swos, nodejs, prometheus
- Language: JavaScript
- Size: 205 KB
- Stars: 11
- Watchers: 3
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# prometheus-mikrotik-swos-exporter
Mikrotik SwOS exporter for Prometheus. Up until version 2.12 the crossed out metrics below weren't available via SNMP yet. They are now, so this project is mostly unneccessary now.
Tested with:
- CSS326-24G-2S+ on SwOS version 2.9 to 2.13
- CSS106-1G-4P-1S on SwOS version 2.11 to 2.13
- CRS305-1G-4S+ on SwOS version 2.12
Currently exported metrics:
- ~~Device Input Voltage~~ (SNMP mtxrHlVoltage)
- ~~PCB Temperature~~ (SNMP mtxrHlTemperature / mtxrHlProcessorTemperature)
- ~~SFP Temperature~~ (SNMP mtxrOpticalTemperature)
- ~~SFP Voltage~~ (SNMP mtxrOpticalSupplyVoltage)
- ~~SFP TX Bias~~ (SNMP mtxrOpticalTxBiasCurrent)
- SFP TX Power
- SFP RX Power
- ~~PoE Current~~ (SNMP mtxrPOECurrent)
- ~~PoE Power~~ (SNMP mtxrPOEPower)
These are fetched directly from the internal API of the web interface. The web interface might change in the future but this works for now.
Other metrics (like link up/down, link speeds, rx/tx bytes etc.) should be acquired via SNMP.
You can use the following generator.yml module for the [snmp-exporter](https://github.com/prometheus/snmp_exporter) generator to get PoE, temperature and SFP metrics (in addition to the usual IF-MIB statistics):
```yaml
modules:
mikrotik:
walk: [mtxrPOE, mtxrOptical, mtxrHealth]
lookups:
- source_indexes: [mtxrOpticalIndex]
lookup: mtxrOpticalName
- source_indexes: [mtxrPOEInterfaceIndex]
lookup: mtxrPOEName
overrides:
mtxrOpticalName:
ignore: true
mtxrPOEName:
ignore: true
mtxrPOEInterfaceIndex:
ignore: true
```
## Example using docker:
(also using [mndp autodiscovery](https://github.com/patagonaa/prometheus-mndp-autodiscovery) to find all available MikroTik devices in the network)
### docker-compose.yml
```yaml
version: "3"
services:
prometheus:
image: prom/prometheus
volumes:
- "./prometheus.yml:/etc/prometheus/prometheus.yml"
- "mikrotik-discovery:/etc/prometheus/mikrotik-discovery"
- "prometheus-data:/prometheus"
# [...]
mndp-autodiscovery:
restart: unless-stopped
image: prometheus-mndp-autodiscovery
build: ./prometheus-mndp-autodiscovery # path of git repo
volumes:
- "mikrotik-discovery:/file_sd/"
network_mode: host
swos-exporter:
image: prometheus-mikrotik-swos-exporter
build: ./prometheus-mikrotik-swos-exporter # path of git repo
expose:
- 3000
volumes:
prometheus-data:
mikrotik-discovery:
```
### prometheus.yml
```yaml
global:
# ...
scrape_configs:
- job_name: 'swos'
metrics_path: '/metrics'
params:
user: ['admin']
password: ['secure'] # can be left empty
scrape_interval: 30s
file_sd_configs:
- files:
- 'mikrotik-discovery/targets.json'
relabel_configs:
- source_labels: [__address__]
target_label: instance
regex: '(^[^-]*-[^.]*).*'
replacement: '$1'
- source_labels: [__address__]
target_label: __param_target
- target_label: __address__
replacement: 'swos-exporter:3000'
```