Skip to content
 
 

Latest commit

 

History

537 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

TIP OpenWiFi Logo              Mango Cloud Logo

OpenWiFi Analytics Service (OWANALYTICS)

Overview

The OpenWiFi Analytics Service (OWANALYTICS) is a core microservice within the Telecom Infra Project (TIP) OpenWiFi CloudSDK (OWSDK) ecosystem.

OWANALYTICS gathers real-time statistics and telemetry reports from connected devices, aggregating metrics (like CPU load, memory usage, radio noise, and client associations) and grouping them logically according to their provisioning entities or venues.

Role in Mango Cloud

This service is part of Mango Cloud, Router Architects’ open-source platform for managed Wi-Fi and connectivity operations.

Within Mango Cloud, OWANALYTICS serves as the central Device Analytics & Telemetry Aggregator.

Key integrations include:

  • AP Status Tracker: Listens to periodic status/telemetry payloads sent by Access Points via the Controller Service (owgw).
  • KPI Metrics Calculator: Aggregates CPU load, memory, temperature, and channel noise profiles, grouping them by MDU property or venue to generate historical graphs.
  • Client Association Logger: Records client connection history, data bandwidth (Rx/Tx bytes), signal strengths (RSSI), and MCS rates across 2G/5G/6G radio bands.
  • Intra-Microservice Auth: Uses access tokens issued by the Security Service (owsec) to secure telemetry validation APIs.

Resources

Telemetry Guides

OpenAPI

The OpenAPI definition is available directly in the GitHub repository. You can load the raw OpenAPI definition file into Swagger UI to view interactive API docs.

Building

To build the microservice from source, please follow the instructions in BUILDING.md.

Docker

To run this service as part of the CloudSDK containerized deployment, refer to the mango-cloud-deployment repository instructions.

Firewall Considerations

The microservice exposes three main network interfaces. Ensure your firewall or container ingress rules are configured accordingly:

Port Description Configurable
16009 Default port for public REST API Access to the OWANALYTICS yes
17009 Default port for internal REST API Access (intra-service communications) yes
16109 Default port for Application Load Balancer (ALB) Health Checks yes

OWANALYTICS Service Configuration

All configuration parameters are stored in the owanalytics.properties file. For a complete guide to all available properties, check CONFIGURATION.md.

Kafka topics

The service uses Kafka to ingest device telemetry payloads and coordinate with other microservices. To read more about the Kafka integration, review KAFKA.md.

Contributions

We welcome and appreciate community contributions. Please review CONTRIBUTING.md to get started.

Pull Requests

When submitting pull requests:

  1. Create a branch named after the JIRA issue you are resolving or the feature you are implementing.
  2. Submit your pull request targeting the main branch.

Additional OWSDK Microservices

Here is the index of additional OpenWiFi 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 Portal Service here here
NW-Topology Network Topology Service here here

About

Analytics and telemetry service for Mango Cloud, Router Architects’ open-source OpenLAN/OpenWiFi managed Wi-Fi platform and cloud controller.

Topics

Resources

Contributing

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages