22. Kafka

22.1 Heartbeats⚓︎

Description : Both the Layer 2 and Layer3 of each cell send out heartbeats to report that they are alive.

The Layer 2 heartbeats has the following format:

Kafka topic : **Kafka topic :**accelleran.drax.4g.ric.raw.service_discovery `

{
  "ENB": <string>,
  "ueDraxId": <string>,
  "ueRicId": <string>,
  "EnbL2ServiceHeartbeat": {
    "HeartbeatInfo": {
      "ComponentId": <string>,
      "DatastoreAvailable": <bool>,
      "Interval": <uint>
    }
  },
  "tlpublishTime__": <string>,
  "timestamp": <int>
}

The Layer 3 heartbeats have a similar format:

Kafka topic : **Kafka topic :**accelleran.drax.4g.ric.raw.service_discovery `

{
  "ENB": <string>,
  "ueDraxId": <string>,
  "ueRicId": <string>,
  "EnbL3ServiceHeartbeat": {
    "HeartbeatInfo": {
      "ComponentId": <string>,
      "DatastoreAvailable": <bool>,
      "Interval": <uint>
    }
  },
  "tlpublishTime__": <string>,
  "timestamp": <int>
}

22.2 Network state⚓︎

Description : This message publishes the network state of the eNodeB, cell and UEs connected to the cell.

Kafka topic : accelleran.drax.4g.ric.raw.network_state

{
  "configurationState": {
    "items": {
      "enb-id": "<uint32>",
      "local-cell-id": "<uint32>",
      "tracking-area-code": "<uint16>",
      "cell-id": "<uint32>",
      "good-one-pps-required": "<bool>",
      "admin-state": "<AdminState>",
      "op-state": "<OpState>",
      "rf-tx-status": "<RfTxStatus>",
      "physical-cell-id": "<uint16>",
      "downlink-earfcn": "<uint16>",
      "downlink-bandwidth": "<uint8>",
      "reference-signal-power": "<int8>",
      "frequency-band-indicator": "<FrequencyBandIndicator>",
      "prach-root-sequence-index": "<uint16>",
      "plmn-list": [
        "<string>",
      ],
      "mme-set-list": [
        "<string64>",
      ],
      "serial-number": "<string64>",
      "gnss-status": "<GnssStatus",
      "longitude": "<int32>",
      "latitude": "<int32>",
      "altitude": "<int32>"
    },
    "ueState": {
      "items": {
        "inRange": {
          "items": <uint64>
        },
        "servingCell": "<string>",
        "timestamp": <uint64>
      }
    }
  }
}

Enumeration description :

Enum Type:
AdminState

Enum Values:
locked
unlocked

Enum Type:
OpState

Enum Values:
enabled
disabled

Enum Type:
RfTxStatus

Enum Values:
on-air
off-air

Enum Type:
FrequencyBandIndicator

Enum Values:
band-3
band-7
band-14
band-38
band-40
band-42
band-43
band-48

Enum Type:
GnssStatus

Enum Values:
not-yet-available
available

22.3 UE Measurements⚓︎

Description : If periodic reporting is enabled in the 4G Radio Controller, the UEs will be instructed to send periodic measurements. These measurements contain the RSRP and RSRQ value from the UE to its serving cell, as well as a maximum of 8 neighbouring cells. Each measurement to a specific cell is sent as a separate message.

Kafka topic : **Kafka topic :**accelleran.drax.4g.ric.raw.ue_measurements `

{
  "ENB": <string>,
  "CELL": <string>,
  "UE": <string>,
  "ueDraxId": <string>,
  "ueRicId": <string>,
  "Rc4gUeMeasurement": {
    "UniqueRicId": <string>,
    "CellId": <string>,
    "AttachedCellId": <string>,
    "Rsrp": <uint>,
    "Rsrq": <uint>,
    "EllipsoidPointR10": {
      "EncodedAsn1Length": <uint>,
      "EncodedAsn1Body": <string>
    },
    "EllipsoidPointWithAltitudeR10": {
      "EncodedAsn1Length": <uint>,
      "EncodedAsn1Body": <string>
    },
    "HorizontalVelocityR10": {
      "EncodedAsn1Length": <uint>,
      "EncodedAsn1Body": <string>
    },
    "GnssTodMsecR10": {
      "EncodedAsn1Length": <uint>,
      "EncodedAsn1Body": <string>
    }
  },
  "tlpublishTime__": <string>,
  "timestamp": <int>
}

22.4 L2 Stats⚓︎

Description : The dRAX RIC also reports the downlink and uplink L2 stats of the UEs in the network.

Kafka topic : **Kafka topic :**accelleran.drax.4g.ric.raw.ue_measurements `

{
  "ENB": <string>,
  "CELL": <string>,
  "UE": <string>,
  "ueDraxId": <string>,
  "ueRicId": <string>,
  "EnbStatsL2StatsValues": {
    "Report": {
      "DschThroughput": <uint>,
      "UschThroughput": <uint>,
      "DownlinkBler": <uint>,
      "UplinkBler": <uint>,
      "TimingAdvance": <uint>,
      "UlSinr": <uint>
    }
  },
  "tlpublishTime__": <string>,
  "timestamp": <int>
}

22.5 CQI⚓︎

Description : The dRAX RIC also supports retrieving the CQI report of the UE to its serving cell. You can get the CQI value from each subband as well as the wideband CQI value.

Kafka topic : **Kafka topic :**accelleran.drax.4g.ric.raw.ue_measurements `

{
  "ENB": <string>,
  "CELL": <string>,
  "UE": <string>,
  "ueDraxId": <string>,
  "ueRicId": <string>,
  "EnbStatsCqiReportValues": {
    "Report": {
      "WidebandCqi": <uint>,
      "CodeblockId": <uint>,
      "CqiList": {
        "0": <uint>
      },
      "CqiListSize": <uint>,
      "RankIndication": <uint>,
      "TransmissionMode": <uint>,
      "UeEdge": <uint>
    }
  },
  "tlpublishTime__": <string>,
  "timestamp": <int>
}