Prometheus Exporter written in Go for TP-Link Omada SDN.

This exporter is built with native Go HTTP and prometheus/client_golang libraries to expose metrics from Omada SDN to Prometheus. Metrics are queried live from the controller when the /metrics endpoint is accessed, avoiding unnecessary polling when not in use.

Supports both Omada OpenAPI and Web API to accommodate current platform limitations.

• Omada Controller with configured:
  • OpenAPI Client
  • Service user account
• Prometheus (or another metrics scraper) to collect and store the metrics
• Grafana to visualize the data using built-in dashboards
• (Optional) Grafana Loki if you want to collect and view logs from the exporter

1. Clone the Repository

git clone https://github.com/StanislawHorna/Omada_Exporter_Go.git
cd Omada_Exporter_Go

2. Create .env File with variables from Configuration Parameters

LOG_LEVEL=info

OMADA_URL=https://<omada_ip_address>:<omada_port>
OMADA_SITE_NAME=<your_omada_site_name>
OMADA_CLIENT_ID=<open_api_client_id>
OMADA_CLIENT_SECRET=<open_api_client_secret>
OMADA_USERNAME=<web_ui_username>
OMADA_PASSWORD=<web_ui_password>

LOKI_URL=http://<loki_ip_address>:<loki_port>
LOKI_ENV=prod
LOKI_APP_VERSION=1.0.0

3. Build the Docker image

docker build -t omada_exporter .

4. Run the container

docker run -d \
  --env-file .env \
  -p 8080:8080 \
  --name omada_exporter \
  omada_exporter

5. Configure Prometheus to scrape the data:

scrape_configs:
  - job_name: "Omada"
    static_configs:
      - targets: ["<docker_host_ip>:8080"]
        labels:
          device_name: "<omada_controller_friendly_name>"
    metrics_path: /metrics

6. Import dashboards from Dashboards directory to your Grafana instance.

• OpenAPI Client – Created via: Settings -> Platform Integration. Assign admin role for full API access.
• Service User – Create under: Account section at Global level. Assign viewer role for read-only access.

All configuration values are read from environment variables. These can be provided via a .env file, environment variables in your system, or directly in Docker Compose.

• Switch: SG2218 v1.20
• Router: ER707-M2 v1.0
• Access Point: EAP650(EU) v1.0
• Omada controller: Software Controller v5.15.8.s hosted in Docker container