You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25Lines changed: 25 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -171,6 +171,31 @@ This setup leverages a hybrid of open-source tools and Orange’s internal platf
171
171
172
172
173
173
174
+
## 5. LENA Module Reporting Parameters
175
+
176
+
To support custom xApp development on top of this platform, a dedicated reference document is available that maps every reportable KPI to its exact source in the 5G-LENA NR module:
- A **complete layer-by-layer catalogue** (PHY, MAC, RLC, PDCP, RRC, E2/O-RAN) of all parameters that can be extracted from the 5G-LENA module (`src/nr/`).
183
+
- A clear **status for each parameter** — whether it is directly **IMPLEMENTABLE** via a trace source or public API, **DERIVABLE** through post-processing, or **NOT_SUPPORTED** in the current codebase.
184
+
- The exact **file, class, function, and TraceSource** needed to access each metric, so you know precisely where to connect your reporting logic.
185
+
- Documented **known corrections** between the simulator implementation and the 3GPP KPM naming conventions (e.g. RLC byte counts reported under PDCP KPM names).
186
+
187
+
### How it helps you build a custom xApp
188
+
189
+
When developing a custom xApp that requires specific KPIs from the LENA simulation — such as per-UE throughput, SINR, PRB utilization, PDCP delay, or RRC events — this document tells you:
190
+
191
+
1.**Whether the parameter is available** in the current 5G-LENA codebase.
192
+
2.**How to enable reporting** of that parameter (trace connection call, helper method, or derivation formula).
193
+
3.**Where the data flows** from the simulator layer through the E2 indication message to your xApp.
194
+
195
+
This makes the document the starting point for any custom reporting extension, enabling you to identify the required parameters, wire the correct trace sources, and include them in the KPM indication messages sent to FlexRIC.
0 commit comments