[QC-1296] Registering the QC tasks in BK must be the default behaviour (#2573)

* [QC-1296] Registering the QC tasks in BK must be the default behaviour

* doc

Author: Barthelemy

Framework/src/AggregatorRunner.cxx

@@ -378,7 +378,7 @@ void AggregatorRunner::start(ServiceRegistryRef services)
   }
 
   // register ourselves to the BK
-  if (gSystem->Getenv("O2_QC_REGISTER_IN_BK")) { // until we are sure it works, we have to turn it on
+  if (!gSystem->Getenv("O2_QC_DONT_REGISTER_IN_BK")) { // Set this variable to disable the registration
     ILOG(Debug, Devel) << "Registering aggregator to BookKeeping" << ENDM;
     try {
       Bookkeeping::getInstance().registerProcess(mActivity->mId, mDeviceName, AggregatorRunner::getDetectorName(mAggregators), bkp::DplProcessType::QC_AGGREGATOR, "");

Framework/src/CheckRunner.cxx

@@ -455,7 +455,7 @@ void CheckRunner::start(ServiceRegistryRef services)
   }
 
   // register ourselves to the BK
-  if (gSystem->Getenv("O2_QC_REGISTER_IN_BK")) { // until we are sure it works, we have to turn it on
+  if (!gSystem->Getenv("O2_QC_DONT_REGISTER_IN_BK")) { // Set this variable to disable the registration
     ILOG(Debug, Devel) << "Registering checkRunner to BookKeeping" << ENDM;
     try {
       Bookkeeping::getInstance().registerProcess(mActivity->mId, mDeviceName, mDetectorName, bkp::DplProcessType::QC_CHECKER, "");

Framework/src/PostProcessingRunner.cxx

@@ -187,7 +187,7 @@ void PostProcessingRunner::start(framework::ServiceRegistryRef dplServices)
   QcInfoLogger::setRun(mActivity.mId);
 
   // register ourselves to the BK
-  if (gSystem->Getenv("O2_QC_REGISTER_IN_BK")) { // until we are sure it works, we have to turn it on
+  if (!gSystem->Getenv("O2_QC_DONT_REGISTER_IN_BK")) { // Set this variable to disable the registration
     ILOG(Debug, Devel) << "Registering pp task to BookKeeping" << ENDM;
     try {
       Bookkeeping::getInstance().registerProcess(mActivity.mId, mRunnerConfig.taskName, mRunnerConfig.detectorName, bkp::DplProcessType::QC_POSTPROCESSING, "");

Framework/src/TaskRunner.cxx

@@ -306,11 +306,6 @@ void TaskRunner::start(ServiceRegistryRef services)
   mNoMoreCycles = false;
   mCycleNumber = 0;
 
-  if (gSystem->Getenv("O2_QC_REGISTER_IN_BK_AT_START")) {
-    // until we are sure it works, we have to turn it on
-    registerToBookkeeping();
-  }
-
   try {
     startOfActivity();
     startCycle();
@@ -442,13 +437,6 @@ void TaskRunner::registerToBookkeeping()
   ILOG(Debug, Devel) << "Registering taskRunner to BookKeeping" << ENDM;
   try {
     Bookkeeping::getInstance().registerProcess(mActivity.mId, mTaskConfig.taskName, mTaskConfig.detectorName, bkp::DplProcessType::QC_TASK, "");
-    if (gSystem->Getenv("O2_QC_REGISTER_IN_BK_X_TIMES")) {
-      ILOG(Debug, Devel) << "O2_QC_REGISTER_IN_BK_X_TIMES set to " << gSystem->Getenv("O2_QC_REGISTER_IN_BK_X_TIMES") << ENDM;
-      int iterations = std::stoi(gSystem->Getenv("O2_QC_REGISTER_IN_BK_X_TIMES"));
-      for (int i = 1; i < iterations; i++) { // start at 1 because we already did it once
-        Bookkeeping::getInstance().registerProcess(mActivity.mId, mTaskConfig.taskName, mTaskConfig.detectorName, bkp::DplProcessType::QC_TASK, "");
-      }
-    }
   } catch (std::runtime_error& error) {
     ILOG(Warning, Devel) << "Failed registration to the BookKeeping: " << error.what() << ENDM;
   }
@@ -465,8 +453,7 @@ void TaskRunner::finishCycle(DataAllocator& outputs)
     << "(" << mTimekeeper->getTimerangeIdRange().getMin() << ", " << mTimekeeper->getTimerangeIdRange().getMax() << ")" << ENDM;
   mTask->endOfCycle();
 
-  if (mCycleNumber == 0 && gSystem->Getenv("O2_QC_REGISTER_IN_BK")) {
-    // until we are sure it works, we have to turn it on
+  if (mCycleNumber == 0) { // register at the end of the first cycle
     registerToBookkeeping();
   }
 

doc/Framework.md

@@ -673,6 +673,11 @@ Null QOs are marked with purple.
 
 ![](images/qo_flag_conversion_10.svg)
 
+## Registration of QC devices into the BookKeeping
+
+By default, the QC tasks, PP tasks, check runners, and aggregators are registered in the BK. 
+To disable this behaviour, pass the following environment variable : `O2_QC_DONT_REGISTER_IN_BK` (in the ECS). 
+
 ## Solving performance issues
 
 Problems with performance in message passing systems like QC usually manifest in backpressure seen in input channels of processes which are too slow.