docs/readme.rst

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