srm-exporter

Description

Pormetheus exporter for Synology SRM (Synology Router Manager).

Key features

• get WAN status
• get network utilization
• get devices with status, IP, etc...
• get Wi-Fi devices with link quality, signal strength, max rate, band used, etc...
• get devices traffic usage
• get mesh nodes with status, connected devices, etc...

Exporter Web UI

Access the webui at http://<your-ip>:9922.

Usage

You need to authenticate with an administrator account in order to get permissions needed for SRM API.

docker-compose

---
version: "3.1"
services:
  srm-exporter:
    image: ghcr.io/gilmrt/srm-exporter:latest
    container_name: srm-exporter
    environment:
      - TZ=Europe/London
      - SRM_HOST=192.168.1.1
      - SRM_PORT=8001
      - SRM_USERNAME=admin
      - SRM_PASSWORD=password
      - PERIODS=live
      - USE_HTTPS=True
      - DISABLE_HTTPS_VERIFY=False
      - EXPORTER_CACHE_FOR=0
      - EXPORTER_PORT=9922
    ports:
      - 9922:9922
    restart: unless-stopped

docker cli

docker run -d \
  --name=srm-exporter \
  -e TZ=Europe/London \
  -e SRM_HOST=192.168.1.1 \
  -e SRM_PORT=8001 \
  -e SRM_USERNAME=admin \
  -e SRM_PASSWORD=password \
  -e PERIODS=live \
  -e USE_HTTPS=True \
  -e DISABLE_HTTPS_VERIFY=False \
  -e EXPORTER_CACHE_FOR=0 \
  -e EXPORTER_PORT=9922 \
  -p 9922:9922 \
  --restart unless-stopped \
  ghcr.io/gilmrt/srm-exporter:latest

Environment

Name	Description	Type	Default	Required
TZ	Specify a timezone to use	string	Europe/London	no
SRM_HOST	Specify the Synology Router IP address or hostname	string	192.168.1.1	no
SRM_PORT	Specify the Synology Router port	string	8001	no
SRM_USERNAME	Specify the Synology Router username (should be admin)	string	admin	no
SRM_PASSWORD	Specify the Synology Router password	string		yes
PERIODS	Specify a list of periods to collect. Possible value are live, day, week ,month comma separated	list	live	no
USE_HTTPS	Use HTTPS to connect to SRM Router	boolean	True	no
DISABLE_HTTPS_VERIFY	Disable HTTPS certificat verification	boolean	False	no
EXPORTER_CACHE_FOR	Keep cache for a duration (in second)	integer	0	no
EXPORTER_PORT	Change defaut 9922 port for the exporter.	string	9922	no

Add exporter to Prometheus

To add the SRM Exporter to your Prometheus just add this to your prometheus.yml

- job_name: 'srm-exporter'
  scrape_interval: <time-between-tests>
  scrape_timeout: 1m
  static_configs:
    - targets: ['<ip-of-exporter-machine>:<port-where-exporter-is-listenning>']

Real example where the tests will be done every 30s:

- job_name: 'srm-exporter'
  scrape_interval: 30s
  scrape_timeout: 1m
  static_configs:
    - targets: ['srm-exporter:9922']

Metrics outputs

Name	Description	Labels
device_download_bytes	SRM device current download speed in Bytes/s	host, period, mac, hostname
device_upload_bytes	SRM device current upload speed in Bytes/s	host, period, mac, hostname
device_download_packets	SRM device current downloaded packets	host, period, mac, hostname
device_upload_packets	SRM device current upload packets	host, period, mac, hostname
srm_total_download_bytes	SRM current total download bytes	host, period
srm_total_upload_bytes	SRM current total upload bytes	host, period
device_current_rate	SRM device coonection rate	host, mac, hostname
device_is_online	SRM device online status	host, mac, hostname, connection, ip6_addr, ip_addr
device_is_wireless	SRM device wireless type	host, mac, hostname, band, ip6_addr, ip_addr, rate_quality, wifi_ssid
device_signalstrength	SRM device signal strenght	host, mac, hostname
device_transferRXRate	SRM device RX transfert rate	host, mac, hostname
device_transferTXRate	SRM device TX transfert rate	host, mac, hostname
srm_system_info	SRM System informations	host, cpu_clock_speed, cpu_cores, cpu_series, cpu_vendor, enabled_ntp, firmware_date, firmware_ver, model, ntp_server, ram_size, serial
srm_system_load	SRM System current load	host
srm_system_up_time	SRM System up time	host
srm_disk_total_utilization	SRM Disk utilization total	host
srm_memory_size	SRM System memory size on KB	host
srm_avail_real	SRM System real memory availible	host
srm_avail_swap	SRM System swap available	host
srm_buffer	SRM System buffer memory	host
srm_cached	SRM System cached memory	host
srm_real_usage	SRM System real memeory usage	host
srm_swap_usage	SRM System swap memory usage	host
srm_total_real	SRM System total memory real	host
srm_total_swap	SRM System total swap	host
srm_network_rx_total	SRM System Network total received	host
srm_network_tx_total	SRM System Network total sent	host

Grafana Dashboard

Under construction

Known Issues

Periods

Periods month seems not working on RT2600AC (see comment)

Login failed / Permissions denied

Permissions needed for the API are only available for administrator accounts.

In SRM Control Panel > User, you may notice that an administrator account has a little gold medal with a red ribbon on the user icon (as does the default administrator account) which means that the account is part of the administrator group. If you're not using this primary default admin account, follow steps here or here to create a new one with admin permissions.

Another point concerns multi-factor authentication: even if you've disabled two-factor authentication, you still need to click on the administrator account and click on reset multi-factor authentication to disable it for a use that had already enabled it.

Versioning

This library is maintained under the semantic versioning guidelines.

See the releases on this repository for changelog.

Changelog

See CHANGELOG file

Contributing

If you have a suggestion, please submit a feature request. Pull requests are welcomed.

Credits

Gilles Martin

• github/gilmrt

See also the list of contributors to this project.

License

Copyright © 2023, Gilles Martin.

MIT