Merge "Release 1.0.1"
[scp/ric-app/kpimon.git] / docs / overview.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. Copyright (C) 2020 AT&T Intellectual Property
4
5 KPIMON Overview
6 ==================
7
8 KPIMON is an Xapp in the traffic steering O-RAN use case.
9 There are four total Xapps:
10
11 1. Traffic steering, which sends "prediction requests" to QP Driver
12
13 2. QP Driver which fetches data from SDL[4] on behalf of traffic steering, both UE Data and Cell Data, merges that data together, then sends off the data to the QP Predictor
14
15 3. QP Predictor which predicts and sends that prediction back to Traffic Steering
16
17 4. KPIMONN which collects UE/Cell metrics from base station and populates SDL in the first place  (this)
18
19 So in summary, the KPIMON xapp is a helper function that receives RAN metrics and write to SDL