Adding additional KPIs, adding required documentation
[ric-app/mc.git] / docs / readme.rst
diff --git a/docs/readme.rst b/docs/readme.rst
new file mode 100644 (file)
index 0000000..3b84a97
--- /dev/null
@@ -0,0 +1,469 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
+.. SPDX-License-Identifier: CC-BY-4.0\r
+\r
+\r
+RIC Measurement Campaign (MC) supported KPIs\r
+============================================\r
+\r
+name: throughput_ue\r
+description: throughput experienced by UE over a measurement interval. "Active" throughput is throughput while actively downloading, "average" averages bytes transfered over the measurement interval\r
+- ULLONG TS\r
+- LLONG e_RAB_ID\r
+- LLONG UE_ID\r
+- V_STR GNB_ID\r
+- FLOAT measurementInterval\r
+- LLONG active_throughput\r
+- LLONG average_throughput\r
+- LLONG min_throughput\r
+- LLONG max_throughput\r
+\r
+\r
+name: addreq_success_stats\r
+description: statistics on the time to successfully make a DC connection\r
+\r
+- V_STR GNB_ID\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- FLOAT min_success_time\r
+- FLOAT max_success_time\r
+- FLOAT avg_success_time\r
+- FLOAT pctl_05_success_time\r
+- FLOAT pctl_95_success_time\r
+- FLOAT stddev_success_time\r
+\r
+\r
+name: addreq_pdf_nr_cell\r
+description : histogram of neighboring cell RSRP, aggregated by cell id\r
+\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- UINT CELL_ID\r
+- INT cnt\r
+- UINT rsrp_vbad\r
+- UINT rsrp_bad\r
+- UINT rsrp_medium\r
+- UINT rsrp_good\r
+- UINT rsrp_vgood\r
+\r
+\r
+name: addreq_pdf_nr_gnb\r
+description : histogram of neighboring cell RSRP, aggregated by GNB, as computed from addition request events.\r
+\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- V_STR GNB_ID\r
+- INT cnt\r
+- UINT rsrp_vbad\r
+- UINT rsrp_bad\r
+- UINT rsrp_medium\r
+- UINT rsrp_good\r
+- UINT rsrp_vgood\r
+\r
+\r
+name: addreq_stats_nr_cell\r
+description : statistics about neighboring cell RSRP aggregated by cell id\r
+\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- UINT CELL_ID\r
+- INT cnt\r
+- INT min_rsrp\r
+- INT pctl_05_rsrp\r
+- INT median_rsrp\r
+- INT pctl_95_rsrp\r
+- FLOAT stddev_rsrp\r
+- INT max_rsrp\r
+\r
+\r
+name: addreq_stats_nr_gnb\r
+description : statistics about neighboring cell RSRP aggregated by GNB, as computed from addition request events.\r
+\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- V_STR GNB_ID\r
+- INT cnt\r
+- INT min_rsrp\r
+- INT pctl_05_rsrp\r
+- INT median_rsrp\r
+- INT pctl_95_rsrp\r
+- FLOAT stddev_rsrp\r
+- INT max_rsrp\r
+\r
+\r
+name: erab_stats\r
+description: number of admitted bearers and the distribution of their qCI\r
+\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- INT total_erabs\r
+- UINT qCI_1\r
+- UINT qCI_2\r
+- UINT qCI_3\r
+- UINT qCI_4\r
+- UINT qCI_5\r
+- UINT qCI_6\r
+- UINT qCI_7\r
+- UINT qCI_8\r
+- UINT qCI_9\r
+- UINT qCI_other\r
+\r
+\r
+name: mc_connected_cnt\r
+description: Number of dual connected users\r
+\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- INT count_connected_ue\r
+\r
+\r
+name: mc_connection_stats\r
+description : statistics about the length of dual connected sessions\r
+\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- FLOAT min_connected_time\r
+- FLOAT max_connected_time\r
+- FLOAT avg_connected_time\r
+- FLOAT pctl_05_connected_time\r
+- FLOAT pctl_95_connected_time\r
+- FLOAT stddev_connected_time\r
+\r
+\r
+name: mc_connects_cnt\r
+description: number of DC connection requests\r
+\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- INT count_ue_connects\r
+\r
+\r
+name: mc_disconnects_cnt\r
+description: number of DC connection releases\r
+\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- INT count_ue_disconnects\r
+\r
+\r
+name: mc_unique_ue_cnt\r
+description: Number of distinct UEs making a DC request or release\r
+\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- INT count_unique_ue\r
+\r
+\r
+name: mod_req_failure_distribution\r
+description: distribution of causes of a modification requet failure\r
+\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- INT cnt\r
+- UINT count_protobuf_unspecified\r
+- UINT count_t310_Expiry\r
+- UINT count_randomAccessProblem\r
+- UINT count_rlc_MaxNumRetx\r
+- UINT count_synchReconfigFailure_SCG\r
+- UINT count_scg_reconfigFailure\r
+- UINT count_srb3_IntegrityFailure\r
+\r
+\r
+name: reconfig_status_success_rate\r
+description: fraction of DC connect requests which are successful\r
+\r
+- V_STR GNB_ID\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- INT total_reconfiguration_requests\r
+- UINT successful_reconfiguration_requests\r
+- FLOAT success_rate\r
+\r
+\r
+name: reconfig_status_reject_cause\r
+description: distribution of causes for DC rejection\r
+\r
+- V_STR gnb_id\r
+- ULLONG TB\r
+- INT total_reconfig_reject\r
+- UINT count_radio_network\r
+- UINT count_transport\r
+- UINT count_protocol\r
+- UINT count_misc\r
+\r
+\r
+name: mod_status_refuse_cause\r
+description: distribution of causes for a sgnb modification refusal\r
+\r
+- V_STR GNB_ID\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- INT total_reconfig_refuse\r
+- UINT count_radio_network\r
+- UINT count_transport\r
+- UINT count_protocol\r
+- UINT count_misc\r
+\r
+\r
+name: release_cause\r
+description: distribution of the causes of a DC release\r
+\r
+- V_STR GNB_ID\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- INT total_reconfig_refuse\r
+- UINT count_radio_network\r
+- UINT count_transport\r
+- UINT count_protocol\r
+- UINT count_misc\r
+\r
+\r
+name: release_req_success_stats\r
+description: statistics on the time to delease a DC connection\r
+\r
+- V_STR GNB_ID\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- FLOAT min_success_time\r
+- FLOAT max_success_time\r
+- FLOAT avg_success_time\r
+- FLOAT pctl_05_success_time\r
+- FLOAT pctl_95_success_time\r
+- FLOAT stddev_success_time\r
+\r
+\r
+name: rrcx_pdf_neigh_cell_csi\r
+description: distribution of the beam csi rsrp of neighboring cells, aggregated by cell id, computed from rrc transfer\r
+\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- UINT CELL_ID\r
+- INT cnt\r
+- UINT rsrp_vbad\r
+- UINT rsrp_bad\r
+- UINT rsrp_medium\r
+- UINT rsrp_good\r
+- UINT rsrp_vgood\r
+\r
+\r
+name: rrcx_pdf_neigh_gnb_csi\r
+description: distribution of the beam csi rsrp of neighboring cells, aggregated by gNB, computed from rrc transfer\r
+\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- V_STR GNB_ID\r
+- INT cnt\r
+- UINT rsrp_vbad\r
+- UINT rsrp_bad\r
+- UINT rsrp_medium\r
+- UINT rsrp_good\r
+- UINT rsrp_vgood\r
+\r
+\r
+name: rrcx_pdf_neigh_cell_ssb\r
+description: distribution of the beam ssb rsrp of neighboring cells, aggregated by cell id, computed from rrc transfer\r
+\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- UINT CELL_ID\r
+- INT cnt\r
+- UINT rsrp_vbad\r
+- UINT rsrp_bad\r
+- UINT rsrp_medium\r
+- UINT rsrp_good\r
+- UINT rsrp_vgood\r
+\r
+\r
+name: rrcx_pdf_neigh_gnb_ssb\r
+description: distribution of the beam ssb rsrp of neighboring cells, aggregated by gNB, computed from rrc transfer\r
+\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- V_STR GNB_ID\r
+- INT cnt\r
+- UINT rsrp_vbad\r
+- UINT rsrp_bad\r
+- UINT rsrp_medium\r
+- UINT rsrp_good\r
+- UINT rsrp_vgood\r
+\r
+\r
+name: rrcx_pdf_serv_cell\r
+description: distribution of the  ssb rsrp of serving cell aggregated by cell id, computed from rrc transfer\r
+\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- UINT CELL_ID\r
+- INT cnt\r
+- UINT rsrp_vbad\r
+- UINT rsrp_bad\r
+- UINT rsrp_medium\r
+- UINT rsrp_good\r
+- UINT rsrp_vgood\r
+\r
+\r
+name: rrcx_pdf_neighbor_cell\r
+description: distribution of the  ssb rsrp of neighbor cells aggregated by cell id, computed from rrc transfer\r
+\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- UINT CELL_ID\r
+- INT cnt\r
+- UINT rsrp_vbad\r
+- UINT rsrp_bad\r
+- UINT rsrp_medium\r
+- UINT rsrp_good\r
+- UINT rsrp_vgood\r
+\r
+\r
+name: rrcx_pdf_serv_gnb\r
+description: distribution of the  ssb rsrp of serving cell aggregated by gnb, computed from rrc transfer\r
+\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- V_STR GNB_ID\r
+- INT cnt\r
+- UINT rsrp_vbad\r
+- UINT rsrp_bad\r
+- UINT rsrp_medium\r
+- UINT rsrp_good\r
+- UINT rsrp_vgood\r
+\r
+\r
+name: rrcx_pdf_neighbor_gnb\r
+description: distribution of the  ssb rsrp of serving cell aggregated by cell id, computed from rrc transfer\r
+\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- V_STR GNB_ID\r
+- INT cnt\r
+- UINT rsrp_vbad\r
+- UINT rsrp_bad\r
+- UINT rsrp_medium\r
+- UINT rsrp_good\r
+- UINT rsrp_vgood\r
+\r
+\r
+name: rrcx_stats_neigh_cell\r
+description: statistics on ssb RSRP on the beams of nrighboring cells, aggregated by cell ID, computed using rrc transfer\r
+\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- UINT CELL_ID\r
+- INT cnt\r
+- INT min_rsrp\r
+- INT pctl_05_rsrp\r
+- INT median_rsrp\r
+- INT pctl_95_rsrp\r
+- FLOAT stddev_rsrp\r
+- INT max_rsrp\r
+\r
+\r
+name: rrcx_stats_neigh_gnb\r
+description: statistics on ssb RSRP on the beams of nrighboring cells, aggregated by gNB, computed using rrc transfer\r
+\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- V_STR GNB_ID\r
+- INT cnt\r
+- INT min_rsrp\r
+- INT pctl_05_rsrp\r
+- INT median_rsrp\r
+- INT pctl_95_rsrp\r
+- FLOAT stddev_rsrp\r
+- INT max_rsrp\r
+\r
+\r
+name: rrcx_stats_serv_cell\r
+description: statistics on the ssb rsrp of the serving cell, aggregated by cell id, computed using rrc transfer\r
+\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- UINT CELL_ID\r
+- INT cnt\r
+- INT min_rsrp\r
+- INT pctl_05_rsrp\r
+- INT median_rsrp\r
+- INT pctl_95_rsrp\r
+- FLOAT stddev_rsrp\r
+- INT max_rsrp\r
+\r
+\r
+name: rrcx_stats_neighbor_cell\r
+description: statistics on the ssb rsrp of the neighbor cells, aggregated by cell id, computed using rrc transfer\r
+\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- UINT CELL_ID\r
+- INT cnt\r
+- INT min_rsrp\r
+- INT pctl_05_rsrp\r
+- INT median_rsrp\r
+- INT pctl_95_rsrp\r
+- FLOAT stddev_rsrp\r
+- INT max_rsrp\r
+\r
+\r
+name: rrcx_stats_serv_gnb\r
+description: statistics on the ssb srp of the serving cell, aggregated by gNB, computed using rrc transfer\r
+\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- V_STR GNB_ID\r
+- INT cnt\r
+- INT min_rsrp\r
+- INT pctl_05_rsrp\r
+- INT median_rsrp\r
+- INT pctl_95_rsrp\r
+- FLOAT stddev_rsrp\r
+- INT max_rsrp\r
+\r
+\r
+name: rrcx_stats_neighbor_gnb\r
+description: statistics on the ssb rsrp of the neighbor cells, aggregated by gNB, computed using rrc transfer\r
+\r
+- ULLONG TS\r
+- FLOAT measurementInterval\r
+- V_STR GNB_ID\r
+- INT cnt\r
+- INT min_rsrp\r
+- INT pctl_05_rsrp\r
+- INT median_rsrp\r
+- INT pctl_95_rsrp\r
+- FLOAT stddev_rsrp\r
+- INT max_rsrp\r
+\r
+\r
+name: throughput_rollup\r
+description: statistics on the per-UE throughput\r
+\r
+- ULLONG TS\r
+- LLONG e_RAB_ID\r
+- V_STR GNB_ID\r
+- FLOAT measurementInterval\r
+- INT count_ues\r
+- UINT average_throughput_percentile_05\r
+- UINT average_throughput_percentile_50\r
+- FLOAT average_average_throughput\r
+- UINT average_throughput_percentile_95\r
+- UINT active_throughput_percentile_05\r
+- UINT active_throughput_percentile_50\r
+- FLOAT average_active_throughput\r
+- UINT active_throughput_percentile_95\r
+\r
+\r
+name: throughput_gnb\r
+description: throughput experienced by a GNB over a measurement interval. "Active" throughput is throughput while actively downloading, "average" averages bytes transfered over the measurement interval\r
+\r
+- ULLONG TS\r
+- LLONG e_RAB_ID\r
+- V_STR GNB_ID\r
+- FLOAT measurementInterval\r
+- LLONG active_throughput\r
+- LLONG average_throughput\r
+- LLONG min_throughput\r
+- LLONG max_throughput\r
+- UINT extr_quant_hfta0_fcn_quant_udaf_hfta0\r
+- UINT extr_quant_hfta0_fcn_quant_udaf_hfta01\r
+\r
+\r
+\r