Mikro-Watch

PHP process to capture and relay or display the mikrotik Accounting data.

Mikro-Watch will :

Fetch the data from the mikrotik router.
Process each bidirectional transfer to get metrics for each internal IP (within specified range)
Push or display data.

Currently push to inflxudb directly, but plans are to output data for telegraf ingestion or display in a simple webpage.

Requirements

PHP 5.6 or later
Composer
or Docker

Configuration and running

First, make sure your router is configured to accept request to the account page by going to IP -> Accounting -> Web Access

Docker

docker run -d --name mikro-watch \
    -e MIKROTIK_IP=10.0.0.1 \
    -e NETWORK_RANGE=10.0.0.1-10.0.0.255 \
    -e INFLUXDB_HOST=10.0.0.1 \
    -e INFLUXDB_USER=user \
    -e INFLUXDB_PASS=***pass*** \
    -e INFLUXDB_DATABASE=influxdb \
    ncareau/mikro-watch

Docker compose

version: '3'
services:
    mikro-watch:
        image: ncareau/mikro-watch
        container_name: mikro-watch
        environment:
            - MIKROTIK_IP=10.0.0.1
            - NETWORK_RANGE=10.0.0.1-10.0.0.255
            - INFLUXDB_HOST=10.0.0.1
            - INFLUXDB_USER=user
            - INFLUXDB_PASS=***pass***
            - INFLUXDB_DATABASE=influxdb
        restart : unless-stopped

Manual

Copy the .env file to .env.local and change the information with your current network.

php mikro-watch influxdb will push once to influxdb
php mikro-watch daemon will start a daemon pushing to influxdb each 10 sec.
- --timeout 5 or -t 5 to change the timeout between calls in seconds.

Instructions to install this application as a systemd service are located in the mikrowatch.service file.

Environment Variables

Variable	Description
`MIKROTIK_IP`	IP of your mikrotik router
`MIKROTIK_PROTO`	Default: `https`
`MIKROTIK_SSL_VERIFY`	if using `https`, verify for valid ssl certificate
`NETWORK_RANGE`	Range of your network to filter ips.
`INFLUXDB_HOST`	Influxdb host
`INFLUXDB_USER`	Influxdb username
`INFLUXDB_PASS`	Influxdb password
`INFLUXDB_DATABASE`	Influxdb database

Note & Troucleshooting

When FastTrack is enabled, some packet will not be accounted for. To disable this (This will result in more CPU usage on your router) disable the fasttrack rule in IP -> Firewall -> Filter Rules.

Calling the accounting webpage resets the counter. This means that if multiple processes or users call the mikrotik api, only a subset of the data will be captured.

hertzg/mikro-watch