IssueLogger Class Reference

#include <src/IssueLogger.h>

Inheritance diagram for IssueLogger:

Collaboration diagram for IssueLogger:

Classes
class	logger_t

Public Member Functions
	IssueLogger (const std::string &name, ISvcLocator *svc)
	~IssueLogger () override=default
StatusCode	initialize () override
StatusCode	reinitialize () override
StatusCode	finalize () override
void	report (IssueSeverity::Level level, const std::string &msg, const std::string &origin) override
void	report (const IssueSeverity &err) override
Public Member Functions inherited from extends< BASE, Interfaces >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	~extends () override=default
	Virtual destructor. More...
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	~extends () override=default
	Virtual destructor. More...
Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...
	~extend_interfaces () override=default
	Virtual destructor. More...

Private Member Functions
StatusCode	connect (const std::string &)
void	setupDefaultLogger ()
void	setupLevels (Property &prop)
void	setupStreams (Property &prop)

Private Attributes
StringArrayProperty	m_outputfile
StringProperty	m_reportLevelS
StringProperty	m_traceLevelS
BooleanProperty	m_showTime
IssueSeverity::Level	m_reportLevel
IssueSeverity::Level	m_traceLevel
std::array< logger_t, IssueSeverity::NUM_LEVELS >	m_log

Additional Inherited Members
Public Types inherited from extends< BASE, Interfaces >
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...
Public Types inherited from extend_interfaces< Interfaces...>
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...

Detailed Description

Definition at line 14 of file IssueLogger.h.

Constructor & Destructor Documentation

IssueLogger::IssueLogger	(	const std::string &	name,
		ISvcLocator *	svc
	)

Definition at line 72 of file IssueLogger.cpp.

  : base_class(name, svc) {

  declareProperty ("Output", m_outputfile );
  declareProperty ("ReportLevel", m_reportLevelS="WARNING");
  declareProperty ("TracebackLevel", m_traceLevelS="ERROR");
  declareProperty ("ShowTime", m_showTime=false);

  m_reportLevelS.declareUpdateHandler(&IssueLogger::setupLevels,this);
  m_traceLevelS.declareUpdateHandler(&IssueLogger::setupLevels,this);
  m_outputfile.declareUpdateHandler(&IssueLogger::setupStreams,this);

  m_reportLevel = IssueSeverity::WARNING;
  m_traceLevel  = IssueSeverity::ERROR;

}

IssueLogger::~IssueLogger ( )

overridedefault

Member Function Documentation

StatusCode IssueLogger::connect ( const std::string &  ident )

private

Definition at line 126 of file IssueLogger.cpp.

                                           {

  MsgStream log ( msgSvc(), name() );

  auto loc = ident.find(" ");
  using Parser = Gaudi::Utils::AttribStringParser;
  // note: if loc == string::npos then loc + 1 == 0
  for (auto attrib: Parser(ident.substr(loc + 1))) {
    toupper(attrib.tag);
    IssueSeverity::Level level;
    if (attrib.tag == "DEBUG") {               level = IssueSeverity::DEBUG;
    } else if ( attrib.tag == "INFO") {        level = IssueSeverity::INFO;
    } else if ( attrib.tag == "WARNING") {     level = IssueSeverity::WARNING;
    } else if ( attrib.tag == "RECOVERABLE") { level = IssueSeverity::RECOVERABLE;
    } else if ( attrib.tag == "ERROR") {       level = IssueSeverity::ERROR;
    } else if ( attrib.tag == "FATAL") {       level = IssueSeverity::FATAL;
    } else {
      log << MSG::ERROR << "Unknown output level \"" << attrib.tag << "\""
      << endmsg;
      continue;
    }

    if (m_log[level]) {
      log << MSG::INFO << "closing stream " << m_log[level].name() << endmsg;
      m_log[level].reset();
    }

    if (attrib.value == "MsgSvc") {
      m_log[level] = { new StreamLogger(msgSvc(), s_sevMsgMap.at(level)) , &StreamLogger::WriteToMsgSvc };
    } else if (attrib.value == "STDERR") {
      m_log[level] = { new StreamLogger(std::cerr), &StreamLogger::WriteToStream };
    } else if (attrib.value == "STDOUT") {
      m_log[level] = { new StreamLogger(std::cout),  &StreamLogger::WriteToStream };
    } else { // A file
      try {
        m_log[level] = { new StreamLogger(attrib.value), &StreamLogger::WriteToStream };
      }
      catch (std::exception&) {
        m_log[level].reset();
        log << MSG::ERROR << "Unable to open file \"" << attrib.value
            << "\" for writing issues at level " << attrib.tag << endmsg;
        return StatusCode::FAILURE;
      }
    }
    log << MSG::DEBUG << "Writing " << s_levelTrans.at(level)
                      << " issues to " << m_log[level].name() << endmsg;
  }
  return StatusCode::SUCCESS;
}

StatusCode IssueLogger::finalize ( )

override

Definition at line 113 of file IssueLogger.cpp.

                      {

  MsgStream log ( msgSvc(), name() );
  log << MSG::DEBUG << "IssueLogger::finalize" << endmsg;
  std::for_each( std::begin(m_log), std::end(m_log), 
                 [](logger_t& i) 
                 { i.reset(); } );
  return Service::finalize();
}

StatusCode IssueLogger::initialize ( )

override

Definition at line 92 of file IssueLogger.cpp.

                        {

  StatusCode st = Service::initialize();
  if (st.isSuccess()) { setupDefaultLogger(); }
  return st;
}

StatusCode IssueLogger::reinitialize ( )

override

Definition at line 102 of file IssueLogger.cpp.

                          {

  MsgStream log ( msgSvc(), name() );
  log << MSG::WARNING << "reinitialize not implemented" << endmsg;
  return StatusCode::SUCCESS;

}

void IssueLogger::report ( IssueSeverity::Level  level, const std::string &  msg, const std::string &  origin  )

override

Definition at line 179 of file IssueLogger.cpp.

                                          {
  if ( lev < m_reportLevel) return;
  std::string msg = s_levelTrans.at(lev) + "  " + org + "  \"" + str + "\"";
  if (m_showTime) msg += " [" + Gaudi::Time::current().format(true, "%H:%M:%S %Y/%m/%d %Z") +"]";
  if (lev >= m_traceLevel) msg += "\n" + getTraceBack();
  m_log[lev](msg);
}

void IssueLogger::report ( const IssueSeverity &  err )

override

Definition at line 191 of file IssueLogger.cpp.

                                              {
  report(err.getLevel(), err.getMsg(), err.getOrigin());
}

void IssueLogger::setupDefaultLogger ( )

private

Definition at line 254 of file IssueLogger.cpp.

                                {
  for (int i=1; i<IssueSeverity::NUM_LEVELS; ++i) {
    if (!m_log[i]) {
      // default: dump to msgSvc
      IssueSeverity::Level j = IssueSeverity::Level (i);
      m_log[j] = {  new StreamLogger(msgSvc(), s_sevMsgMap.at(j)) , &StreamLogger::WriteToMsgSvc };
      MsgStream log ( msgSvc(), name() );
      log << MSG::DEBUG << "Writing " << s_levelTrans.at(j)
                        << " issues to " << m_log[j].name() << endmsg;
    }
  }
}

void IssueLogger::setupLevels ( Property &  prop )

private

Definition at line 198 of file IssueLogger.cpp.

                                       {

  StringProperty *sap = dynamic_cast<StringProperty*> (&prop);
  if (!sap) {
    MsgStream log ( msgSvc(), name() );
    log << MSG::ERROR << "Could not convert " << prop.name()
        << "to a StringProperty (which it should be!)" << endmsg;
    return;
  }

  const std::string& val = sap->value();
  auto set = [&](IssueSeverity::Level& key, IssueSeverity::Level def) {
    if (s_levelSTrans.find(val) == s_levelSTrans.end()) {
      key = def;
      MsgStream log ( this->msgSvc(), this->name() );
      log << MSG::ERROR << "Option " << prop.name() << ": unknown Issue Severity level \""
                        << val << "\". Setting it " << s_levelTrans.at(def) << endmsg;
    } else {
      key = s_levelSTrans.at(val);
    }
  };

  if (prop.name() == "ReportLevel") {
    set(m_reportLevel, IssueSeverity::WARNING );
  } else if (prop.name() == "TracebackLevel") {
    set(m_traceLevel, IssueSeverity::ERROR );
  } else {
    MsgStream log ( msgSvc(), name() );
    log << MSG::ERROR << "setting up unknown property \"" 
                      << prop.name() << "\"" << endmsg;
  }
}

void IssueLogger::setupStreams ( Property &  prop )

private

Definition at line 234 of file IssueLogger.cpp.

                                        {

  StringArrayProperty *sap = dynamic_cast<StringArrayProperty*>( &prop );
  if ( !sap ) {
    MsgStream log ( msgSvc(), name() );
    log << MSG::ERROR << "Could not convert " << prop.name()
    << "to a StringArrayProperty (which it should be!)" << endmsg;
    return;
  }
  for (const auto& s : sap->value() ) {
    if (connect(s).isFailure()) {
      MsgStream log ( msgSvc(), name() );
      log << MSG::ERROR << "Could not setup stream " << s << endmsg;
    }
  }
}

Member Data Documentation

std::array<logger_t,IssueSeverity::NUM_LEVELS> IssueLogger::m_log

private

Definition at line 46 of file IssueLogger.h.

StringArrayProperty IssueLogger::m_outputfile

private

Definition at line 29 of file IssueLogger.h.

IssueSeverity::Level IssueLogger::m_reportLevel

private

Definition at line 32 of file IssueLogger.h.

StringProperty IssueLogger::m_reportLevelS

private

Definition at line 30 of file IssueLogger.h.

BooleanProperty IssueLogger::m_showTime

private

Definition at line 31 of file IssueLogger.h.

IssueSeverity::Level IssueLogger::m_traceLevel

private

Definition at line 32 of file IssueLogger.h.

StringProperty IssueLogger::m_traceLevelS

private

Definition at line 30 of file IssueLogger.h.

---

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

• GaudiMonitor/src/IssueLogger.h
• GaudiMonitor/src/IssueLogger.cpp