Support for 5G metrics

[Kaleem-Wavelabs]

Proposal: Support for 5G metrics

Elevator Pitch

Magma 5G SA is required to support 5G metrics to provide monitoring capabilities. Refer to REQ-SW-08 of TIP OCN FWA requirements specification.

5G Metrics indicate the overall non functional attributes of Magma AGW such as connected devices, mobility, throughput, performance, reliability, etc. These metrics are regularly pushed into prometheus, which along with grafana enables us to store and query these metrics.

Based on the Magma 5G metrics, a number of decisions can be made at orc8r level such as triggering alerts for threshold values to troubleshoot the issues at operator end, and scale-in/scale-out AGW decisions to cater to wider requirements, etc.

Total ask

Support Magma 5G metrics will be delivered at a total cost of: $60000

Contact Information

Kaleemullah Mohammed (kaleemullah.mohammed@wavelabs.ai)

Project Details

A metric in Magma deployments may originate at gateways (AGW, FeG, etc.) and travels through the Orc8r and is eventually displayed on the NMS UI. All the metrics are stored in prometheus for a default of 30 days.

Current metrics framework for LTE can be leveraged upon to support for magma 5G.

On the AGW, metrics are collected and exported from Python and C++ services.

Mainly metrics are categorized into:

• prometheus metrics (process, memory, cpu, fd, etc.)
• gateway failures/alerts
• sctp
• UE Registration Request metrics
• Service Request metrics
• Registration failures
• Service failures
• subscriberdb
• gNB metrics
• magmad
• pipelined
• mobilityd

Feature Roadmap

Feature will be delivered in 3 milestones. Each milestone will have the following 5 process gates

1. Design
2. Development & Unit Testing
3. code review
4. Integration testing
5. resolve integration issues and regression issues
   Before finishing the 2nd milestone, the feature shall pass the following process gates
6. System test
7. User Acceptance test

MileStone 1

Collection and export

• On the AGW, 5G metrics are needed to defined, collect and export from Python and C++ services.

MileStone 2

Orchestrator and Prometheus

• To extend the support service present in the Orc8r and pushes metrics over gRPC to Prometheus Edge Hub.

MileStone 3

NMS and Grafana

• NMS dashboard which connects to the Grafana Data Source API, which proxies the parameterized metric request to Prometheus and displays the retrieved metrics.

Test plan

UT and validation of Magma 5G AGW metrics
Integration testing AGW, orc8r and NMS

Feature Roadmap

Feature will be delivered in 3 Milestones.

MS	DELIVERABLES
M1.0	AGW metrics collection and export
M2.0	Orchestrator and Prometheus
M3.0	NMS and Grafana

References

https://docs.magmacore.org/docs/nms/metrics