Skip to main content

Python Prometheus client to RouterBoard devices produced by MikroTik.

Project description

RouterOS Prometheus client

Description

Prometheus client for Mikrotik devices. Can be configured to collect metrics from a single device or multiple devices.

To access the api, use RouterOS-api.

To create metrics, use Prometheus Python Client.

Install

pip install routeros-prometheus-client

Usage

Mikrotik Config

Create a user on the device that has API and read-only access.

/user group add name=prometheus policy=api,read,winbox

Create the user to access the API via.

/user add name=prometheus group=prometheus password=changeme

Create config file

[my_router]
host = 192.168.1.1
username = login
password = password
plaintext_login = True

[my_second_router]
host = 192.168.1.2
username = login
password = password
plaintext_login = True
  • [section] - String - Used for identification device
  • host - String - Hostname or IP of device
  • username - String - Login username - Default 'admin'
  • password - String - Login password - Default empty string
  • port - Integer - TCP Port for API - Default 8728 or 8729 when using SSL
  • plaintext_login - Boolean - Try plaintext login (for RouterOS 6.43 onwards) - Default False
  • use_ssl - Boolean - Use SSL or not? - Default False
  • ssl_verify - Boolean - Verify the SSL certificate? - Default True
  • ssl_verify_hostname - Boolean - Verify the SSL certificate hostname matches? - Default True
  • ssl_context - Object - Pass in a custom SSL context object. Overrides other options. - Default None

Start routeros-prometheus-client

routeros-prometheus-client -c routeros-prometheus-client\config.ini -p 8000

  • -c --config path to config.ini
  • -p --port HTTPServer port

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for RouterOS-Prometheus-client, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size RouterOS_Prometheus_client-0.0.1-py3-none-any.whl (5.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size RouterOS-Prometheus-client-0.0.1.tar.gz (4.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page