Remove all objects in consul at end of activity (QC-250) (#268)

Author: Barthelemy

Framework/include/QualityControl/ObjectsManager.h

@@ -118,6 +118,13 @@ class ObjectsManager
    */
   void updateServiceDiscovery();
 
+  /**
+   * \brief Remove all objects from the ServiceDiscovery.
+   * Remove all objects from the ServiceDiscovery even though they still might be published by the task.
+   * This is typically used at End of Activity.
+   */
+  void removeAllFromServiceDiscovery();
+
  private:
   std::unique_ptr<TObjArray> mMonitorObjects;
   TaskConfig& mTaskConfig;

Framework/include/QualityControl/ServiceDiscovery.h

@@ -42,11 +42,11 @@ class ServiceDiscovery
   /// Stops the health thread and deregisteres from Consul health checks
   ~ServiceDiscovery();
 
-  /// Registeres list of online objects by sending HTTP PUT request to Consul server
+  /// Registers list of online objects by sending HTTP PUT request to Consul server
   /// \param objects 		List of comma separated objects
   void _register(const std::string& objects);
 
-  /// Deregisteres service
+  /// Deregisters service
   void deregister();
 
  private:

Framework/src/ObjectsManager.cxx

@@ -72,6 +72,15 @@ void ObjectsManager::updateServiceDiscovery()
   mUpdateServiceDiscovery = false;
 }
 
+void ObjectsManager::removeAllFromServiceDiscovery()
+{
+  if (mServiceDiscovery == nullptr) {
+    return;
+  }
+  mServiceDiscovery->_register("");
+  mUpdateServiceDiscovery = true;
+}
+
 void ObjectsManager::stopPublishing(TObject* object)
 {
   stopPublishing(object->GetName());

Framework/src/ServiceDiscovery.cxx

@@ -20,6 +20,7 @@
 #include <boost/property_tree/json_parser.hpp>
 #include <boost/algorithm/string/split.hpp>
 #include <boost/algorithm/string.hpp>
+#include "QualityControl/QcInfoLogger.h"
 
 namespace o2::quality_control::core
 {
@@ -90,11 +91,13 @@ void ServiceDiscovery::_register(const std::string& objects)
   boost::property_tree::json_parser::write_json(ss, pt);
 
   send("/v1/agent/service/register", ss.str());
+  QcInfoLogger::GetInstance() << "Registration to ServiceDiscovery" << AliceO2::InfoLogger::InfoLogger::endm;
 }
 
 void ServiceDiscovery::deregister()
 {
   send("/v1/agent/service/deregister/" + mId, "");
+  QcInfoLogger::GetInstance() << "Deregistration from ServiceDiscovery" << AliceO2::InfoLogger::InfoLogger::endm;
 }
 
 void ServiceDiscovery::runHealthServer(unsigned int port)

Framework/src/TaskFactory.cxx

@@ -15,7 +15,6 @@
 
 #include "QualityControl/TaskFactory.h"
 
-#include "QualityControl/QcInfoLogger.h"
 #include "RootClassFactory.h"
 
 namespace o2::quality_control::core

Framework/src/TaskRunner.cxx

@@ -314,13 +314,15 @@ void TaskRunner::startOfActivity()
   Activity activity(mConfigFile->get<int>("qc.config.Activity.number"),
                     mConfigFile->get<int>("qc.config.Activity.type"));
   mTask->startOfActivity(activity);
+  mObjectsManager->updateServiceDiscovery();
 }
 
 void TaskRunner::endOfActivity()
 {
   Activity activity(mConfigFile->get<int>("qc.config.Activity.number"),
                     mConfigFile->get<int>("qc.config.Activity.type"));
   mTask->endOfActivity(activity);
+  mObjectsManager->removeAllFromServiceDiscovery();
 
   double rate = mTotalNumberObjectsPublished / mTimerTotalDurationActivity.getTime();
   mCollector->send({ rate, "QC_task_Rate_objects_published_per_second_whole_run" });