cu_cp: added initial glue between the CU-CP and the metrics service

Author: alvasMan

apps/units/o_cu_cp/cu_cp/metrics/CMakeLists.txt

@@ -7,8 +7,8 @@
 #
 
 set(SOURCES
-        cu_cp_pdcp_metrics_producer.cpp
-        cu_cp_pdcp_metrics_consumers.cpp)
+        cu_cp_metrics_producer.cpp
+        cu_cp_metrics_consumers.cpp)
 
 add_library(srsran_cu_cp_unit_metrics_helpers STATIC ${SOURCES})
 target_include_directories(srsran_cu_cp_unit_metrics_helpers PRIVATE ${CMAKE_SOURCE_DIR})

apps/units/o_cu_cp/cu_cp/metrics/cu_cp_metrics.h

@@ -0,0 +1,60 @@
+/*
+ *
+ * Copyright 2021-2025 Software Radio Systems Limited
+ *
+ * By using this file, you agree to the terms and conditions set
+ * forth in the LICENSE file which can be found at the top level of
+ * the distribution.
+ *
+ */
+
+#pragma once
+
+#include "apps/services/metrics/metrics_consumer.h"
+#include "apps/services/metrics/metrics_properties.h"
+#include "apps/services/metrics/metrics_set.h"
+#include "srsran/adt/span.h"
+#include "srsran/adt/unique_function.h"
+#include "srsran/cu_cp/cu_cp_metrics_notifier.h"
+
+namespace srsran {
+
+/// CU-CP metrics properties implementation.
+class cu_cp_metrics_properties_impl : public app_services::metrics_properties
+{
+public:
+  std::string_view name() const override { return "CU-CP metrics"; }
+};
+
+/// CU-CP metrics implementation.
+class cu_cp_metrics_impl : public app_services::metrics_set
+{
+  cu_cp_metrics_properties_impl properties;
+  srs_cu_cp::metrics_report     metrics;
+
+public:
+  explicit cu_cp_metrics_impl(const srs_cu_cp::metrics_report& metrics_) : metrics(metrics_) {}
+
+  // See interface for documentation.
+  const app_services::metrics_properties& get_properties() const override { return properties; }
+
+  const srs_cu_cp::metrics_report& get_metrics() const { return metrics; }
+};
+
+/// Callback for the CU-CP PDCP metrics.
+inline auto cu_cp_metrics_callback = [](const app_services::metrics_set&      report,
+                                        span<app_services::metrics_consumer*> consumers,
+                                        task_executor&                        executor,
+                                        srslog::basic_logger&                 logger) {
+  const auto& metric = static_cast<const cu_cp_metrics_impl&>(report);
+
+  if (!executor.defer(TRACE_TASK([metric, consumers]() {
+        for (auto& consumer : consumers) {
+          consumer->handle_metric(metric);
+        }
+      }))) {
+    logger.error("Failed to dispatch the metric '{}'", metric.get_properties().name());
+  }
+};
+
+} // namespace srsran

apps/units/o_cu_cp/cu_cp/metrics/cu_cp_metrics_consumers.cpp

@@ -0,0 +1,30 @@
+/*
+ *
+ * Copyright 2021-2025 Software Radio Systems Limited
+ *
+ * By using this file, you agree to the terms and conditions set
+ * forth in the LICENSE file which can be found at the top level of
+ * the distribution.
+ *
+ */
+
+#include "cu_cp_metrics_consumers.h"
+#include "cu_cp_metrics.h"
+
+using namespace srsran;
+
+void cu_cp_metrics_consumer_json::handle_metric(const app_services::metrics_set& metric)
+{
+  const srs_cu_cp::metrics_report& cp_metrics = static_cast<const cu_cp_metrics_impl&>(metric).get_metrics();
+  (void)cp_metrics;
+  /// TODO write to JSON file.
+  log_chan.enabled();
+}
+
+void cu_cp_metrics_consumer_log::handle_metric(const app_services::metrics_set& metric)
+{
+  const srs_cu_cp::metrics_report& cp_metrics = static_cast<const cu_cp_metrics_impl&>(metric).get_metrics();
+  (void)cp_metrics;
+  /// TODO write to log file.
+  log_chan.enabled();
+}

apps/units/o_cu_cp/cu_cp/metrics/cu_cp_metrics_consumers.h

@@ -0,0 +1,48 @@
+/*
+ *
+ * Copyright 2021-2025 Software Radio Systems Limited
+ *
+ * By using this file, you agree to the terms and conditions set
+ * forth in the LICENSE file which can be found at the top level of
+ * the distribution.
+ *
+ */
+
+#pragma once
+
+#include "apps/services/metrics/metrics_consumer.h"
+#include "srsran/srslog/log_channel.h"
+#include "srsran/support/srsran_assert.h"
+
+namespace srsran {
+
+/// Consumer for the json CU-CP metrics.
+class cu_cp_metrics_consumer_json : public app_services::metrics_consumer
+{
+public:
+  explicit cu_cp_metrics_consumer_json(srslog::log_channel& log_chan_) : log_chan(log_chan_) {}
+
+  // See interface for documentation.
+  void handle_metric(const app_services::metrics_set& metric) override;
+
+private:
+  srslog::log_channel& log_chan;
+};
+
+/// Consumer for the log CU-CP metrics.
+class cu_cp_metrics_consumer_log : public app_services::metrics_consumer
+{
+public:
+  explicit cu_cp_metrics_consumer_log(srslog::log_channel& log_chan_) : log_chan(log_chan_)
+  {
+    srsran_assert(log_chan.enabled(), "Logger log channel is not enabled");
+  }
+
+  // See interface for documentation.
+  void handle_metric(const app_services::metrics_set& metric) override;
+
+private:
+  srslog::log_channel& log_chan;
+};
+
+} // namespace srsran

apps/units/o_cu_cp/cu_cp/metrics/cu_cp_pdcp_metrics_producer.cpp renamed to apps/units/o_cu_cp/cu_cp/metrics/cu_cp_metrics_producer.cpp

@@ -8,12 +8,12 @@
  *
  */
 
-#include "cu_cp_pdcp_metrics_producer.h"
-#include "cu_cp_pdcp_metrics.h"
+#include "cu_cp_metrics_producer.h"
+#include "cu_cp_metrics.h"
 
 using namespace srsran;
 
-void cu_cp_pdcp_metrics_producer_impl::report_metrics(const pdcp_metrics_container& report)
+void cu_cp_metrics_producer_impl::notify_metrics_report_request(const srs_cu_cp::metrics_report& report)
 {
-  notifier.on_new_metric(cu_cp_pdcp_metrics_impl(report));
+  notifier.on_new_metric(cu_cp_metrics_impl(report));
 }

apps/units/o_cu_cp/cu_cp/metrics/cu_cp_pdcp_metrics_producer.h renamed to apps/units/o_cu_cp/cu_cp/metrics/cu_cp_metrics_producer.h

@@ -12,18 +12,18 @@
 
 #include "apps/services/metrics/metrics_notifier.h"
 #include "apps/services/metrics/metrics_producer.h"
-#include "srsran/pdcp/pdcp_metrics.h"
+#include "srsran/cu_cp/cu_cp_metrics_notifier.h"
 
 namespace srsran {
 
-/// CU-CP PDCP metrics producer implementation.
-class cu_cp_pdcp_metrics_producer_impl : public pdcp_metrics_notifier, public app_services::metrics_producer
+/// CU-CP metrics producer implementation.
+class cu_cp_metrics_producer_impl : public srs_cu_cp::metrics_report_notifier, public app_services::metrics_producer
 {
 public:
-  explicit cu_cp_pdcp_metrics_producer_impl(app_services::metrics_notifier& notifier_) : notifier(notifier_) {}
+  explicit cu_cp_metrics_producer_impl(app_services::metrics_notifier& notifier_) : notifier(notifier_) {}
 
   // See interface for documentation.
-  void report_metrics(const pdcp_metrics_container& metrics) override;
+  void notify_metrics_report_request(const srs_cu_cp::metrics_report& metrics) override;
 
   // See interface for documentation.
   void on_new_report_period() override {}

apps/units/o_cu_cp/cu_cp/metrics/cu_cp_pdcp_metrics.h

@@ -11,11 +11,11 @@
 #include "o_cu_cp_builder.h"
 #include "apps/helpers/metrics/metrics_helpers.h"
 #include "apps/services/metrics/metrics_config.h"
+#include "apps/units/o_cu_cp/cu_cp/metrics/cu_cp_metrics.h"
+#include "apps/units/o_cu_cp/cu_cp/metrics/cu_cp_metrics_consumers.h"
+#include "apps/units/o_cu_cp/cu_cp/metrics/cu_cp_metrics_producer.h"
 #include "cu_cp/cu_cp_cmdline_commands.h"
 #include "cu_cp/cu_cp_config_translators.h"
-#include "cu_cp/metrics/cu_cp_pdcp_metrics.h"
-#include "cu_cp/metrics/cu_cp_pdcp_metrics_consumers.h"
-#include "cu_cp/metrics/cu_cp_pdcp_metrics_producer.h"
 #include "e2/o_cu_cp_e2_config_translators.h"
 #include "o_cu_cp_unit_config.h"
 #include "o_cu_cp_unit_impl.h"
@@ -26,30 +26,28 @@
 
 using namespace srsran;
 
-static pdcp_metrics_notifier* build_pdcp_metrics_config(std::vector<app_services::metrics_config>& cu_up_services_cfg,
-                                                        app_services::metrics_notifier&            metrics_notifier,
-                                                        const cu_cp_unit_metrics_config&           cu_cp_metrics_cfg)
+static srs_cu_cp::metrics_report_notifier*
+build_cu_cp_metrics_config(std::vector<app_services::metrics_config>& cu_cp_services_cfg,
+                           app_services::metrics_notifier&            metrics_notifier,
+                           const cu_cp_unit_metrics_config&           cu_cp_metrics_cfg)
 {
-  // NOTE: do not report CU-CP metrics for now. Remove this when CU-CP metrics are needed.
-  return nullptr;
+  srs_cu_cp::metrics_report_notifier* out = nullptr;
 
-  if (!cu_cp_metrics_cfg.layers_cfg.enable_pdcp) {
-    return nullptr;
-  }
-
-  pdcp_metrics_notifier* out = nullptr;
-
-  auto metrics_generator = std::make_unique<cu_cp_pdcp_metrics_producer_impl>(metrics_notifier);
-  out                    = &(*metrics_generator);
-  app_services::metrics_config& metrics_service_cfg = cu_up_services_cfg.emplace_back();
-  metrics_service_cfg.metric_name                   = cu_cp_pdcp_metrics_properties_impl().name();
-  metrics_service_cfg.callback                      = cu_cp_pdcp_metrics_callback;
+  auto metrics_generator                            = std::make_unique<cu_cp_metrics_producer_impl>(metrics_notifier);
+  out                                               = &(*metrics_generator);
+  app_services::metrics_config& metrics_service_cfg = cu_cp_services_cfg.emplace_back();
+  metrics_service_cfg.metric_name                   = cu_cp_metrics_properties_impl().name();
+  metrics_service_cfg.callback                      = cu_cp_metrics_callback;
   metrics_service_cfg.producers.push_back(std::move(metrics_generator));
 
   const app_helpers::metrics_config& unit_metrics_cfg = cu_cp_metrics_cfg.common_metrics_cfg;
   if (unit_metrics_cfg.json_config.enable_json_metrics) {
     metrics_service_cfg.consumers.push_back(
-        std::make_unique<cu_cp_pdcp_metrics_consumer_json>(app_helpers::fetch_json_metrics_log_channel()));
+        std::make_unique<cu_cp_metrics_consumer_json>(app_helpers::fetch_json_metrics_log_channel()));
+  }
+  if (cu_cp_metrics_cfg.common_metrics_cfg.enable_log_metrics) {
+    metrics_service_cfg.consumers.push_back(
+        std::make_unique<cu_cp_metrics_consumer_log>(app_helpers::fetch_logger_metrics_log_channel()));
   }
 
   return out;
@@ -71,8 +69,10 @@ o_cu_cp_unit srsran::build_o_cu_cp(const o_cu_cp_unit_config& unit_cfg, o_cu_cp_
   cu_cp_cfg.services.timers                     = dependencies.timers;
 
   o_cu_cp_unit ocucp;
-  cu_cp_cfg.pdcp_metric_notifier =
-      build_pdcp_metrics_config(ocucp.metrics, *dependencies.metrics_notifier, unit_cfg.cucp_cfg.metrics);
+
+  cu_cp_cfg.metrics.metrics_report_period = std::chrono::milliseconds(unit_cfg.cucp_cfg.metrics.cu_cp_report_period);
+  cu_cp_cfg.metrics_notifier =
+      build_cu_cp_metrics_config(ocucp.metrics, *dependencies.metrics_notifier, unit_cfg.cucp_cfg.metrics);
 
   // Create N2 Client Gateways.
   std::vector<std::unique_ptr<srs_cu_cp::n2_connection_client>> n2_clients;