[QC-854] Add templating to the discard log file (#1449)

* [QC-854] Add templating to the discard log file

* format

* fix

* remove redundant comment

* remove include

* remove include

* fix

* fpormat

* Update runnerUtils.h

* fix

Author: Barthelemy

Framework/basic.json

@@ -28,7 +28,8 @@
       "infologger": {                     "": "Configuration of the Infologger (optional).",
         "filterDiscardDebug": "true",    "": "Set to true to discard debug and trace messages (default: false)",
         "filterDiscardLevel": "11",       "": "Message at this level or above are discarded (default: 21 - Trace)",
-        "filterDiscardFile": "/tmp/test.txt",  "": "If set, the discarded messages will go to this file (default: <none>)"
+        "filterDiscardFile": "/tmp/_ID_-test.txt",  "": "If set, the discarded messages will go to this file (default: <none>)",
+        ""                                            : "The keyword _ID_ is replaced by the device id."
       }
     },
     "tasks": {

Framework/include/QualityControl/TaskRunnerConfig.h

@@ -47,7 +47,7 @@ struct TaskRunnerConfig {
   int resetAfterCycles = 0;
   bool infologgerFilterDiscardDebug = false;
   int infologgerDiscardLevel = 21;
-  std::string infologgerDiscardFile = "";
+  std::string infologgerDiscardFile{};
   Activity fallbackActivity;
 };
 

Framework/include/QualityControl/runnerUtils.h

@@ -21,12 +21,14 @@
 #include <Configuration/ConfigurationFactory.h>
 #include <Common/Exceptions.h>
 #include <Framework/RawDeviceService.h>
+#include <Framework/DeviceSpec.h>
 #include <fairmq/Device.h>
 #include <Framework/ConfigParamRegistry.h>
 #include <QualityControl/QcInfoLogger.h>
 #include <boost/property_tree/json_parser.hpp>
 #include <CommonUtils/StringUtils.h>
 #include "QualityControl/Activity.h"
+#include <regex>
 
 namespace o2::quality_control::core
 {
@@ -184,6 +186,23 @@ inline void overrideValues(boost::property_tree::ptree& tree, std::vector<std::p
   }
 }
 
+/**
+ * template the param infologgerDiscardFile (_ID_->[device-id])
+ * @param originalFile
+ * @param iCtx
+ * @return
+ */
+inline std::string templateILDiscardFile(std::string& originalFile, framework::InitContext& iCtx)
+{
+  try {
+    auto& deviceSpec = iCtx.services().get<o2::framework::DeviceSpec const>();
+    return std::regex_replace(originalFile, std::regex("_ID_"), deviceSpec.id);
+  } catch (...) {
+    ILOG(Error, Devel) << "exception caught and swallowed in templateILDiscardFile : " << boost::current_exception_diagnostic_information() << ENDM;
+  }
+  return originalFile;
+}
+
 } // namespace o2::quality_control::core
 
 #endif // QUALITYCONTROL_RUNNERUTILS_H

Framework/src/AggregatorRunner.cxx

@@ -299,6 +299,8 @@ void AggregatorRunner::initAggregators()
 
 void AggregatorRunner::initInfoLogger(InitContext& iCtx)
 {
+  // TODO : the method should be merged with the other, similar, methods in *Runners
+
   InfoLoggerContext* ilContext = nullptr;
   AliceO2::InfoLogger::InfoLogger* il = nullptr;
   try {
@@ -307,7 +309,14 @@ void AggregatorRunner::initInfoLogger(InitContext& iCtx)
   } catch (const RuntimeErrorRef& err) {
     ILOG(Error) << "Could not find the DPL InfoLogger." << ENDM;
   }
-  QcInfoLogger::init("aggregator", mRunnerConfig.infologgerFilterDiscardDebug, mRunnerConfig.infologgerDiscardLevel, mRunnerConfig.infologgerDiscardFile, il, ilContext);
+
+  mRunnerConfig.infologgerDiscardFile = templateILDiscardFile(mRunnerConfig.infologgerDiscardFile, iCtx);
+  QcInfoLogger::init("aggregator",
+                     mRunnerConfig.infologgerFilterDiscardDebug,
+                     mRunnerConfig.infologgerDiscardLevel,
+                     mRunnerConfig.infologgerDiscardFile,
+                     il,
+                     ilContext);
 }
 
 void AggregatorRunner::initLibraries()

Framework/src/CheckRunner.cxx

@@ -477,6 +477,8 @@ void CheckRunner::initServiceDiscovery()
 
 void CheckRunner::initInfologger(framework::InitContext& iCtx)
 {
+  // TODO : the method should be merged with the other, similar, methods in *Runners
+
   InfoLoggerContext* ilContext = nullptr;
   AliceO2::InfoLogger::InfoLogger* il = nullptr;
   try {
@@ -485,6 +487,8 @@ void CheckRunner::initInfologger(framework::InitContext& iCtx)
   } catch (const RuntimeErrorRef& err) {
     ILOG(Error) << "Could not find the DPL InfoLogger." << ENDM;
   }
+
+  mConfig.infologgerDiscardFile = templateILDiscardFile(mConfig.infologgerDiscardFile, iCtx);
   QcInfoLogger::init(createCheckRunnerFacility(mDeviceName),
                      mConfig.infologgerFilterDiscardDebug,
                      mConfig.infologgerDiscardLevel,

Framework/src/InfrastructureSpecReader.cxx

@@ -22,7 +22,6 @@
 
 #include <DataSampling/DataSampling.h>
 #include <Framework/DataDescriptorQueryBuilder.h>
-#include <boost/property_tree/ptree.hpp>
 
 using namespace o2::utilities;
 using namespace o2::framework;

Framework/src/TaskRunner.cxx

@@ -105,6 +105,8 @@ void TaskRunner::refreshConfig(InitContext& iCtx)
 
 void TaskRunner::initInfologger(InitContext& iCtx)
 {
+  // TODO : the method should be merged with the other, similar, methods in *Runners
+
   AliceO2::InfoLogger::InfoLoggerContext* ilContext = nullptr;
   AliceO2::InfoLogger::InfoLogger* il = nullptr;
   try {
@@ -113,6 +115,8 @@ void TaskRunner::initInfologger(InitContext& iCtx)
   } catch (const RuntimeErrorRef& err) {
     ILOG(Error, Devel) << "Could not find the DPL InfoLogger" << ENDM;
   }
+
+  mTaskConfig.infologgerDiscardFile = templateILDiscardFile(mTaskConfig.infologgerDiscardFile, iCtx);
   QcInfoLogger::init("task/" + mTaskConfig.taskName,
                      mTaskConfig.infologgerFilterDiscardDebug,
                      mTaskConfig.infologgerDiscardLevel,

doc/Advanced.md

@@ -900,7 +900,8 @@ should not be present in real configuration files.
       "infologger": {                     "": "Configuration of the Infologger (optional).",
         "filterDiscardDebug": "false",    "": "Set to 1 to discard debug and trace messages (default: false)",
         "filterDiscardLevel": "2",        "": "Message at this level or above are discarded (default: 21 - Trace)",
-        "filterDiscardFile": "",          "": "If set, the discarded messages will go to this file (default: <none>)"
+        "filterDiscardFile": "",          "": ["If set, the discarded messages will go to this file (default: <none>)",
+                                              "The keyword _ID_, if used, is replaced by the device ID."]
       },
       "postprocessing": {                 "": "Configuration parameters for post-processing",
         "periodSeconds": 10.0,            "": "Sets the interval of checking all the triggers. One can put a very small value",