[EMCAL-630] Suppress error messages above a maximum amount

Error messages settable via the configurable params.
In case error messages are suppressed the amount of
suppressed messages is counted and printed as
WARNING at when the component is destructed.

Author: mfasDa

Detectors/EMCAL/workflow/include/EMCALWorkflow/RawToCellConverterSpec.h

@@ -40,7 +40,7 @@ class RawToCellConverterSpec : public framework::Task
   RawToCellConverterSpec() : framework::Task(){};
 
   /// \brief Destructor
-  ~RawToCellConverterSpec() override = default;
+  ~RawToCellConverterSpec() override;
 
   /// \brief Initializing the RawToCellConverterSpec
   /// \param ctx Init context
@@ -55,11 +55,20 @@ class RawToCellConverterSpec : public framework::Task
   /// Output cells trigger record: {"EMC", "CELLSTR", 0, Lifetime::Timeframe}
   void run(framework::ProcessingContext& ctx) final;
 
+  /// \brief Set max number of error messages printed
+  /// \param maxMessages Max. amount of messages printed
+  ///
+  /// Error messages will be suppressed once the maximum is reached
+  void setMaxErrorMessages(int maxMessages) { mMaxErrorMessages = maxMessages; }
+
   void setNoiseThreshold(int thresold) { mNoiseThreshold = thresold; }
   int getNoiseThreshold() { return mNoiseThreshold; }
 
  private:
-  int mNoiseThreshold = 0;
+  int mNoiseThreshold = 0;                                      ///< Noise threshold in raw fit
+  int mNumErrorMessages = 0;                                    ///< Current number of error messages
+  int mErrorMessagesSuppressed = 0;                             ///< Counter of suppressed error messages
+  int mMaxErrorMessages = 100;                                  ///< Max. number of error messages
   o2::emcal::Geometry* mGeometry = nullptr;                     ///!<! Geometry pointer
   std::unique_ptr<o2::emcal::MappingHandler> mMapper = nullptr; ///!<! Mapper
   std::unique_ptr<o2::emcal::CaloRawFitter> mRawFitter;         ///!<! Raw fitter

Detectors/EMCAL/workflow/src/RawToCellConverterSpec.cxx

@@ -33,6 +33,13 @@
 
 using namespace o2::emcal::reco_workflow;
 
+RawToCellConverterSpec::~RawToCellConverterSpec()
+{
+  if (mErrorMessagesSuppressed) {
+    LOG(WARNING) << "Suppressed further " << mErrorMessagesSuppressed << " error messages";
+  }
+}
+
 void RawToCellConverterSpec::init(framework::InitContext& ctx)
 {
   LOG(DEBUG) << "[EMCALRawToCellConverter - init] Initialize converter ";
@@ -58,6 +65,9 @@ void RawToCellConverterSpec::init(framework::InitContext& ctx)
     mRawFitter = std::unique_ptr<CaloRawFitter>(new o2::emcal::CaloRawFitterGamma2);
   }
 
+  mMaxErrorMessages = ctx.options().get<int>("maxmessage");
+  LOG(INFO) << "Suppressing error messages after " << mMaxErrorMessages << " messages";
+
   mRawFitter->setAmpCut(mNoiseThreshold);
   mRawFitter->setL1Phase(0.);
 }
@@ -153,7 +163,15 @@ void RawToCellConverterSpec::run(framework::ProcessingContext& ctx)
           default:
             break;
         }
-        LOG(ERROR) << " EMCAL raw task: " << errormessage << " in Supermodule " << feeID << std::endl;
+        if (mNumErrorMessages < mMaxErrorMessages) {
+          LOG(ERROR) << " EMCAL raw task: " << errormessage << " in Supermodule " << feeID << std::endl;
+          mNumErrorMessages++;
+          if (mNumErrorMessages == mMaxErrorMessages) {
+            LOG(ERROR) << "Max. amount of error messages (" << mMaxErrorMessages << " reached, further messages will be suppressed";
+          }
+        } else {
+          mErrorMessagesSuppressed++;
+        }
         //fill histograms  with error types
         mOutputDecoderErrors.push_back(errornum);
         continue;
@@ -192,7 +210,15 @@ void RawToCellConverterSpec::run(framework::ProcessingContext& ctx)
             fitResults.setTime(0.);
           }
         } catch (CaloRawFitter::RawFitterError_t& fiterror) {
-          LOG(ERROR) << "Failure in raw fitting: " << CaloRawFitter::createErrorMessage(fiterror);
+          if (mNumErrorMessages < mMaxErrorMessages) {
+            LOG(ERROR) << "Failure in raw fitting: " << CaloRawFitter::createErrorMessage(fiterror);
+            mNumErrorMessages++;
+            if (mNumErrorMessages == mMaxErrorMessages) {
+              LOG(ERROR) << "Max. amount of error messages (" << mMaxErrorMessages << " reached, further messages will be suppressed";
+            }
+          } else {
+            mErrorMessagesSuppressed++;
+          }
           mOutputDecoderErrors.emplace_back(feeID, -1, CaloRawFitter::getErrorNumber(fiterror));
         }
         currentCellContainer->emplace_back(CellID, fitResults.getAmp() * CONVADCGEV, fitResults.getTime(), chantype);
@@ -234,5 +260,6 @@ o2::framework::DataProcessorSpec o2::emcal::reco_workflow::getRawToCellConverter
                                           outputs,
                                           o2::framework::adaptFromTask<o2::emcal::reco_workflow::RawToCellConverterSpec>(),
                                           o2::framework::Options{
-                                            {"fitmethod", o2::framework::VariantType::String, "standard", {"Fit method (standard or gamma2)"}}}};
+                                            {"fitmethod", o2::framework::VariantType::String, "standard", {"Fit method (standard or gamma2)"}},
+                                            {"maxmessage", o2::framework::VariantType::Int, 100, {"Max. amout of error messages to be displayed"}}}};
 }