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