Skip to content

Latest commit

 

History

History
65 lines (47 loc) · 4.46 KB

README.md

File metadata and controls

65 lines (47 loc) · 4.46 KB

Flexible RAN Intelligent Controller (FlexRIC)

The Near-RT RIC, conceptualized by the O-RAN Alliance's Working Group 3 (WG3) [1] and implemented by Mosaic5G [2, 3], enables dynamic management and optimization of Radio Access Networks (RAN).

Usage

  • Compile: Use ./full_install.sh to build and install the Near-RT RIC software.
  • Generate Configurations: Use ./generate_configurations.sh to create configuration files.
    • Configuration files can be accessed and modified in the configs directory.
  • Start the Near-RT RIC: Use ./run.sh to start the Near-RT RIC application.
  • Stop the Near-RT RIC: Terminate the Near-RT RIC with ./stop.sh.
  • Status: Check if the Near-RT RIC is running with ./is_running.sh.
  • Logs: Access logs by navigating to the logs directory.
  • Uninstall: Use ./uninstall.sh to remove the Near-RT RIC software.

Running an xApp

This installation of the Near-RT RIC supports four xApps.

  • KPI Monitor xApp (xapp_kpm_moni):
    • Run with ./run_xapp_kpm_moni.sh.
    • Patched to run indefinitely and include SSB/CSI-RS RSRP metric in KPIs.
  • MAC + RLC + PDCP + GTP Monitor xApp (xapp_gtp_mac_rlc_pdcp_moni):
    • Run with ./additional_scripts/run_xapp_gtp_mac_rlc_pdcp_moni.sh.
  • RIC Control xApp (xapp_kpm_rc):
    • Run with ./additional_scripts/run_xapp_kpm_rc.sh.
  • RIC Control Monitor xApp (xapp_rc_moni):
    • Run with ./additional_scripts/run_xapp_rc_moni.sh.

KPI Monitor Visualization in Grafana

After the KPI Monitor xApp subscribes to the E2 node, metrics of the gNodeB and UE are sent through the E2 interface and received by the xApp. An xApp has been made at flexric/build/examples/xApp/c/monitor/xapp_kpm_moni_write_to_csv which writes the metrics to logs/KPI_Metrics.csv instead of printing them to the console. The Python server at additional_scripts/grafana_host_kpi_metrics_over_http.py will make this CSV file accessible at http://localhost:3030/KPI_Metrics.csv, and a Grafana dashboard has been created to consume this data and visualize it.

  • Real-Time Metrics: To start the xApp that generates logs/KPI_Monitor.csv, the Python server that hosts the file, and the Grafana server, run the following.

    ./additional_scripts/start_grafana_with_xapp_kpm_moni.sh

  • Non-Real Time Metrics: Since it is not a requirement for the xApp to actively write metrics to logs/KPI_Monitor.csv, the Python server and Grafana server can be started without the xApp by running the following.

    ./additional_scripts/start_grafana_only.sh

    A sample KPI_Metrics.csv file has been provided, and can be applied with cp additional_scripts/sample_KPI_Metrics.csv logs/KPI_Metrics.csv.

  • Initial Configuration: The dashboard uses the Infinity plugin (yesoreyeram-infinity-datasource), which may require creating a data source under Connections → Data sources → Add data source → Infinity. Configure it under URL, Headers & Params → Base URL → Type "http://localhost:3030/KPI_Metrics.csv" → Save & test.

  • Stop Grafana: To stop the Grafana server, Python server, and xApp, use ./additional_scripts/stop_grafana.sh.

The Grafana dashboard is accessible at http://localhost:3000 with default credentials being "admin". Upon initial startup, import the following JSON file into the Grafana client by navigating to Dashboards → New → Import: additional_scripts/grafana_xapp_dashboard.json. Please note that the dashboard and the metrics provided with this software are still in development and therefore may display some inaccurate values. Below is a snapshot of the dashboard in its current state.

Grafana dashboard of xApp KPI metrics

References

  1. Working Group 3: Near-Real-time RAN Intelligent Controller and E2 Interface Workgroup. O-RAN Alliance. https://public.o-ran.org/display/WG3/Introduction
  2. FlexRIC: an SDK for next-generation SD-RANs. R. Schmidt, M. Irazabal, N. Nikaein. https://dl.acm.org/doi/10.1145/3485983.3494870
  3. Flexible RAN Intelligent Controller (FlexRIC) and E2 Agent. Mosaic5G. https://gitlab.eurecom.fr/mosaic5g/flexric