TrigErrorMonTool Class Reference

Retrieves and monitors all non-success status codes returned by algorithms. More...

#include <TrigErrorMonTool.h>

Inheritance diagram for TrigErrorMonTool:

Collaboration diagram for TrigErrorMonTool:

Public Member Functions
	TrigErrorMonTool (const std::string &type, const std::string &name, const IInterface *parent)
virtual StatusCode	initialize () override
virtual StatusCode	finalize () override
virtual std::unordered_map< std::string_view, StatusCode >	algExecErrors (const EventContext &eventContext) const override
	Produce a subset of IAlgExecStateSvc::algExecStates with only non-success StatusCodes and fill relevant histograms. More...

Private Attributes
ServiceHandle< IAlgExecStateSvc >	m_aess {this, "AlgExecStateSvc", "AlgExecStateSvc"}
ServiceHandle< ITrigCostSvc >	m_trigCostSvcHandle {this, "TrigCostSvc", ""}
ToolHandle< GenericMonitoringTool >	m_monTool {this, "MonTool", "", "Monitoring tool"}
ToolHandle< TrigCompositeUtils::AlgToChainTool >	m_algToChainTool {this, "AlgToChainTool", "", "Tool to retrieve chains for algorithm"}

Detailed Description

Retrieves and monitors all non-success status codes returned by algorithms.

Definition at line 20 of file TrigErrorMonTool.h.

Constructor & Destructor Documentation

TrigErrorMonTool()

TrigErrorMonTool::TrigErrorMonTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Definition at line 11 of file TrigErrorMonTool.cxx.

: base_class(type, name, parent) {}

Member Function Documentation

algExecErrors()

std::unordered_map< std::string_view, StatusCode > TrigErrorMonTool::algExecErrors ( const EventContext &  eventContext ) const

overridevirtual

Produce a subset of IAlgExecStateSvc::algExecStates with only non-success StatusCodes and fill relevant histograms.

Definition at line 40 of file TrigErrorMonTool.cxx.

                                                                                                                   {
  std::unordered_map<std::string_view, StatusCode> algErrors;
  bool wasTimeout = false;
  for (const auto& [key, state] : m_aess->algExecStates(eventContext)) {
    if (!state.execStatus().isSuccess()) {
      ATH_MSG_DEBUG("Algorithm " << key << " returned StatusCode " << state.execStatus().message()
                    << " in event " << eventContext.eventID());
      algErrors[key.str()] = state.execStatus();
      auto monErrorAlgName = Monitored::Scalar<std::string>("ErrorAlgName", key.str());
      auto monErrorCode = Monitored::Scalar<std::string>("ErrorCode", state.execStatus().message());
      auto mon = Monitored::Group(m_monTool, monErrorAlgName, monErrorCode);
 
      if (m_algToChainTool.isEnabled()) {
        std::set<std::string> chainNames = m_algToChainTool->getActiveChainsForAlg(key.str(), eventContext);
        // Monitored::Collection requires operator[]
        std::vector<std::string> chainNamesVec(chainNames.begin(), chainNames.end());
 
        auto monErrorChainNames= Monitored::Collection<std::vector<std::string>>("ErrorChainName", chainNamesVec);
        Monitored::Group(m_monTool, monErrorChainNames, monErrorCode);
      }
 
      if (state.execStatus() == Athena::Status::TIMEOUT) {
        // Print report of most time consuming algorithms
        wasTimeout = true;
      }
    }
  }
 
  if (wasTimeout && !m_trigCostSvcHandle.empty()){
    std::string timeoutReport;
    if (m_trigCostSvcHandle->generateTimeoutReport(eventContext, timeoutReport) == StatusCode::FAILURE){
      ATH_MSG_ERROR("Generating timeout algorithm report failed.");
    }
    else if (timeoutReport.empty()){
      ATH_MSG_INFO("CostMonitoring not active in this event. A list of slow algorithms is not available.");
    }
    else {
      ATH_MSG_ERROR(timeoutReport);
    }
  }
 
  return algErrors;
}

finalize()

StatusCode TrigErrorMonTool::finalize ( )

overridevirtual

Definition at line 30 of file TrigErrorMonTool.cxx.

                                      {
  ATH_CHECK(m_monTool.release());
  ATH_CHECK(m_algToChainTool.release());
  ATH_CHECK(m_aess.release());
  return StatusCode::SUCCESS;
}

initialize()

StatusCode TrigErrorMonTool::initialize ( )

overridevirtual

Definition at line 17 of file TrigErrorMonTool.cxx.

                                        {
  ATH_CHECK(m_monTool.retrieve(DisableTool{m_monTool.name().empty()}));
  ATH_CHECK(m_algToChainTool.retrieve(DisableTool{m_algToChainTool.name().empty()}));
  ATH_CHECK(m_aess.retrieve());
  
  if (!m_trigCostSvcHandle.empty()) ATH_CHECK(m_trigCostSvcHandle.retrieve());
 
  return StatusCode::SUCCESS;
}

Member Data Documentation

m_aess

ServiceHandle<IAlgExecStateSvc> TrigErrorMonTool::m_aess {this, "AlgExecStateSvc", "AlgExecStateSvc"}

private

Definition at line 33 of file TrigErrorMonTool.h.

m_algToChainTool

ToolHandle<TrigCompositeUtils::AlgToChainTool> TrigErrorMonTool::m_algToChainTool {this, "AlgToChainTool", "", "Tool to retrieve chains for algorithm"}

private

Definition at line 36 of file TrigErrorMonTool.h.

m_monTool

ToolHandle<GenericMonitoringTool> TrigErrorMonTool::m_monTool {this, "MonTool", "", "Monitoring tool"}

private

Definition at line 35 of file TrigErrorMonTool.h.

m_trigCostSvcHandle

ServiceHandle<ITrigCostSvc> TrigErrorMonTool::m_trigCostSvcHandle {this, "TrigCostSvc", ""}

private

Definition at line 34 of file TrigErrorMonTool.h.

---

The documentation for this class was generated from the following files:

• TrigErrorMonTool.h
• TrigErrorMonTool.cxx