[ntuple] Add ROOT_EXPERIMENTAL_EXPORT_RNTUPLE_METRICS

roottest/root/ntuple/metrics/CMakeLists.txt

@@ -1,6 +1,6 @@
 ROOTTEST_ADD_TEST(metrics_env_enabled
                   MACRO test_rntuple_metrics_env.C
-                  ENVIRONMENT ROOT_EXPORT_RNTUPLE_METRICS=metrics_env_enabled.root
+                  ENVIRONMENT ROOT_EXPERIMENTAL_EXPORT_RNTUPLE_METRICS=metrics_env_enabled.root
                   OUTREF metrics_env_enabled.ref)
 
 ROOTTEST_ADD_TEST(metrics_env_disabled

roottest/root/ntuple/metrics/metrics_env_enabled.ref

@@ -1,3 +1,4 @@
 Processing test_rntuple_metrics_env.C...
 Metrics enabled: true
 nPageCommitted: 1
+Warning in <TFileMerger::MergeRecursive>: Merging RNTuples is experimental

tree/ntuple/inc/ROOT/RNTupleMetrics.hxx

@@ -283,8 +283,8 @@ using RNTupleAtomicTimer = RNTupleTimer<RNTupleAtomicCounter, RNTupleTickCounter
 
 The class owns the counters.
 
-If the environment variable `ROOT_EXPORT_RNTUPLE_METRICS` is set, metrics are automatically enabled on
-construction, and any counter added afterwards through MakeCounter() is enabled as well.
+If the environment variable `ROOT_EXPERIMENTAL_EXPORT_RNTUPLE_METRICS` is set, metrics are automatically enabled
+on construction, and any counter added afterwards through MakeCounter() is enabled as well.
 */
 // clang-format on
 class RNTupleMetrics {
@@ -295,22 +295,36 @@ private:
    std::vector<std::unique_ptr<RNTuplePerfCounter>> fCounters;
    std::vector<RNTupleMetrics *> fObservedMetrics;
    std::string fName;
+   std::string fNTupleName;
+   std::string fExportPath;
    bool fIsEnabled = false;
 
    bool Contains(const std::string &name) const;
 
+   /// Retrieves each counter of the observed metrics down to the class instances which own the counters and pairs them
+   /// with their fully qualified names
+   void CollectCounters(std::vector<std::pair<std::string, const RNTuplePerfCounter *>> &counters,
+                        const std::string &prefix = "") const;
+   void ExportToRootFile();
+
 public:
-   explicit RNTupleMetrics(const std::string &name) : fName(name)
+   explicit RNTupleMetrics(const std::string &name) : RNTupleMetrics(name, "") {}
+   RNTupleMetrics(const std::string &name, const std::string &ntupleName) : fName(name), fNTupleName(ntupleName)
    {
-      // TODO: Use the value of `GetMetricsExportPath` to save the contents of the metrics in a `.root` file
-      if (!GetMetricsExportPath().empty())
-         Enable();
+      const std::string exportPath = GetMetricsExportPath();
+      if (exportPath.empty())
+         return;
+
+      if (!fNTupleName.empty())
+         fExportPath = exportPath;
+
+      Enable();
    }
    RNTupleMetrics(const RNTupleMetrics &other) = delete;
    RNTupleMetrics & operator=(const RNTupleMetrics &other) = delete;
    RNTupleMetrics(RNTupleMetrics &&other) = default;
    RNTupleMetrics & operator=(RNTupleMetrics &&other) = default;
-   ~RNTupleMetrics() = default;
+   ~RNTupleMetrics();
 
    // TODO(jblomer): return a reference
    template <typename CounterPtrT, class... Args>
@@ -332,7 +346,7 @@ public:
    const RNTuplePerfCounter *GetCounter(std::string_view name) const;
 
    void ObserveMetrics(RNTupleMetrics &observee);
-   static const std::string &GetMetricsExportPath();
+   static std::string GetMetricsExportPath();
 
    void Print(std::ostream &output, const std::string &prefix = "") const;
    void Enable();

tree/ntuple/src/RNTupleMetrics.cxx

@@ -14,11 +14,40 @@
 
 #include <ROOT/RNTupleMetrics.hxx>
 
+#include <ROOT/RField.hxx>
+#include <ROOT/RLogger.hxx>
+#include <ROOT/RNTupleModel.hxx>
+#include <ROOT/RNTupleUtils.hxx>
+#include <ROOT/RNTupleWriter.hxx>
+
+#include <TFile.h>
+#include <TFileMerger.h>
+#include <TMemFile.h>
 #include <TSystem.h>
 
+#include <cstdint>
+#include <mutex>
 #include <ostream>
+#include <vector>
 
-#include <iostream>
+namespace {
+
+std::mutex &GetMetricsExportMutex()
+{
+   static std::mutex mutex;
+   return mutex;
+}
+
+thread_local bool gSuppressMetricsExport = false;
+
+struct RSuppressMetricsRaii {
+   RSuppressMetricsRaii() { gSuppressMetricsExport = true; }
+   RSuppressMetricsRaii(const RSuppressMetricsRaii &other) = delete;
+   RSuppressMetricsRaii &operator=(const RSuppressMetricsRaii &other) = delete;
+   ~RSuppressMetricsRaii() { gSuppressMetricsExport = false; }
+};
+
+} // anonymous namespace
 
 ROOT::Experimental::Detail::RNTuplePerfCounter::~RNTuplePerfCounter()
 {
@@ -93,12 +122,83 @@ void ROOT::Experimental::Detail::RNTupleMetrics::ObserveMetrics(RNTupleMetrics &
    fObservedMetrics.push_back(&observee);
 }
 
-const std::string &ROOT::Experimental::Detail::RNTupleMetrics::GetMetricsExportPath()
+std::string ROOT::Experimental::Detail::RNTupleMetrics::GetMetricsExportPath()
 {
-   static const std::string path = []() -> std::string {
-      if (const char *env = gSystem->Getenv("ROOT_EXPORT_RNTUPLE_METRICS"); env && *env)
-         return env;
-      return "";
-   }();
-   return path;
+   if (gSuppressMetricsExport)
+      return {};
+
+   if (const char *env = gSystem->Getenv("ROOT_EXPERIMENTAL_EXPORT_RNTUPLE_METRICS"); env && *env)
+      return env;
+
+   return {};
+}
+
+ROOT::Experimental::Detail::RNTupleMetrics::~RNTupleMetrics()
+{
+   if (!fIsEnabled || fExportPath.empty())
+      return;
+
+   ExportToRootFile();
+}
+
+void ROOT::Experimental::Detail::RNTupleMetrics::CollectCounters(
+   std::vector<std::pair<std::string, const RNTuplePerfCounter *>> &counters, const std::string &prefix) const
+{
+   constexpr char kSeparator = '_';
+
+   R__ASSERT(!fName.empty());
+
+   std::string qualifiedName = prefix;
+   if (!qualifiedName.empty())
+      qualifiedName += kSeparator;
+   qualifiedName += fName;
+
+   for (const auto &counter : fCounters)
+      counters.emplace_back(qualifiedName + kSeparator + counter->GetName(), counter.get());
+
+   for (const auto *observed : fObservedMetrics)
+      observed->CollectCounters(counters, qualifiedName);
+}
+
+void ROOT::Experimental::Detail::RNTupleMetrics::ExportToRootFile()
+{
+   R__ASSERT(!fExportPath.empty());
+   R__ASSERT(!fNTupleName.empty());
+
+   std::vector<std::pair<std::string, const RNTuplePerfCounter *>> counters;
+   CollectCounters(counters);
+   R__ASSERT(!counters.empty());
+
+   // Avoid inifinite recursion (an RNTupleWriter is created to print the metrics)
+   RSuppressMetricsRaii suppressGuard;
+
+   auto model = ROOT::RNTupleModel::Create();
+   for (const auto &[fullyQualifiedName, counter] : counters) {
+      if (const auto *calc = dynamic_cast<const RNTupleCalcPerf *>(counter))
+         *model->MakeField<double>(fullyQualifiedName) = calc->GetValue();
+      else
+         *model->MakeField<std::int64_t>(fullyQualifiedName) = counter->GetValueAsInt();
+   }
+
+   TMemFile memoryFile(fNTupleName.c_str(), "RECREATE");
+   {
+      auto writer = ROOT::RNTupleWriter::Append(std::move(model), fNTupleName, memoryFile);
+      writer->Fill();
+      writer->CommitDataset();
+   }
+
+   std::lock_guard<std::mutex> lock(GetMetricsExportMutex());
+
+   TFileMerger merger;
+   merger.SetMergeOptions(std::string_view("rntuple.MergingMode=Union"));
+
+   if (!merger.OutputFile(fExportPath.c_str(), "UPDATE")) {
+      R__LOG_ERROR(ROOT::Internal::NTupleLog()) << "cannot open metrics export file '" << fExportPath << "'";
+      return;
+   }
+
+   if (!merger.AddFile(&memoryFile) || !merger.PartialMerge(TFileMerger::kAll | TFileMerger::kIncremental)) {
+      R__LOG_ERROR(ROOT::Internal::NTupleLog())
+         << "cannot merge metrics for '" << fNTupleName << "' into '" << fExportPath << "'";
+   }
 }

tree/ntuple/src/RNTupleParallelWriter.cxx

@@ -129,7 +129,7 @@ class RPageSynchronizingSink : public RPageSink {
 
 ROOT::RNTupleParallelWriter::RNTupleParallelWriter(std::unique_ptr<ROOT::RNTupleModel> model,
                                                    std::unique_ptr<RPageSink> sink)
-   : fSink(std::move(sink)), fModel(std::move(model)), fMetrics("RNTupleParallelWriter")
+   : fSink(std::move(sink)), fModel(std::move(model)), fMetrics("RNTupleParallelWriter", fSink->GetNTupleName())
 {
    if (fModel->GetRegisteredSubfieldNames().size() > 0) {
       throw RException(R__FAIL("cannot create an RNTupleParallelWriter from a model with registered subfields"));

tree/ntuple/src/RNTupleReader.cxx

@@ -153,7 +153,7 @@ void ROOT::RNTupleReader::InitPageSource(bool enableMetrics)
 ROOT::RNTupleReader::RNTupleReader(std::unique_ptr<ROOT::RNTupleModel> model,
                                    std::unique_ptr<ROOT::Internal::RPageSource> source,
                                    const ROOT::RNTupleReadOptions &options)
-   : fSource(std::move(source)), fModel(std::move(model)), fMetrics("RNTupleReader")
+   : fSource(std::move(source)), fModel(std::move(model)), fMetrics("RNTupleReader", fSource->GetNTupleName())
 {
    // TODO(jblomer): properly support projected fields
    auto &projectedFields = ROOT::Internal::GetProjectedFieldsOfModel(*fModel);
@@ -167,7 +167,7 @@ ROOT::RNTupleReader::RNTupleReader(std::unique_ptr<ROOT::RNTupleModel> model,
 
 ROOT::RNTupleReader::RNTupleReader(std::unique_ptr<ROOT::Internal::RPageSource> source,
                                    const ROOT::RNTupleReadOptions &options)
-   : fSource(std::move(source)), fModel(nullptr), fMetrics("RNTupleReader")
+   : fSource(std::move(source)), fModel(nullptr), fMetrics("RNTupleReader", fSource->GetNTupleName())
 {
    InitPageSource(options.GetEnableMetrics());
 }

tree/ntuple/src/RNTupleWriter.cxx

@@ -37,7 +37,7 @@ static bool IsReservedRNTupleAttrSetName(std::string_view name)
 
 ROOT::RNTupleWriter::RNTupleWriter(std::unique_ptr<ROOT::RNTupleModel> model,
                                    std::unique_ptr<ROOT::Internal::RPageSink> sink)
-   : fFillContext(std::move(model), std::move(sink)), fMetrics("RNTupleWriter")
+   : fFillContext(std::move(model), std::move(sink)), fMetrics("RNTupleWriter", fFillContext.fSink->GetNTupleName())
 {
 #ifdef R__USE_IMT
    if (IsImplicitMTEnabled() &&

tree/ntuple/test/ntuple_metrics.cxx

@@ -1,3 +1,6 @@
+#include "TEnv.h"
+#include "TKey.h"
+#include "TSystem.h"
 #include "ntuple_test.hxx"
 
 #include <cmath>
@@ -154,3 +157,97 @@ TEST(Metrics, IOMetrics)
       EXPECT_GT(szFile->GetValueAsInt(), 0);
    }
 }
+
+namespace {
+
+void WriteDummyEntries(std::string_view fileName, std::string_view ntupleName)
+{
+   auto model = RNTupleModel::Create();
+   auto pt = model->MakeField<float>("float_field");
+
+   auto writer = RNTupleWriter::Recreate(std::move(model), ntupleName, fileName);
+
+   *pt = 1.0;
+   writer->Fill();
+   writer->CommitDataset();
+}
+
+void ReadMetrics(const std::string fileName, std::ostream &output)
+{
+   TFile file(fileName.c_str());
+
+   std::set<std::string> ntupleNames;
+   for (auto *keyObject : *file.GetListOfKeys()) {
+      auto *key = static_cast<TKey *>(keyObject);
+      if (std::string(key->GetClassName()) == "ROOT::RNTuple")
+         ntupleNames.insert(key->GetName());
+   }
+
+   for (const auto &ntupleName : ntupleNames) {
+      auto reader = ROOT::RNTupleReader::Open(ntupleName, fileName);
+      const auto &descriptor = reader->GetDescriptor();
+
+      output << ntupleName << "\n\n";
+      for (auto counterId : descriptor.GetFieldZero().GetLinkIds()) {
+         std::string fieldName = descriptor.GetFieldDescriptor(counterId).GetFieldName();
+         std::string type = descriptor.GetFieldDescriptor(counterId).GetTypeName();
+
+         output << std::string(8, ' ') << fieldName << " (" << type << ")\n";
+      }
+      output << "\n";
+   }
+}
+} // namespace
+
+TEST(Metrics, EnvironmentVariableExport)
+{
+   FileRaii fileGuard("test_environment_variable_export_export.root");
+
+   const std::string metricsFileName = "environment_variable_export_metrics.root";
+
+   gSystem->Setenv("ROOT_EXPERIMENTAL_EXPORT_RNTUPLE_METRICS", metricsFileName.c_str());
+
+   WriteDummyEntries(fileGuard.GetPath().c_str(), "rntuple_name_1");
+   WriteDummyEntries(fileGuard.GetPath().c_str(), "rntuple_name_1");
+   WriteDummyEntries(fileGuard.GetPath().c_str(), "rntuple_name_2");
+
+   gSystem->Unsetenv("ROOT_EXPERIMENTAL_EXPORT_RNTUPLE_METRICS");
+
+   std::stringstream printedMetricsStream;
+   ReadMetrics(metricsFileName, printedMetricsStream);
+
+   const std::string printedMetricsString = std::move(printedMetricsStream).str();
+   const std::string expected = R"(rntuple_name_1
+
+        RNTupleWriter_RPageSinkBuf_ParallelZip (std::int64_t)
+        RNTupleWriter_RPageSinkBuf_timeWallZip (std::int64_t)
+        RNTupleWriter_RPageSinkBuf_timeWallCriticalSection (std::int64_t)
+        RNTupleWriter_RPageSinkBuf_timeCpuZip (std::int64_t)
+        RNTupleWriter_RPageSinkBuf_timeCpuCriticalSection (std::int64_t)
+        RNTupleWriter_RPageSinkBuf_RPageSinkFile_nPageCommitted (std::int64_t)
+        RNTupleWriter_RPageSinkBuf_RPageSinkFile_szWritePayload (std::int64_t)
+        RNTupleWriter_RPageSinkBuf_RPageSinkFile_szZip (std::int64_t)
+        RNTupleWriter_RPageSinkBuf_RPageSinkFile_timeWallWrite (std::int64_t)
+        RNTupleWriter_RPageSinkBuf_RPageSinkFile_timeWallZip (std::int64_t)
+        RNTupleWriter_RPageSinkBuf_RPageSinkFile_timeCpuWrite (std::int64_t)
+        RNTupleWriter_RPageSinkBuf_RPageSinkFile_timeCpuZip (std::int64_t)
+
+rntuple_name_2
+
+        RNTupleWriter_RPageSinkBuf_ParallelZip (std::int64_t)
+        RNTupleWriter_RPageSinkBuf_timeWallZip (std::int64_t)
+        RNTupleWriter_RPageSinkBuf_timeWallCriticalSection (std::int64_t)
+        RNTupleWriter_RPageSinkBuf_timeCpuZip (std::int64_t)
+        RNTupleWriter_RPageSinkBuf_timeCpuCriticalSection (std::int64_t)
+        RNTupleWriter_RPageSinkBuf_RPageSinkFile_nPageCommitted (std::int64_t)
+        RNTupleWriter_RPageSinkBuf_RPageSinkFile_szWritePayload (std::int64_t)
+        RNTupleWriter_RPageSinkBuf_RPageSinkFile_szZip (std::int64_t)
+        RNTupleWriter_RPageSinkBuf_RPageSinkFile_timeWallWrite (std::int64_t)
+        RNTupleWriter_RPageSinkBuf_RPageSinkFile_timeWallZip (std::int64_t)
+        RNTupleWriter_RPageSinkBuf_RPageSinkFile_timeCpuWrite (std::int64_t)
+        RNTupleWriter_RPageSinkBuf_RPageSinkFile_timeCpuZip (std::int64_t)
+
+)";
+
+   EXPECT_EQ(printedMetricsString, expected);
+}