docs/readme.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
   2 .. SPDX-License-Identifier: CC-BY-4.0\r
   3 \r
   4 \r
   5 RIC Measurement Campaign (MC) supported KPIs\r
   6 ============================================\r
   7 \r
   8 name: throughput_ue\r
   9 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
  10 \r
  11 - ULLONG TS\r
  12 - LLONG e_RAB_ID\r
  13 - LLONG UE_ID\r
  14 - V_STR GNB_ID\r
  15 - FLOAT measurementInterval\r
  16 - LLONG active_throughput\r
  17 - LLONG average_throughput\r
  18 - LLONG min_throughput\r
  19 - LLONG max_throughput\r
  20 \r
  21 \r
  22 name: addreq_success_stats\r
  23 description: statistics on the time to successfully make a DC connection\r
  24 \r
  25 - V_STR GNB_ID\r
  26 - ULLONG TS\r
  27 - FLOAT measurementInterval\r
  28 - FLOAT min_success_time\r
  29 - FLOAT max_success_time\r
  30 - FLOAT avg_success_time\r
  31 - FLOAT pctl_05_success_time\r
  32 - FLOAT pctl_95_success_time\r
  33 - FLOAT stddev_success_time\r
  34 \r
  35 \r
  36 name: addreq_pdf_nr_cell\r
  37 description : histogram of neighboring cell RSRP, aggregated by cell id\r
  38 \r
  39 - ULLONG TS\r
  40 - FLOAT measurementInterval\r
  41 - UINT CELL_ID\r
  42 - INT cnt\r
  43 - UINT rsrp_vbad\r
  44 - UINT rsrp_bad\r
  45 - UINT rsrp_medium\r
  46 - UINT rsrp_good\r
  47 - UINT rsrp_vgood\r
  48 \r
  49 \r
  50 name: addreq_pdf_nr_gnb\r
  51 description : histogram of neighboring cell RSRP, aggregated by GNB, as computed from addition request events.\r
  52 \r
  53 - ULLONG TS\r
  54 - FLOAT measurementInterval\r
  55 - V_STR GNB_ID\r
  56 - INT cnt\r
  57 - UINT rsrp_vbad\r
  58 - UINT rsrp_bad\r
  59 - UINT rsrp_medium\r
  60 - UINT rsrp_good\r
  61 - UINT rsrp_vgood\r
  62 \r
  63 \r
  64 name: addreq_stats_nr_cell\r
  65 description : statistics about neighboring cell RSRP aggregated by cell id\r
  66 \r
  67 - ULLONG TS\r
  68 - FLOAT measurementInterval\r
  69 - UINT CELL_ID\r
  70 - INT cnt\r
  71 - INT min_rsrp\r
  72 - INT pctl_05_rsrp\r
  73 - INT median_rsrp\r
  74 - INT pctl_95_rsrp\r
  75 - FLOAT stddev_rsrp\r
  76 - INT max_rsrp\r
  77 \r
  78 \r
  79 name: addreq_stats_nr_gnb\r
  80 description : statistics about neighboring cell RSRP aggregated by GNB, as computed from addition request events.\r
  81 \r
  82 - ULLONG TS\r
  83 - FLOAT measurementInterval\r
  84 - V_STR GNB_ID\r
  85 - INT cnt\r
  86 - INT min_rsrp\r
  87 - INT pctl_05_rsrp\r
  88 - INT median_rsrp\r
  89 - INT pctl_95_rsrp\r
  90 - FLOAT stddev_rsrp\r
  91 - INT max_rsrp\r
  92 \r
  93 \r
  94 name: erab_stats\r
  95 description: number of admitted bearers and the distribution of their qCI\r
  96 \r
  97 - ULLONG TS\r
  98 - FLOAT measurementInterval\r
  99 - INT total_erabs\r
 100 - UINT qCI_1\r
 101 - UINT qCI_2\r
 102 - UINT qCI_3\r
 103 - UINT qCI_4\r
 104 - UINT qCI_5\r
 105 - UINT qCI_6\r
 106 - UINT qCI_7\r
 107 - UINT qCI_8\r
 108 - UINT qCI_9\r
 109 - UINT qCI_other\r
 110 \r
 111 \r
 112 name: mc_connected_cnt\r
 113 description: Number of dual connected users\r
 114 \r
 115 - ULLONG TS\r
 116 - FLOAT measurementInterval\r
 117 - INT count_connected_ue\r
 118 \r
 119 \r
 120 name: mc_connection_stats\r
 121 description : statistics about the length of dual connected sessions\r
 122 \r
 123 - ULLONG TS\r
 124 - FLOAT measurementInterval\r
 125 - FLOAT min_connected_time\r
 126 - FLOAT max_connected_time\r
 127 - FLOAT avg_connected_time\r
 128 - FLOAT pctl_05_connected_time\r
 129 - FLOAT pctl_95_connected_time\r
 130 - FLOAT stddev_connected_time\r
 131 \r
 132 \r
 133 name: mc_connects_cnt\r
 134 description: number of DC connection requests\r
 135 \r
 136 - ULLONG TS\r
 137 - FLOAT measurementInterval\r
 138 - INT count_ue_connects\r
 139 \r
 140 \r
 141 name: mc_disconnects_cnt\r
 142 description: number of DC connection releases\r
 143 \r
 144 - ULLONG TS\r
 145 - FLOAT measurementInterval\r
 146 - INT count_ue_disconnects\r
 147 \r
 148 \r
 149 name: mc_unique_ue_cnt\r
 150 description: Number of distinct UEs making a DC request or release\r
 151 \r
 152 - ULLONG TS\r
 153 - FLOAT measurementInterval\r
 154 - INT count_unique_ue\r
 155 \r
 156 \r
 157 name: mod_req_failure_distribution\r
 158 description: distribution of causes of a modification requet failure\r
 159 \r
 160 - ULLONG TS\r
 161 - FLOAT measurementInterval\r
 162 - INT cnt\r
 163 - UINT count_protobuf_unspecified\r
 164 - UINT count_t310_Expiry\r
 165 - UINT count_randomAccessProblem\r
 166 - UINT count_rlc_MaxNumRetx\r
 167 - UINT count_synchReconfigFailure_SCG\r
 168 - UINT count_scg_reconfigFailure\r
 169 - UINT count_srb3_IntegrityFailure\r
 170 \r
 171 \r
 172 name: reconfig_status_success_rate\r
 173 description: fraction of DC connect requests which are successful\r
 174 \r
 175 - V_STR GNB_ID\r
 176 - ULLONG TS\r
 177 - FLOAT measurementInterval\r
 178 - INT total_reconfiguration_requests\r
 179 - UINT successful_reconfiguration_requests\r
 180 - FLOAT success_rate\r
 181 \r
 182 \r
 183 name: reconfig_status_reject_cause\r
 184 description: distribution of causes for DC rejection\r
 185 \r
 186 - V_STR gnb_id\r
 187 - ULLONG TB\r
 188 - INT total_reconfig_reject\r
 189 - UINT count_radio_network\r
 190 - UINT count_transport\r
 191 - UINT count_protocol\r
 192 - UINT count_misc\r
 193 \r
 194 \r
 195 name: mod_status_refuse_cause\r
 196 description: distribution of causes for a sgnb modification refusal\r
 197 \r
 198 - V_STR GNB_ID\r
 199 - ULLONG TS\r
 200 - FLOAT measurementInterval\r
 201 - INT total_reconfig_refuse\r
 202 - UINT count_radio_network\r
 203 - UINT count_transport\r
 204 - UINT count_protocol\r
 205 - UINT count_misc\r
 206 \r
 207 \r
 208 name: release_cause\r
 209 description: distribution of the causes of a DC release\r
 210 \r
 211 - V_STR GNB_ID\r
 212 - ULLONG TS\r
 213 - FLOAT measurementInterval\r
 214 - INT total_reconfig_refuse\r
 215 - UINT count_radio_network\r
 216 - UINT count_transport\r
 217 - UINT count_protocol\r
 218 - UINT count_misc\r
 219 \r
 220 \r
 221 name: release_req_success_stats\r
 222 description: statistics on the time to delease a DC connection\r
 223 \r
 224 - V_STR GNB_ID\r
 225 - ULLONG TS\r
 226 - FLOAT measurementInterval\r
 227 - FLOAT min_success_time\r
 228 - FLOAT max_success_time\r
 229 - FLOAT avg_success_time\r
 230 - FLOAT pctl_05_success_time\r
 231 - FLOAT pctl_95_success_time\r
 232 - FLOAT stddev_success_time\r
 233 \r
 234 \r
 235 name: rrcx_pdf_neigh_cell_csi\r
 236 description: distribution of the beam csi rsrp of neighboring cells, aggregated by cell id, computed from rrc transfer\r
 237 \r
 238 - ULLONG TS\r
 239 - FLOAT measurementInterval\r
 240 - UINT CELL_ID\r
 241 - INT cnt\r
 242 - UINT rsrp_vbad\r
 243 - UINT rsrp_bad\r
 244 - UINT rsrp_medium\r
 245 - UINT rsrp_good\r
 246 - UINT rsrp_vgood\r
 247 \r
 248 \r
 249 name: rrcx_pdf_neigh_gnb_csi\r
 250 description: distribution of the beam csi rsrp of neighboring cells, aggregated by gNB, computed from rrc transfer\r
 251 \r
 252 - ULLONG TS\r
 253 - FLOAT measurementInterval\r
 254 - V_STR GNB_ID\r
 255 - INT cnt\r
 256 - UINT rsrp_vbad\r
 257 - UINT rsrp_bad\r
 258 - UINT rsrp_medium\r
 259 - UINT rsrp_good\r
 260 - UINT rsrp_vgood\r
 261 \r
 262 \r
 263 name: rrcx_pdf_neigh_cell_ssb\r
 264 description: distribution of the beam ssb rsrp of neighboring cells, aggregated by cell id, computed from rrc transfer\r
 265 \r
 266 - ULLONG TS\r
 267 - FLOAT measurementInterval\r
 268 - UINT CELL_ID\r
 269 - INT cnt\r
 270 - UINT rsrp_vbad\r
 271 - UINT rsrp_bad\r
 272 - UINT rsrp_medium\r
 273 - UINT rsrp_good\r
 274 - UINT rsrp_vgood\r
 275 \r
 276 \r
 277 name: rrcx_pdf_neigh_gnb_ssb\r
 278 description: distribution of the beam ssb rsrp of neighboring cells, aggregated by gNB, computed from rrc transfer\r
 279 \r
 280 - ULLONG TS\r
 281 - FLOAT measurementInterval\r
 282 - V_STR GNB_ID\r
 283 - INT cnt\r
 284 - UINT rsrp_vbad\r
 285 - UINT rsrp_bad\r
 286 - UINT rsrp_medium\r
 287 - UINT rsrp_good\r
 288 - UINT rsrp_vgood\r
 289 \r
 290 \r
 291 name: rrcx_pdf_serv_cell\r
 292 description: distribution of the  ssb rsrp of serving cell aggregated by cell id, computed from rrc transfer\r
 293 \r
 294 - ULLONG TS\r
 295 - FLOAT measurementInterval\r
 296 - UINT CELL_ID\r
 297 - INT cnt\r
 298 - UINT rsrp_vbad\r
 299 - UINT rsrp_bad\r
 300 - UINT rsrp_medium\r
 301 - UINT rsrp_good\r
 302 - UINT rsrp_vgood\r
 303 \r
 304 \r
 305 name: rrcx_pdf_neighbor_cell\r
 306 description: distribution of the  ssb rsrp of neighbor cells aggregated by cell id, computed from rrc transfer\r
 307 \r
 308 - ULLONG TS\r
 309 - FLOAT measurementInterval\r
 310 - UINT CELL_ID\r
 311 - INT cnt\r
 312 - UINT rsrp_vbad\r
 313 - UINT rsrp_bad\r
 314 - UINT rsrp_medium\r
 315 - UINT rsrp_good\r
 316 - UINT rsrp_vgood\r
 317 \r
 318 \r
 319 name: rrcx_pdf_serv_gnb\r
 320 description: distribution of the  ssb rsrp of serving cell aggregated by gnb, computed from rrc transfer\r
 321 \r
 322 - ULLONG TS\r
 323 - FLOAT measurementInterval\r
 324 - V_STR GNB_ID\r
 325 - INT cnt\r
 326 - UINT rsrp_vbad\r
 327 - UINT rsrp_bad\r
 328 - UINT rsrp_medium\r
 329 - UINT rsrp_good\r
 330 - UINT rsrp_vgood\r
 331 \r
 332 \r
 333 name: rrcx_pdf_neighbor_gnb\r
 334 description: distribution of the  ssb rsrp of serving cell aggregated by cell id, computed from rrc transfer\r
 335 \r
 336 - ULLONG TS\r
 337 - FLOAT measurementInterval\r
 338 - V_STR GNB_ID\r
 339 - INT cnt\r
 340 - UINT rsrp_vbad\r
 341 - UINT rsrp_bad\r
 342 - UINT rsrp_medium\r
 343 - UINT rsrp_good\r
 344 - UINT rsrp_vgood\r
 345 \r
 346 \r
 347 name: rrcx_stats_neigh_cell\r
 348 description: statistics on ssb RSRP on the beams of nrighboring cells, aggregated by cell ID, computed using rrc transfer\r
 349 \r
 350 - ULLONG TS\r
 351 - FLOAT measurementInterval\r
 352 - UINT CELL_ID\r
 353 - INT cnt\r
 354 - INT min_rsrp\r
 355 - INT pctl_05_rsrp\r
 356 - INT median_rsrp\r
 357 - INT pctl_95_rsrp\r
 358 - FLOAT stddev_rsrp\r
 359 - INT max_rsrp\r
 360 \r
 361 \r
 362 name: rrcx_stats_neigh_gnb\r
 363 description: statistics on ssb RSRP on the beams of nrighboring cells, aggregated by gNB, computed using rrc transfer\r
 364 \r
 365 - ULLONG TS\r
 366 - FLOAT measurementInterval\r
 367 - V_STR GNB_ID\r
 368 - INT cnt\r
 369 - INT min_rsrp\r
 370 - INT pctl_05_rsrp\r
 371 - INT median_rsrp\r
 372 - INT pctl_95_rsrp\r
 373 - FLOAT stddev_rsrp\r
 374 - INT max_rsrp\r
 375 \r
 376 \r
 377 name: rrcx_stats_serv_cell\r
 378 description: statistics on the ssb rsrp of the serving cell, aggregated by cell id, computed using rrc transfer\r
 379 \r
 380 - ULLONG TS\r
 381 - FLOAT measurementInterval\r
 382 - UINT CELL_ID\r
 383 - INT cnt\r
 384 - INT min_rsrp\r
 385 - INT pctl_05_rsrp\r
 386 - INT median_rsrp\r
 387 - INT pctl_95_rsrp\r
 388 - FLOAT stddev_rsrp\r
 389 - INT max_rsrp\r
 390 \r
 391 \r
 392 name: rrcx_stats_neighbor_cell\r
 393 description: statistics on the ssb rsrp of the neighbor cells, aggregated by cell id, computed using rrc transfer\r
 394 \r
 395 - ULLONG TS\r
 396 - FLOAT measurementInterval\r
 397 - UINT CELL_ID\r
 398 - INT cnt\r
 399 - INT min_rsrp\r
 400 - INT pctl_05_rsrp\r
 401 - INT median_rsrp\r
 402 - INT pctl_95_rsrp\r
 403 - FLOAT stddev_rsrp\r
 404 - INT max_rsrp\r
 405 \r
 406 \r
 407 name: rrcx_stats_serv_gnb\r
 408 description: statistics on the ssb srp of the serving cell, aggregated by gNB, computed using rrc transfer\r
 409 \r
 410 - ULLONG TS\r
 411 - FLOAT measurementInterval\r
 412 - V_STR GNB_ID\r
 413 - INT cnt\r
 414 - INT min_rsrp\r
 415 - INT pctl_05_rsrp\r
 416 - INT median_rsrp\r
 417 - INT pctl_95_rsrp\r
 418 - FLOAT stddev_rsrp\r
 419 - INT max_rsrp\r
 420 \r
 421 \r
 422 name: rrcx_stats_neighbor_gnb\r
 423 description: statistics on the ssb rsrp of the neighbor cells, aggregated by gNB, computed using rrc transfer\r
 424 \r
 425 - ULLONG TS\r
 426 - FLOAT measurementInterval\r
 427 - V_STR GNB_ID\r
 428 - INT cnt\r
 429 - INT min_rsrp\r
 430 - INT pctl_05_rsrp\r
 431 - INT median_rsrp\r
 432 - INT pctl_95_rsrp\r
 433 - FLOAT stddev_rsrp\r
 434 - INT max_rsrp\r
 435 \r
 436 \r
 437 name: throughput_rollup\r
 438 description: statistics on the per-UE throughput\r
 439 \r
 440 - ULLONG TS\r
 441 - LLONG e_RAB_ID\r
 442 - V_STR GNB_ID\r
 443 - FLOAT measurementInterval\r
 444 - INT count_ues\r
 445 - UINT average_throughput_percentile_05\r
 446 - UINT average_throughput_percentile_50\r
 447 - FLOAT average_average_throughput\r
 448 - UINT average_throughput_percentile_95\r
 449 - UINT active_throughput_percentile_05\r
 450 - UINT active_throughput_percentile_50\r
 451 - FLOAT average_active_throughput\r
 452 - UINT active_throughput_percentile_95\r
 453 \r
 454 \r
 455 name: throughput_gnb\r
 456 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
 457 \r
 458 - ULLONG TS\r
 459 - LLONG e_RAB_ID\r
 460 - V_STR GNB_ID\r
 461 - FLOAT measurementInterval\r
 462 - LLONG active_throughput\r
 463 - LLONG average_throughput\r
 464 - LLONG min_throughput\r
 465 - LLONG max_throughput\r
 466 - UINT extr_quant_hfta0_fcn_quant_udaf_hfta0\r
 467 - UINT extr_quant_hfta0_fcn_quant_udaf_hfta01\r
 468 \r
 469 \r
 470 \r