Prometheus Exporter for TP-Link Omada SDN.
It is containerized FastAPI based application to expose basic network devices' metrics for Prometheus Server to scrape.
Omada controller is queried when /metrics endpoint is accessed,
which means that if this exporter is not in use it do not generate traffic to omada controller.
Due to current limitations of Omada OpenAPI, both Web API and OpenAPI are supported.
Find available exporter's metrics here
Dashboards are available for import here
- Create the
.envfile to provide necessary values specified in Parameters section. - Build docker image using
docker compose build - Start docker compose using
docker compose up -d - Metrics will be available at
http://<your_hostname>:51772/metrics
Important
.envfile filled with data from table should be saved in./appdirectory before building docker image.
| Name | Description |
|---|---|
BASE_URL |
The URL to Omada portal, including protocol and port. Both http and https are supported |
VERIFY_CERTIFICATE |
Mostly related to HTTPS if you are using untrusted certificate |
SITE_NAME |
Name of the site to monitor |
OMADA_CLIENT_ID |
Client ID for app created in section Platform Integration, used for OpenAPI requests |
OMADA_CLIENT_SECRET |
Client Secret for app created in section Platform Integration, used for OpenAPI requests |
OMADA_USER |
User name of the account which will be used to authenticate to the WebAPI |
OMADA_USER_PASSWORD |
Password for the account which will be used to authenticate to the WebAPI |
- OpenAPI Application (OMADA_CLIENT) - It can be created at the Global management level of the controller in path:
Settings -> Platform Integration. OpenApi app needs administrator role assigned, to be able to query all endpoints used within this exporter - User Account (OMADA_USER) - it is a standard user account ,
which can be created at Global management level of the controller,
in path:
Account.viewerrole will provide enough access for this "service" user account.
- Switch: SG2218 v1.20
- Router: ER707-M2 v1.0
- Access Point: EAP650(EU) v1.0
- Omada controller: Software Controller v5.13 hosted in Docker container