meraki-dashboard-exporter 0.6.0

Prometheus exporter for Cisco Meraki Dashboard API metrics

Meraki Dashboard Exporter

A Prometheus exporter for Cisco Meraki Dashboard API metrics with OpenTelemetry support.

Features

• Collects metrics from all Meraki device types (MS, MR, MV, MT, MX, MG)
• Organization-level metrics (API usage, licenses, device counts)
• Device-specific metrics (status, performance, sensor readings)
• Async collection for improved performance
• OpenTelemetry support for metrics and logs
• Structured logging with JSON output
• Docker support with health checks
• Configurable collection intervals

Quick Start

Using Docker

1. Copy .env.example to .env and add your Meraki API key:

   cp .env.example .env
   # Edit .env and add your MERAKI_API_KEY
   

2. Run with Docker Compose:

   docker-compose up -d
   

3. Access metrics at http://localhost:9099/metrics

Using Python

1. Install dependencies:

   uv pip install -e .
   

2. Set environment variables:

   export MERAKI_API_KEY=your_api_key_here
   

3. Run the exporter:

   python -m meraki_dashboard_exporter
   

Configuration

All configuration is done via environment variables. See .env.example for all available options.

Key Settings

Required

• MERAKI_API_KEY: Your Meraki Dashboard API key

Optional

• MERAKI_EXPORTER_ORG_ID: Specific org ID to monitor (monitors all orgs if not set)
• MERAKI_EXPORTER_LOG_LEVEL: Logging level (default: INFO)
• MERAKI_EXPORTER_API_BASE_URL: API base URL for regional endpoints (default: https://api.meraki.com/api/v1)
• MERAKI_EXPORTER_API_TIMEOUT: API request timeout in seconds (default: 30)
• MERAKI_EXPORTER_API_MAX_RETRIES: Maximum API request retries (default: 4)

Update Intervals

• MERAKI_EXPORTER_FAST_UPDATE_INTERVAL: Fast tier interval in seconds (default: 60, range: 30-300)
• MERAKI_EXPORTER_MEDIUM_UPDATE_INTERVAL: Medium tier interval in seconds (default: 300, range: 300-1800)
• MERAKI_EXPORTER_SLOW_UPDATE_INTERVAL: Slow tier interval in seconds (default: 900, range: 600-3600)

Regional API Endpoints

For users in specific regions, use the appropriate API base URL:

• Global/Default: https://api.meraki.com/api/v1
• Canada: https://api.meraki.ca/api/v1
• China: https://api.meraki.cn/api/v1
• India: https://api.meraki.in/api/v1
• US Federal: https://api.gov-meraki.com/api/v1

Example:

export MERAKI_EXPORTER_API_BASE_URL="https://api.meraki.ca/api/v1"  # For Canada region

Metrics

Organization Metrics

• meraki_org_api_requests_total: Total API requests
• meraki_org_networks_total: Number of networks
• meraki_org_devices_total: Number of devices by type
• meraki_org_licenses_total: License counts by type and status
• meraki_org_clients_total: Total active clients (5-minute window)
• meraki_org_usage_total_kb: Total data usage in KB (5-minute window)
• meraki_org_usage_downstream_kb: Downstream data usage in KB (5-minute window)
• meraki_org_usage_upstream_kb: Upstream data usage in KB (5-minute window)

Device Metrics

• meraki_device_up: Device online status
• meraki_device_uptime_seconds: Device uptime

Switch (MS) Metrics

• meraki_ms_port_status: Port connection status
• meraki_ms_port_traffic_bytes: Port traffic counters
• meraki_ms_port_errors_total: Port error counters

Access Point (MR) Metrics

• meraki_mr_clients_connected: Connected client count
• meraki_ap_channel_utilization_*: Channel utilization metrics
• meraki_network_bluetooth_clients_total: Bluetooth clients detected by MR devices

Sensor (MT) Metrics

• meraki_mt_temperature_celsius: Temperature readings
• meraki_mt_humidity_percent: Humidity readings
• meraki_mt_door_status: Door sensor status
• meraki_mt_water_detected: Water detection status
• And more...

Alert Metrics

• meraki_alerts_active: Number of active alerts by type, category, severity, and device type
• meraki_alerts_total_by_severity: Total alerts grouped by severity level
• meraki_alerts_total_by_network: Total alerts per network

Configuration Metrics

• meraki_org_login_security_*: Various login security settings (see config collector for full list)
• meraki_org_configuration_changes_total: Total configuration changes in the last 24 hours

Development

Running Tests

uv run pytest

Linting and Type Checking

uv run ruff check .
uv run mypy .

License

MIT