Add T tracer to record configured events to database

This extends the functionality provided by record in that it allows collection of data into a Clickhouse database, allowing aggregation of data from gNB and UE for functions like channel estimation for PUSCH transmissions that did not decode successfully at the gNB. It is intended to be used in conjunction with Aerial Data Lake but is not limited to it. Data access is simpler than in !3462, but could be improved using the metadata approach from !3462. The integration uses logfmt for fast logging, and a clickhouse DB client, both integrated using CPM. This change set also adds a docker-compose file for a UE on 100MHz, to be used with Aerial configurations, and builds the tracer for Aerial and nrUE docker files.
2026-07-13 04:30:28 +00:00 · 2026-02-16 09:12:44 +01:00
parent 7fa4d018d4
commit 1d69eb0e1e
12 changed files with 1492 additions and 26 deletions
--- a/docker/Dockerfile.base.ubuntu
+++ b/docker/Dockerfile.base.ubuntu
@@ -49,6 +49,8 @@ RUN apt-get update && \
       bison \
       flex \
       m4 \
+       # libzstd-dev for ClickHouse C++ library
+       libzstd-dev \
       # python3-pip for conf template generation
       python3-pip \
       wget \
--- a/docker/Dockerfile.build.fhi72.native_arm.ubuntu
+++ b/docker/Dockerfile.build.fhi72.native_arm.ubuntu
@@ -81,8 +81,7 @@ RUN /bin/sh oaienv && \
      --ninja --gNB \
      --build-lib "telnetsrv enbscope uescope nrscope" \
      -t oran_fhlib_5g --cmake-opt -Dxran_LOCATION=/opt/phy/fhi_lib/lib \
-      --build-e2 --cmake-opt -DXAPP_MULTILANGUAGE=OFF --cmake-opt -DKPM_VERSION=$KPM_VERSION --cmake-opt -DE2AP_VERSION=$E2AP_VERSION \
-      $BUILD_OPTION && \
+      --build-e2 --cmake-opt -DXAPP_MULTILANGUAGE=OFF --cmake-opt -DKPM_VERSION=$KPM_VERSION --cmake-opt -DE2AP_VERSION=$E2AP_VERSION && \
    # Mainly to see if the sanitize option was perfectly executed
    ldd ran_build/build/nr-softmodem && \
    ldd ran_build/build/liboran_fhlib_5g.so && \
--- a/docker/Dockerfile.build.fhi72.ubuntu
+++ b/docker/Dockerfile.build.fhi72.ubuntu
@@ -71,8 +71,7 @@ RUN /bin/sh oaienv && \
      --ninja --gNB --nrRU \
      --build-lib "telnetsrv enbscope uescope nrscope" \
      -t oran_fhlib_5g --cmake-opt -Dxran_LOCATION=/opt/phy/fhi_lib/lib \
-      --build-e2 --cmake-opt -DKPM_VERSION=$KPM_VERSION --cmake-opt -DE2AP_VERSION=$E2AP_VERSION \
-      $BUILD_OPTION && \
+      --build-e2 --cmake-opt -DKPM_VERSION=$KPM_VERSION --cmake-opt -DE2AP_VERSION=$E2AP_VERSION && \
    # Mainly to see if the sanitize option was perfectly executed
    ldd ran_build/build/nr-softmodem && \
    ldd ran_build/build/liboran_fhlib_5g.so && \
--- a/docker/Dockerfile.build.ubuntu
+++ b/docker/Dockerfile.build.ubuntu
@@ -42,15 +42,23 @@ RUN \
   # Mount CPM package cache
   --mount=type=cache,target=/root/.cache/cpm/ \
    /bin/sh oaienv && \
-    mkdir -p cmake_targets/ran_build/build && \
-    cd cmake_targets/ran_build/build && \
-    cmake ../../../ -GNinja \
-        -DENABLE_TELNETSRV=ON -DENABLE_ENBSCOPE=ON -DENABLE_UESCOPE=ON -DENABLE_NRSCOPE=ON \
-        -DOAI_USRP=ON -DOAI_BLADERF=ON -DOAI_ETHERNET=ON -DOAI_VRTSIM_TAPS_CLIENT=ON \
-        -DE2_AGENT=ON -DKPM_VERSION=KPM_V3_00 -DE2AP_VERSION=E2AP_V3 \
-        -DAVX512=OFF && \
-    # -DCMAKE_C_FLAGS=-Werror -DCMAKE_CXX_FLAGS=-Werror && \
-    ninja
+    cd cmake_targets && \
+    mkdir -p log && \
+    ./build_oai -c --ninja \
+      --eNB --gNB --RU --UE --nrUE \
+      --build-lib "telnetsrv enbscope uescope nrscope" \
+      -w USRP -t Ethernet -w BLADERF \
+      --build-e2 --cmake-opt -DKPM_VERSION=$KPM_VERSION --cmake-opt -DE2AP_VERSION=$E2AP_VERSION \
+      --cmake-opt -DOAI_VRTSIM_TAPS_CLIENT=ON \
+      --noavx512 \
+      --build-tool-opt -k10 \
+      --cmake-opt -DT_RECORD_DB=ON \
+      --cmake-opt -DCMAKE_C_FLAGS="-Werror" --cmake-opt -DCMAKE_CXX_FLAGS="-Werror" $BUILD_OPTION && \
+    # Mainly to see if the sanitize option was perfectly executed
+    echo "---- ldd on executables ----" && \
+    ldd ran_build/build/*softmodem* ran_build/build/nr-cuup ran_build/build/oairu && \
+    echo "---- ldd on shared libraries ----" && \
+    ldd ran_build/build/*.so

 ## Build FlexRIC for SM Models
 RUN \
--- a/docker/Dockerfile.gNB.aerial.ubuntu
+++ b/docker/Dockerfile.gNB.aerial.ubuntu
@@ -55,13 +55,15 @@ RUN /bin/sh oaienv && \
    cd cmake_targets && \
    mkdir -p log && \
    ./build_oai -c -w AERIAL --gNB --ninja --build-tool-opt -k10 \
-      --cmake-opt -DCMAKE_C_FLAGS="-Werror" --cmake-opt -DCMAKE_CXX_FLAGS="-Werror"
+      --cmake-opt -DCMAKE_C_FLAGS="-Werror" --cmake-opt -DCMAKE_CXX_FLAGS="-Werror" \
+      --cmake-opt -DT_RECORD_DB=ON


 #start from scratch for target executable
 FROM ubuntu:noble AS oai-gnb-aerial
 ENV DEBIAN_FRONTEND=noninteractive
 ENV TZ=Europe
+ENV PATH="/opt/oai-gnb/bin:$PATH"

 RUN apt-get update && \
    apt-get upgrade --yes && \
@@ -85,17 +87,20 @@ RUN apt-get update && \

 WORKDIR /opt/oai-gnb/bin
 COPY --from=ran-build \
-    /oai-ran/cmake_targets/ran_build/build/nr-softmodem ./
+    /oai-ran/cmake_targets/ran_build/build/nr-softmodem \
+    /oai-ran/cmake_targets/ran_build/build/common/utils/T/tracer/record* \
+    ./
+
 COPY ./docker/scripts/gnb_entrypoint.sh ./entrypoint.sh

 COPY --from=ran-build \
  /oai-ran/cmake_targets/ran_build/build/libparams_libconfig.so \
  /oai-ran/cmake_targets/ran_build/build/libparams_yaml.so \
+  /oai-ran/cmake_targets/ran_build/build/_deps*/fmtlog-build*/libfmtlog-shared*.so \
+  /oai-ran/cmake_targets/ran_build/build/_deps*/clickhouse-cpp-build*/clickhouse/libclickhouse*.so \
  /usr/local/lib/

-#copy files from nvIPC
 COPY --from=ran-build \
-    /usr/local/lib/libfmtlog-shared.so \
    /usr/local/lib/libnvlog.so \
    /usr/local/lib/libnvipc.so \
    /usr/local/lib/
@@ -113,5 +118,6 @@ WORKDIR /opt/oai-gnb

 COPY --from=ran-build /usr/local/bin/yq /usr/local/bin/yq
 COPY --from=ran-build /tini /tini
+COPY --from=ran-build /oai-ran/common/utils/T/T_messages.txt ./
 ENTRYPOINT ["/tini", "-v", "--", "/opt/oai-gnb/bin/entrypoint.sh"]
 CMD ["/opt/oai-gnb/bin/nr-softmodem"]
--- a/docker/Dockerfile.nrORU.fhi72.ubuntu
+++ b/docker/Dockerfile.nrORU.fhi72.ubuntu
@@ -25,7 +25,6 @@ FROM ran-build-fhi72:latest AS ran-build

 #start from scratch for target executable
 FROM ubuntu:noble AS oai-nr-oru
-ARG BUILD_OPTION
 ENV DEBIAN_FRONTEND=noninteractive
 ENV TZ=Europe

@@ -50,11 +49,6 @@ RUN apt-get update && \
        xz-utils \
        libnuma-dev \
        libyaml-cpp-dev && \
-# if the --sanitize option was used to build, additional packages are required
-    /bin/bash -c 'if [[ "$BUILD_OPTION" = "--sanitize" ]]; then DEBIAN_FRONTEND=noninteractive apt-get install --yes \
-        libasan8 \
-        libubsan1 \
-        liblapacke; fi' && \
    rm -rf /var/lib/apt/lists/*

 WORKDIR /opt/nr-oru/bin
--- a/docker/Dockerfile.nrUE.ubuntu
+++ b/docker/Dockerfile.nrUE.ubuntu
@@ -35,6 +35,7 @@ FROM ubuntu:noble AS oai-nr-ue
 ARG BUILD_OPTION
 ENV DEBIAN_FRONTEND=noninteractive
 ENV TZ=Europe/Paris
+ENV PATH="/opt/oai-nr-ue/bin:$PATH"

 RUN apt-get update && \
    apt-get upgrade --yes && \
@@ -67,6 +68,7 @@ RUN apt-get update && \
        iperf3 \
        iperf \
        libyaml-cpp-dev \
+        libzstd1 \
        libnanomsg5 && \
 # if the --sanitize option was used to build, additional packages are required
    /bin/bash -c 'if [[ "$BUILD_OPTION" = "--sanitize" ]]; then DEBIAN_FRONTEND=noninteractive apt-get install --yes \
@@ -78,6 +80,7 @@ RUN apt-get update && \
 WORKDIR /opt/oai-nr-ue/bin
 COPY --from=nr-ue-build \
    /oai-ran/cmake_targets/ran_build/build/nr-uesoftmodem \
+    /oai-ran/cmake_targets/ran_build/build/common/utils/T/tracer/record* \
    ./

 COPY ./docker/scripts/nr_ue_entrypoint.sh ./entrypoint.sh
@@ -94,10 +97,17 @@ COPY --from=nr-ue-build \
    /oai-ran/cmake_targets/ran_build/build/libtelnetsrv.so \
    /oai-ran/cmake_targets/ran_build/build/libtelnetsrv_ciUE.so \
    /oai-ran/cmake_targets/ran_build/build/libtelnetsrv_5Gue.so \
+    /oai-ran/cmake_targets/ran_build/build/libnrscope.so \
+    /oai-ran/cmake_targets/ran_build/build/libtelnetsrv.so \
    /oai-ran/cmake_targets/ran_build/build/libparams_yaml.so \
    /oai-ran/cmake_targets/ran_build/build/libvrtsim.so \
+    # Wildcards so it doesn't fail if not present
+    /oai-ran/cmake_targets/ran_build/build/_deps*/fmtlog-build*/libfmtlog-shared*.so \
+    /oai-ran/cmake_targets/ran_build/build/_deps*/clickhouse-cpp-build*/clickhouse/libclickhouse*.so \
    /usr/local/lib/

+#    /oai-ran/cmake_targets/ran_build/build/libimscope.so \
+
 # Now we are copying from builder-image the UHD files.
 COPY --from=nr-ue-base /usr/local/bin/uhd_find_devices /usr/local/bin
 COPY --from=nr-ue-base /usr/local/lib/libuhd.so.4.8.0 /usr/local/lib
@@ -124,5 +134,6 @@ WORKDIR /opt/oai-nr-ue

 COPY --from=nr-ue-base /usr/local/bin/yq /usr/local/bin/yq
 COPY --from=nr-ue-base /tini /tini
+COPY --from=nr-ue-build /oai-ran/common/utils/T/T_messages.txt ./
 CMD ["/opt/oai-nr-ue/bin/nr-uesoftmodem"]
 ENTRYPOINT ["/tini", "-v", "--", "/opt/oai-nr-ue/bin/entrypoint.sh"]