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.

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.

Building

To build the microservice from source, please follow the instructions in here

Docker

To use the CLoudSDK deployment please follow here

Expected directory layout

From the directory where your cloned source is, you will need to create the certs, logs, and uploads directories.

mkdir certs
mkdir certs/cas
mkdir logs
mkdir uploads

You should now have the following:

--+-- certs
  |   +--- cas
  +-- cmake
  +-- cmake-build
  +-- logs
  +-- src
  +-- test_scripts
  +-- openapi
  +-- uploads
  +-- owsec.properties

Certificate

The OWANALYTICS uses a certificate to provide security for the REST API Certificate to secure the Northbound API.

The certs directory

For all deployments, you will need the following certs directory, populated with the proper files.

certs ---+--- restapi-ca.pem
         +--- restapi-cert.pem
         +--- restapi-key.pem

Firewall Considerations

Port	Description	Configurable
16005	Default port for REST API Access to the OWANALYTICS	yes

Environment variables

The following environment variables should be set from the root directory of the service. They tell the OWANALYTICS process where to find the configuration and the root directory.

export OWANALYTICS_ROOT=`pwd`
export OWANALYTICS_CONFIG=`pwd`

You can run the shell script set_env.sh from the microservice root.

OWANALYTICS Service Configuration

The configuration is kept in a file called owanalytics.properties. To understand the content of this file, please look here

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