[Issue-Id:RICAPP-204] Bump version to 1.0.0 and push to staging area
[ric-app/ad.git] / docs / overview.rst
1
2 Anomaly Detection Overview
3 ==========================
4
5 Anomaly Detection (AD) is an Xapp in the Traffic Steering O-RAN use case,
6 which perfrom the following tasks:
7
8 #. Data will be inserted into influxDB when xApp starts. This will be removed in Future when data will be coming via KPIMON to influxDB.
9 #. AD, which iterates per 10 mili-second, fetches UE information from databse and send prediction to Traffic Steering
10 #. Traffic Steering send acknowldgement back to AD.
11
12 Expected Input
13 --------------
14
15 The AD Xapp expects input in following structure:
16
17   {
18   'du-id' : 1003,
19   'nrCellIdentity' : "c3/B13",
20   'prb_usage' : 23.0, 
21   'rsrp' : 84.0, 
22   'rsrq' : 65.0, 
23   'rssinr':65.0,
24   'targetTput' : 0.1, 
25   'throughput' : , 
26   'ue-id' : "Waiting passenger 1", 
27   'x' : -556, 
28   'y' : -1160, 
29   'measTimeStampRf' : "2021-05-12T07:43:51.652" 
30   }
31
32 Expected Output
33 ---------------
34
35 The AD Xapp should Detect Anomulous UE's and send those UE's information
36 as a JSON message via RMR with the following structure:
37
38   {
39   'ue-id' : "Waiting passenger 1",
40   'measTimeStampRf' : "2021-05-12T07:43:51.652",
41   'du-id' : 1003,
42   'Degradation': "RSRP RSSINR"
43   }