Inheritance diagram for Gaudi::Monitoring::MessageSvcSink:

[legend]

Collaboration diagram for Gaudi::Monitoring::MessageSvcSink:

[legend]

Public Member Functions
StatusCode	initialize () override
	initialization, registers to Monitoring::Hub More...

StatusCode	stop () override
	stop method, handles the printing More...

void	registerEntity (Hub::Entity ent) override

void	removeEntity (Hub::Entity const &ent) override

	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor 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...

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

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator 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 >
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")

template<class T >
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)

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

template<class T >
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")

template<class T >
void	addToolsArray (ToolHandleArray< T > &hndlArr)

const std::vector< IAlgTool * > &	tools () const

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

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	PropertyHolder ()=default

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
	Helper to wrap a regular data member and use it as a regular property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation. More...

Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property. More...

StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name More...

StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string More...

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property. More...

virtual StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p)=0
	Set the property from a property with a different name. More...

virtual StatusCode	setProperty (const std::string &s)=0
	Set the property by string. More...

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals. More...

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string. More...

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

StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation More...

StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property More...

const Gaudi::Details::PropertyBase &	getProperty (std::string_view name) const override
	get the property by name More...

StatusCode	getProperty (std::string_view n, std::string &v) const override
	convert the property to the string More...

const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties More...

bool	hasProperty (std::string_view name) const override
	Return true if we have a property with the given name. More...

Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected More...

void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream) More...

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

Public Member Functions inherited from Gaudi::Monitoring::Hub::Sink
virtual	~Sink ()=default

Private Attributes
std::deque< Hub::Entity >	m_monitoringEntities

Additional Inherited Members
Public Types inherited from Service
using	Factory = Gaudi::PluginService::Factory< IService (const std::string &, ISvcLocator )>

Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using	PropertyHolderImpl = PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	Typedef used to refer to this class from derived classes, as in. More...

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

Protected Member Functions inherited from Service
std::vector< IAlgTool * > &	tools ()

	~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 > >
MSG::Level	setUpMessaging () const
	Set up local caches. More...

MSG::Level	resetMessaging ()
	Reinitialize internal states. More...

void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state More...

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

Gaudi::Property< int >	m_outputLevel { this, "OutputLevel", MSG::NIL, "output level" }
	flag indicating whether ToolHandle tools have been added to m_tools More...

Gaudi::Property< bool >	m_auditInit { this, "AuditServices", false, "[[deprecated]] unused" }

Gaudi::Property< bool >	m_auditorInitialize { this, "AuditInitialize", false, "trigger auditor on initialize()" }

Gaudi::Property< bool >	m_auditorStart { this, "AuditStart", false, "trigger auditor on start()" }

Gaudi::Property< bool >	m_auditorStop { this, "AuditStop", false, "trigger auditor on stop()" }

Gaudi::Property< bool >	m_auditorFinalize { this, "AuditFinalize", false, "trigger auditor on finalize()" }

Gaudi::Property< bool >	m_auditorReinitialize { this, "AuditReinitialize", false, "trigger auditor on reinitialize()" }

Gaudi::Property< bool >	m_auditorRestart { this, "AuditRestart", false, "trigger auditor on restart()" }

Gaudi::Property< bool >	m_autoRetrieveTools

Gaudi::Property< bool >	m_checkToolDeps

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service More...

Detailed Description

Definition at line 157 of file MessageSvcSink.cpp.

Member Function Documentation

◆ initialize()

StatusCode Gaudi::Monitoring::MessageSvcSink::initialize ( )

inlineoverride

initialization, registers to Monitoring::Hub

Definition at line 163 of file MessageSvcSink.cpp.

                                      {
       return Service::initialize().andThen( [&] {
         // declare ourself as a monitoding sink
         serviceLocator()->monitoringHub().addSink( this );
       } );
     }

◆ registerEntity()

void Gaudi::Monitoring::MessageSvcSink::registerEntity ( Hub::Entity ent )

inlineoverridevirtual

Implements Gaudi::Monitoring::Hub::Sink.

Definition at line 174 of file MessageSvcSink.cpp.

                                                   {
       if ( std::string_view( ent.type ).substr( 0, 8 ) == "counter:" || ent.type == "statentity" ||
            ent.type == "histogram" ) {
         m_monitoringEntities.emplace_back( std::move( ent ) );
       }
     }

◆ removeEntity()

void Gaudi::Monitoring::MessageSvcSink::removeEntity ( Hub::Entity const & ent )

inlineoverridevirtual

Implements Gaudi::Monitoring::Hub::Sink.

Definition at line 182 of file MessageSvcSink.cpp.

                                                        {
       auto it = std::find( begin( m_monitoringEntities ), end( m_monitoringEntities ), ent );
       if ( it != m_monitoringEntities.end() ) { m_monitoringEntities.erase( it ); }
     }

◆ Service()

Service::Service

Standard Constructor

Definition at line 81 of file Service.cpp.

                                                       : m_name( std::move( name ) ), m_svcLocator( svcloc ) {
   if ( m_name != "MessageSvc" ) { // the MessageSvc should not notify itself
     m_outputLevel.declareUpdateHandler(
         [this]( Gaudi::Details::PropertyBase& ) { this->updateMsgStreamOutputLevel( this->m_outputLevel ); } );
   }
  
   // Initialize the default value from ApplicationMgr AuditAlgorithms
   Gaudi::Property<bool> audit( false );
   auto                  appMgr = serviceLocator()->service<IProperty>( "ApplicationMgr" );
   if ( appMgr && appMgr->hasProperty( "AuditServices" ) ) { audit.assign( appMgr->getProperty( "AuditServices" ) ); }
   m_auditInit           = audit;
   m_auditorInitialize   = audit;
   m_auditorStart        = audit;
   m_auditorStop         = audit;
   m_auditorFinalize     = audit;
   m_auditorReinitialize = audit;
   m_auditorRestart      = audit;
 }

◆ stop()

StatusCode Gaudi::Monitoring::MessageSvcSink::stop ( )

override

stop method, handles the printing

Definition at line 194 of file MessageSvcSink.cpp.

                                                {
   // We will try to mimic the old monitoring of counters, so we need to split
   // them per Algo. The algo name can be extracted form the id of the entity
   // as its format is "algoName/counterName"
   // This map groups entities per algoName. For each name, the submap gives
   // the counter name of each subentity and the associated json
   std::map<std::string, std::map<std::string, nlohmann::json>> sortedEntities;
   // fill the sorted map
   for ( auto& entity : m_monitoringEntities ) { sortedEntities[entity.component][entity.name] = entity.toJSON(); }
   // dump all counters
   for ( auto& [algoName, entityMap] : sortedEntities ) {
     // check first whether there is any counter to log
     unsigned int nbCounters =
         std::accumulate( begin( entityMap ), end( entityMap ), 0, []( const unsigned int& a, const auto& j ) {
           return a + ( j.second.at( "empty" ).template get<bool>() ? 0 : 1 );
         } );
     if ( 0 == nbCounters ) continue;
     MsgStream log{ msgSvc(), algoName };
     log << MSG::INFO << "Number of counters : " << nbCounters << "\n"
         << " |    Counter                                      |     #     |   "
         << " sum     | mean/eff^* | rms/err^*  |     min     |     max     |";
     std::for_each( begin( entityMap ), end( entityMap ), [&log]( auto& p ) {
       // Do not print empty counters
       if ( !p.second.at( "empty" ).template get<bool>() ) {
         log << "\n";
         printCounter( log, p.first, p.second );
       }
     } );
     log << endmsg;
   }
   return Service::stop();
 }

Member Data Documentation

◆ m_monitoringEntities

std::deque<Hub::Entity> Gaudi::Monitoring::MessageSvcSink::m_monitoringEntities

private

Definition at line 188 of file MessageSvcSink.cpp.

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

GaudiCoreSvc/src/MessageSvc/MessageSvcSink.cpp

Public Member Functions

Private Attributes

Additional Inherited Members