#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< Service, IIssueLogger >
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 Service
const std::string &	name () const override
	Retrieve name of the service. More...

StatusCode	configure () override

StatusCode	initialize () override

StatusCode	start () override

StatusCode	stop () override

StatusCode	finalize () override

StatusCode	terminate () override

Gaudi::StateMachine::State	FSMState () const override

Gaudi::StateMachine::State	targetFSMState () const override

StatusCode	reinitialize () override

StatusCode	restart () override

StatusCode	sysInitialize () override
	Initialize Service. More...

StatusCode	sysStart () override
	Initialize Service. More...

StatusCode	sysStop () override
	Initialize Service. More...

StatusCode	sysFinalize () override
	Finalize Service. More...

StatusCode	sysReinitialize () override
	Re-initialize the Service. More...

StatusCode	sysRestart () override
	Re-initialize the Service. More...

StatusCode	setProperty (const Property &p) override

StatusCode	setProperty (const std::string &s) override

StatusCode	setProperty (const std::string &n, const std::string &v) override

StatusCode	getProperty (Property *p) const override

const Property &	getProperty (const std::string &name) const override

StatusCode	getProperty (const std::string &n, std::string &v) const override

const std::vector< Property * > &	getProperties () const override

bool	hasProperty (const std::string &name) const override

template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...

	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor. More...

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator. More...

StatusCode	setProperties ()
	Method for setting declared properties to the values specified for the job. More...

template<class T >
StatusCode	service (const std::string &name, const T *&psvc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist. More...

template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const

template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const

template<class T >
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
	Access a service by name and type, creating it if it doesn't already exist. More...

template<class T >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...

Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
	Declare remote named properties. More...

template<class T >
StatusCode	declarePrivateTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Private tool. More...

template<class T >
StatusCode	declarePublicTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Public tool. More...

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor. More...

SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service. More...

MsgStream &	msgStream () const
	Return an uninitialized MsgStream. More...

MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts. More...

MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS) More...

MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL) More...

MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR) More...

MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR) More...

MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING) More...

MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO) More...

MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG) More...

MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE) More...

MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO) More...

MSG::Level	msgLevel () const
	get the output level from the embedded MsgStream More...

MSG::Level	outputLevel () const __attribute__((deprecated))
	Backward compatibility function for getting the output level. More...

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...

Public Member Functions inherited from extend_interfaces< Interfaces...>
	~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< Service, IIssueLogger >
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 Service
typedef Gaudi::PluginService::Factory< IService , const std::string &, ISvcLocator >	Factory

Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class = CommonMessaging

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...

Protected Member Functions inherited from Service
	~Service () override
	Standard Destructor. More...

int	outputLevel () const
	get the `Service's` output level More...

Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Protected Attributes inherited from Service
IntegerProperty	m_outputLevel = MSG::NIL
	Service output level. More...

Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state. More...

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state. 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 124 of file IssueLogger.cpp.

                                            {
 
   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 {
       error() << "Unknown output level \"" << attrib.tag << "\""
       << endmsg;
       continue;
     }
 
     if (m_log[level]) {
       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();
         error() << "Unable to open file \"" << attrib.value
             << "\" for writing issues at level " << attrib.tag << endmsg;
         return StatusCode::FAILURE;
       }
     }
     debug() << "Writing " << s_levelTrans.at(level)
                       << " issues to " << m_log[level].name() << endmsg;
   }
   return StatusCode::SUCCESS;
 }

StatusCode IssueLogger::finalize ( )

override

Definition at line 112 of file IssueLogger.cpp.

                       {
 
   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.

                           {
 
   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 175 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 187 of file IssueLogger.cpp.

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

void IssueLogger::setupDefaultLogger ( )

private

Definition at line 245 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 };
       debug() << "Writing " << s_levelTrans.at(j)
                         << " issues to " << m_log[j].name() << endmsg;
     }
   }
 }

void IssueLogger::setupLevels ( Property & prop )

private

Definition at line 194 of file IssueLogger.cpp.

                                        {
 
   StringProperty *sap = dynamic_cast<StringProperty*> (&prop);
   if (!sap) {
     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;
       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 {
     error() << "setting up unknown property \"" 
                       << prop.name() << "\"" << endmsg;
   }
 }

void IssueLogger::setupStreams ( Property & prop )

private

Definition at line 227 of file IssueLogger.cpp.

                                         {
 
   StringArrayProperty *sap = dynamic_cast<StringArrayProperty*>( &prop );
   if ( !sap ) {
     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()) {
       error() << "Could not setup stream " << s << endmsg;
     }
   }
 }

Member Data Documentation

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

private

Definition at line 47 of file IssueLogger.h.

StringArrayProperty IssueLogger::m_outputfile

private

Definition at line 30 of file IssueLogger.h.

IssueSeverity::Level IssueLogger::m_reportLevel

private

Definition at line 33 of file IssueLogger.h.

StringProperty IssueLogger::m_reportLevelS

private

Definition at line 31 of file IssueLogger.h.

BooleanProperty IssueLogger::m_showTime

private

Definition at line 32 of file IssueLogger.h.

IssueSeverity::Level IssueLogger::m_traceLevel

private

Definition at line 33 of file IssueLogger.h.

StringProperty IssueLogger::m_traceLevelS

private

Definition at line 31 of file IssueLogger.h.

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

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

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation