Give the possibility to save the debug messages to the discardFile. (#1952)

* Give the possibility to save the debug messages to the discardFile.

* Update TaskRunner.cxx

Author: Barthelemy

Framework/include/QualityControl/DiscardFileParameters.h

@@ -28,6 +28,7 @@ struct DiscardFileParameters {
   std::string discardFile;
   unsigned long rotateMaxBytes = 0;
   unsigned int rotateMaxFiles = 0;
+  bool debugInDiscardFile = false;
 };
 
 } // namespace o2::quality_control::core

Framework/src/InfrastructureSpecReader.cxx

@@ -76,7 +76,8 @@ CommonSpec InfrastructureSpecReader::readSpecEntry<CommonSpec>(const std::string
     commonTree.get<int>("infologger.filterDiscardLevel", spec.infologgerDiscardParameters.fromLevel),
     commonTree.get<std::string>("infologger.filterDiscardFile", spec.infologgerDiscardParameters.discardFile),
     commonTree.get<u_long>("infologger.filterRotateMaxBytes", spec.infologgerDiscardParameters.rotateMaxBytes),
-    commonTree.get<u_int>("infologger.filterRotateMaxFiles", spec.infologgerDiscardParameters.rotateMaxFiles)
+    commonTree.get<u_int>("infologger.filterRotateMaxFiles", spec.infologgerDiscardParameters.rotateMaxFiles),
+    commonTree.get<bool>("infologger.debugInDiscardFile", spec.infologgerDiscardParameters.debugInDiscardFile)
   };
   spec.postprocessingPeriod = commonTree.get<double>("postprocessing.periodSeconds", spec.postprocessingPeriod);
   spec.bookkeepingUrl = commonTree.get<std::string>("bookkeeping.url", spec.bookkeepingUrl);

Framework/src/QcInfoLogger.cxx

@@ -78,10 +78,10 @@ void QcInfoLogger::init(const std::string& facility,
   ILOG_INST.filterDiscardDebug(discardFileParameters.debug);
   ILOG_INST.filterDiscardLevel(discardFileParameters.fromLevel);
   if (!discardFileParameters.discardFile.empty()) {
-    ILOG_INST.filterDiscardSetFile(discardFileParameters.discardFile.c_str(), discardFileParameters.rotateMaxBytes, discardFileParameters.rotateMaxFiles, 0, true /*Do not store Debug messages in file*/);
+    ILOG_INST.filterDiscardSetFile(discardFileParameters.discardFile.c_str(), discardFileParameters.rotateMaxBytes, discardFileParameters.rotateMaxFiles, 0, discardFileParameters.debugInDiscardFile /*Do not store Debug messages in file*/);
   }
   ILOG(Debug, Support) << "QC infologger initialized : " << discardFileParameters.debug << " ; " << discardFileParameters.fromLevel << ENDM;
-  ILOG(Debug, Devel) << "   Discard debug ? " << discardFileParameters.debug << " / Discard from level ? " << discardFileParameters.fromLevel << " / Discard to file ? " << (!discardFileParameters.discardFile.empty() ? discardFileParameters.discardFile : "No") << " / Discard max bytes and files ? " << discardFileParameters.rotateMaxBytes << " = " << discardFileParameters.rotateMaxFiles << ENDM;
+  ILOG(Debug, Devel) << "   Discard debug ? " << discardFileParameters.debug << " / Discard from level ? " << discardFileParameters.fromLevel << " / Discard to file ? " << (!discardFileParameters.discardFile.empty() ? discardFileParameters.discardFile : "No") << " / Discard max bytes and files ? " << discardFileParameters.rotateMaxBytes << " = " << discardFileParameters.rotateMaxFiles << " / Put discarded debug messages in file ? " << discardFileParameters.debugInDiscardFile << ENDM;
 
   setFacility(facility);
   setRun(run);
@@ -102,6 +102,8 @@ void QcInfoLogger::init(const std::string& facility,
   discardFileParameters.discardFile = config.get<std::string>("qc.config.infologger.filterDiscardFile", "");
   discardFileParameters.rotateMaxBytes = config.get<u_long>("infologger.filterRotateMaxBytes", 0);
   discardFileParameters.rotateMaxFiles = config.get<u_int>("infologger.filterRotateMaxFiles", 0);
+  std::string debugInDiscardFile = config.get<std::string>("qc.config.infologger.debugInDiscardFile", "false");
+  discardFileParameters.debugInDiscardFile = debugInDiscardFile == "true";
   init(facility, discardFileParameters, dplInfoLogger, dplContext, run, partitionName);
 }
 

doc/Advanced.md

@@ -1239,10 +1239,10 @@ should not be present in real configuration files.
         "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>)",
-                                              "The keyword _ID_, if used, is replaced by the device ID.",
-                                              "Discarded Debug messages don't go there."],
+                                              "The keyword _ID_, if used, is replaced by the device ID."],
         "filterRotateMaxBytes": "",       "": "Maximum size of the discard file.", 
-        "filterRotateMaxFiles": "",       "": "Maximum number of discard files."
+        "filterRotateMaxFiles": "",       "": "Maximum number of discard files.",
+        "debugInDiscardFile": "false",    "": "If true, the debug discarded messages go to the file (default: false)."
       },
       "bookkeeping": {                    "": "Configuration of the bookkeeping (optional)",
         "url": "localhost:4001",          "": "Url of the bookkeeping API (port is usually different from web interface)"