Description
MKTXP is a Prometheus Exporter for Mikrotik RouterOS devices.
It enables gathering metrics across multiple routers, all easily configurable via built-in CLI interface.
MKTXP comes with a dedicated Grafana dashboard
Requirements:
-
Python 3.6.x or later
-
Supported OSs:
- Linux
- Mac OSX
-
Mikrotik RouterOS device(s)
-
Optional:
Install:
- from PyPI:
$ pip install mktxp - latest from source repository:
$ pip install git+https://github.com/akpw/mktxp
Getting started
After installing MKTXP, you need to edit its main configuration file. The easiest way to do it is via:
mktxp edit
This opens the file in your default system editor.
In case you prefer a different editor, just run the edit command with its optional -ed parameter e.g.:
mktxp edit -ed nano
The configuration file comes with a sample configuration, making it easy to copy / edit parameters as needed:
[Sample-Router]
enabled = False # turns metrics collection for this RouterOS device on / off
hostname = localhost # RouterOS IP address
port = 8728 # RouterOS IP Port
username = username # RouterOS user, needs to have 'read' and 'api' permissions
password = password
use_ssl = False # enables connection via API-SSL servis
no_ssl_certificate = False # enables API_SSL connect without router SSL certificate
ssl_certificate_verify = False # turns SSL certificate verification on / off
dhcp = True # DHCP general metrics
dhcp_lease = True # DHCP lease metrics
pool = True # Pool metrics
interface = True # Interfaces traffic metrics
firewall = True # Firewall rules traffic metrics
monitor = True # Interface monitor metrics
route = True # Routes metrics
wireless = True # WLAN general metrics
wireless_clients = True # WLAN clients metrics
capsman = True # CAPsMAN general metrics
capsman_clients = True # CAPsMAN clients metrics
use_comments_over_names = False # when available, forces using comments over the interfaces names
Mikrotik Device Config
For the purpose of device monitoring, it's best to create a dedicated RouterOS device user with minimal required permissions.
MKTXP only needs API and Read, so at that point you can go to your router and type:
/user group add name=mktxp_group policy=api,read
/user add name=mktxp_user group=mktxp_group password=mktxp_user_password
That's all it takes!
Now put these user credentials in the above configurtation file, and at that point should already be able to check your success.
Since MKTXP can print selected metrics directly on the command line, in this example let's check on some of my smarthome CAPsMAN clients:
~> mktxp print -en MKT-GT -cc
Connecting to router MKT-GT@10.70.0.1
2021-01-24 12:04:29 Connection to router MKT-GT@10.70.0.1 has been established
| dhcp_name | dhcp_address | mac_address | rx_signal | interface | ssid | tx_rate | rx_rate | uptime |
|----------------------|----------------|-------------------|-------------|-------------|--------|-----------|-----------|----------|
| Woox Runner | 10.**.*.** | 80:*************D | -64 | LR-2G-1-1 | AKP | 72 Mbps | 54 Mbps | 3 days |
| Woox Office Lamp | 10.**.*.** | 80:*************F | -59 | LR-2G-1-1 | AKP | 72 Mbps | 54 Mbps | 3 days |
| Harmony Hub | 10.**.*.** | C8:*************5 | -46 | LR-2G-1-1 | AKP | 72 Mbps | 72 Mbps | 3 days |
| Woox Office Hub | 10.**.*.** | DC:*************7 | -44 | LR-2G-1-1 | AKP | 72 Mbps | 54 Mbps | 3 days |
| Woox Ext Hub | 10.**.*.** | DC:*************E | -44 | LR-2G-1-1 | AKP | 72 Mbps | 54 Mbps | 3 days |
| Amazon Echo | 10.**.*.** | CC:*************4 | -44 | LR-2G-1-1 | AKP | 72 Mbps | 72 Mbps | a day |
| Woox Living Room Hub | 10.**.*.** | DC:*************0 | -43 | LR-2G-1-1 | AKP | 72 Mbps | 54 Mbps | 3 days |
| JBL View | 10.**.*.** | 00:*************D | -28 | LR-2G-1-1 | AKP | 144 Mbps | 117 Mbps | 7 hours |
| | | | | | | | | |
| MBP15 | 10.**.*.** | 78:*************E | -53 | GT-5G-1 | AKP5G | 877 Mbps | 877 Mbps | 3 days |
| | | | | | | | | |
| Woox Toaster | 10.**.*.** | 68:*************B | -70 | KT-2G-1-1 | AKP | 72 Mbps | 54 Mbps | 3 days |
| Woox Kettle | 10.**.*.** | B4:*************5 | -65 | KT-2G-1-1 | AKP | 65 Mbps | 54 Mbps | 2 days |
| Woburn White | 10.**.*.** | 54:*************6 | -59 | KT-2G-1-1 | AKP | 72 Mbps | 72 Mbps | 9 hours |
| Siemens Washer | 10.**.*.** | 68:*************1 | -57 | KT-2G-1-1 | AKP | 72 Mbps | 72 Mbps | 2 days |
| Woburn Black | 10.**.*.** | 54:*************8 | -57 | KT-2G-1-1 | AKP | 72 Mbps | 72 Mbps | 9 hours |
| Google Nest Display | 10.**.*.** | 1C:*************A | -49 | KT-2G-1-1 | AKP | 52 Mbps | 43 Mbps | 8 hours |
----------------------- --
Connected Wifi Devices: 15
----------------------- --
Hmmm, that toaster looks like it'd use a better signal.. But before going to fixing that one, let's get back on track and proceed to the actual Prometheus export.
Exporting to Prometheus
For exporting your routers' metrics to an existing Prometheus installation, you basically just need to connect MKTXP to it.
To do that, let's edit Prometheus config file:
nano /etc/prometheus/prometheus.yml
and simply add:
- job_name: 'mktxp'
static_configs:
- targets: ['mktxp_machine_IP:49090']
At that point, we should be are ready for the mktxp export command that will get all router(s) metrics as configured above and serve them via a http server on default port 49090. In case prefer to use a different port, you can change it (along with other internal mktxp parameters) via mktxp edit -i.
Grafana dashboard
Now with all of your devices metrics safely in Prometheus, it's easy to visualise them with this Grafana dashboard
Setting up MKTXP to run as a Linux Service
If you've installed MKTXP on a Linux system, you can run it with system boot via adding a service:
nano /etc/systemd/system/mktxp.service
Now copy and paste the following:
[Unit]
Description=MKTXP Exporter
[Service]
User=user # the user under which mktxp was installed
ExecStart=mktxp export # if mktxp is not at your $PATH, you might need to provide a full path
[Install]
WantedBy=default.target
Let's start the service and check its' status:
sudo systemctl daemon-reload
sudo systemctl start mktxp
sudo systemctl enable mktxp
systemctl status mktxp
● mktxp.service - MKTXP Mikrotik Exporter to Prometheus
Loaded: loaded (/etc/systemd/system/mktxp.service; disabled; vendor preset: enabled)
Active: active (running) since Sun 2021-01-24 09:16:44 CET; 2h 44min ago
...
Full description of CLI Commands
mktxp
. action commands:
.. info Shows base MKTXP info
.. edit Open MKTXP configuration file in your editor of choice
.. export Starts collecting metrics for all enabled RouterOS configuration entries
.. print Displays seleted metrics on the command line
.. show Shows MKTXP configuration entries on the command line
Usage: $ mktxp [-h] {info, edit, export, print, show } Commands: {info, edit, export, print, show }
$ mktxp {command} -h #run this for detailed help on individual commands
Installing Development version
- Clone the repo, then run:
$ python setup.py develop
Running Tests
- TDB
- Run via:
$ python setup.py test