search

TheHolm / meraki-dashboard-promethus-exporter

Promethus exporter to collect data from Meraki dashboard via API
GNU General Public License v3.0
3 stars 8 forks source link
meraki meraki-dashboard prometheus prometheus-exporter

readme

Meraki API Exporter for Prometheus

Prometheus exporter to collect some data from Meraki dashboard via API

Exported metrics

Not all devices exports all metrics.

metric unit description
meraki_device_latency seconds Device latency
meraki_device_loss_percent % 0 - 100%
meraki_device_status int 0 - Offline
1 - Online
meraki_device_using_cellular_failover int 1 - using cellular
0 - using main Uplink
meraki_device_uplink_status int 'active': 0
'ready': 1
'connecting': 2
'not connected': 3
'failed': 4
meraki_vpn_mode int 1 - hub
0 - spoke
meraki_vpn_exported_subnets int Subnet exported by the VPN, 1 per subnet
meraki_vpn_meraki_peers int 1 - reachable
0 - unreachable
meraki_vpn_third_party_peers int 1 - reachable
0 - unreachable
request_processing_seconds sec Total processing time for all hosts, exported once

Labels

All metrics but request_processing_seconds have the following labels: label type description
serial string Serial Number
name string Device name or MAC address if name is not defined
networkId string Network ID to which the device belongs
orgName string Organization Name
orgId integer Organization ID

meraki_device_uplink_status also carries the "uplink" label containing the uplink name.

How to Use

pip install -r requirements.txt

You need to provide API Key from meraki portal as argument when starting exporter.
DO NOT USE KEYS WITH FULL ADMIN PRIVILEGES
Exporter is listening on port 9822 on all interfaces by default

  -h, --help     show this help message and exit
  -k API_KEY     API Key (Required, can also be specified using `MERAKI_API_KEY` environment variable)
  -p http_port   HTTP port to listen for Prometheus scrapper, default 9822
  -i bind_to_ip  IP address where HTTP server will listen, default all interfaces
  --vpn          If set VPN connection statuses will be also collected

GET request for /?target=\<Organization Id> returns data expected for Prometheus Exporter

GET request for /organizations returns YAML formatted list of Organisation Id API key has access to. You can use to automatically populate list of targets in Prometheus configuration. 

/usr/bin/curl --silent --output /etc/prometheus/meraki-targets.yml http:/127.0.0.1:9822/organizations

prometheus.yml

scrape_configs:
  - job_name: 'Meraki'
    scrape_interval: 120s
    scrape_timeout: 40s
    metrics_path: /
    file_sd_configs:
      - files:
        - /etc/prometheus/meraki-targets.yml

Please check /systemd folder for systemd services and timers configuration files, if your system uses it.

Docker

There is a Docker image available at ghcr.io/TheHolm/meraki-dashboard-prometheus-exporter. You can run the exporter with a command like:

docker run -p 9822:9822 -e MERAKI_API_KEY=<api key> ghcr.io/TheHolm/meraki-dashboard-prometheus-exporter