OpenWiFI Analytics Service (OWANALYTICS)
What is it?
The OpenWiFi Analytics Service is a service for the TIP OpenWiFi CloudSDK (OWSDK). OWANALYTICS gathers statistics about device used in OpenWiFI and groups them according to their provisioning (OWPROV) entities or venues. OWANALYTICS, like all other OWSDK microservices, is defined using an OpenAPI definition and uses the ucentral communication protocol to interact with Access Points. To use the OWANALYTICS, you either need to build it or use the Docker version.
Building
To build the microservice from source, please follow the instructions in here
Docker
To use the CLoudSDK deployment please follow here
OWANALYTICS Service Configuration
The configuration is kept in a file called owanalytics.properties. To understand the content of this file,
please look here
OpenAPI
You may get static page with OpenAPI docs generated from the definition on GitHub Page.
Also, you may use Swagger UI with OpenAPI definition file raw link (i.e. latest version file) to get interactive docs page.
Firewall Considerations
| Port | Description | Configurable |
|---|---|---|
| 16005 | Default port for REST API Access to the OWPROV | yes |
Kafka topics
Toe read more about Kafka, follow the document
Contributions
We need more contributors. Should you wish to contribute, please follow the contributions document.
Pull Requests
Please create a branch with the Jira addressing the issue you are fixing or the feature you are implementing. Create a pull-request from the branch into master.
Additional OWSDK Microservices
Here is a list of additional OWSDK microservices
| Name | Description | Link | OpenAPI |
|---|---|---|---|
| OWSEC | Security Service | here | here |
| OWGW | Controller Service | here | here |
| OWFMS | Firmware Management Service | here | here |
| OWPROV | Provisioning Service | here | here |
| OWANALYTICS | Analytics Service | here | here |
| OWSUB | Subscriber Service | here | here |