Skip to content

Getting Started

This section shows the quickest way to run the exporter.

Requirements

  • Docker
  • Meraki Dashboard API access and key (read-only recommended)

Setup

  1. Copy .env.example to .env and set MERAKI_EXPORTER_MERAKI__API_KEY.
  2. Start the container with docker compose up -d. You can review the docker-compose.yml for optional settings.

Alternatively, run directly with Docker: 

docker run -d \
  -e MERAKI_EXPORTER_MERAKI__API_KEY=your_api_key_here \
  -p 9099:9099 \
  ghcr.io/rknightion/meraki-dashboard-exporter:latest

Verify

  • Visit http://localhost:9099/ for the landing page.
  • http://localhost:9099/metrics exposes Prometheus metrics (defaults on; see Configuration to disable export for meraki_* or meraki_exporter_*).
  • curl http://localhost:9099/health should return {"status": "healthy"}.
  • Cardinality reports appear after the first full collection cycle (defaults to 15 minutes).

Next read the Configuration guide for all settings and the Metrics Reference for available metrics.