routeros-exporter/README.md

59 lines
1 KiB
Markdown
Raw Permalink Normal View History

2021-05-30 19:29:00 +00:00
# RouterOS Prometheus Exporter
2021-05-29 21:14:26 +00:00
2021-10-08 20:14:48 +00:00
## Setup
2021-05-29 21:14:26 +00:00
You need to create a user on routerOS (>7.1):
```
/user group
2021-05-30 19:29:00 +00:00
add name=prometheus policy=api,rest-api,!local,!telnet,!ssh,!ftp,!reboot,!write,!policy,!test,!password,!web,!sniff,!sensitive,!romon,!dude,!tikapp
2021-05-29 22:02:18 +00:00
/user
add group=prometheus name=prometheus password=<your super secret password>
````
2021-11-01 20:02:46 +00:00
You also need `www-ssl` [enable](https://help.mikrotik.com/docs/display/ROS/REST+API)
## Docker
2021-11-01 20:12:12 +00:00
On docker hub:
```
docker pull yverry/routeros-exporter
```
docker-compose:
```
2021-10-08 20:06:28 +00:00
routeros-exporter:
2021-11-01 20:12:12 +00:00
image: yverry/routeros-exporter
restart: always
environment:
- ROUTER_IP=<your ROUTERIP>
- ROUTER_USERNAME=<your prometheus username>
- ROUTER_PASSWORD=<your super secret password>
2021-10-08 20:14:48 +00:00
```
### build
simply use `make build`
## Metrics
Today thoose metrics was fetched by this exporter:
* interfaces
2021-11-01 20:02:46 +00:00
* tx
* rx
* fastTrack
* cpu
* load
* irq
2022-01-08 20:55:37 +00:00
* system
* uptime
2022-01-08 19:57:13 +00:00
# Misc
## Grafana
You can find grafana dashboard template in `misc/grafana-dashboard.json`