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