Mikrotik monitoring software

Mikrotik monitoring tool that is integrated with prometheus + grafana. It supports CAPsMAN, wireless, bandwidth and general stats monitoring.

Links you may want to visit:

• Last changes here
• commands.json manual
• credentials.json explanation
• grafana_dashboard.json beta version of dashboard

Docker usage

• Download image
• Load it: docker load -i <name of file>
• Initialize it for automated usage: docker run -v <path to config on your computer>:/miktik/config/credentials -t miktik_monitoring miktik
  Note: you can optionally add key in order to change commands and add own:
  -v <path to commands.json file>:/miktik/config/credentials.json
• Initialization for interractive usage: docker run miktik -i ( in development )

Enviroment variables:

miktik_server_address   0.0.0.0
miktik_server_port      7878

commands.json explanation

This is file where all commands application will execute automaticaly are located. Here is example and a bit of explanation:

Important:

Application adds miktik_ to every name on it's web page

{
    "commands":[                                    <= array of commands
        {
            "command": "/ping",                     <= ( required ) command name
            "name": "ping_test",                    <= ( required ) indentifier used in prometheus to indentify results ( application will add `miktik_` before )
            "attributes": [ "host" ],               <= what attributes to seek ( displayed along with command indentifier)
                                                        if there is no such parameter, then application will display all responces
                                                        if you haven't put anything in it then nothing will be displayed as parameter
            "graph_targets": ["time"],              <= this parameter application should print to prometheus as value ( should be an number )
            "split_character": "ms",                <= separator to split value into several responces
            "split_targets": ["time"],              <= Attributes where application should split responce in halves
            "query": [                              <= additional queries for command
                "=count=1", 
                "=address=1.1.1.1" 
                ]
        },
        {
            "command":"/ip/cloud/print",
            "name": "address_v6_info",
        }
    ]
}

Note: name field should be unique in order to prevent unwilled behaviour

credentials.json explanation

This file contains all information about routerboars application needs except certificates if you use ones:

[
    {
        "name": "Router name",          <= Alias of your routerboard
        "uri": "192.168.88.1:8729",     <= Routerboard's address
        "use_ssl": true,                <= `true` if you use ssl ( recommended ), `false` if no
        "username": "user1",            <= Username
        "password": "123",              <= Password
        "cert": "/path/to/file",        <= Certificate file location ( recommended )
        "ca_cert": "/path/to/file"      <= CA certificate if the trusted one is used
    }
]

More information in soon