XRootD
XrdCmsPerfMon Class Reference

#include <XrdCmsPerfMon.hh>

+ Inheritance diagram for XrdCmsPerfMon:
+ Collaboration diagram for XrdCmsPerfMon:

Classes

struct  PerfInfo
 Structure used for reporting performance metrics. More...
 

Public Member Functions

 XrdCmsPerfMon ()
 Constructor & Destructor. More...
 
virtual ~XrdCmsPerfMon ()
 
virtual bool Configure (const char *cfn, char *Parms, XrdSysLogger &Logger, XrdCmsPerfMon &cmsMon, XrdOucEnv *EnvInfo, bool isCMS)
 
virtual void GetInfo (PerfInfo &info)
 
virtual void PutInfo (PerfInfo &info, bool alert=false)
 

Detailed Description

Definition at line 45 of file XrdCmsPerfMon.hh.

Constructor & Destructor Documentation

◆ XrdCmsPerfMon()

XrdCmsPerfMon::XrdCmsPerfMon ( )
inline

Constructor & Destructor.

Definition at line 127 of file XrdCmsPerfMon.hh.

127 {}

◆ ~XrdCmsPerfMon()

virtual XrdCmsPerfMon::~XrdCmsPerfMon ( )
inlinevirtual

Definition at line 129 of file XrdCmsPerfMon.hh.

129 {}

Member Function Documentation

◆ Configure()

virtual bool XrdCmsPerfMon::Configure ( const char *  cfn,
char *  Parms,
XrdSysLogger Logger,
XrdCmsPerfMon cmsMon,
XrdOucEnv EnvInfo,
bool  isCMS 
)
inlinevirtual

Configure the PerfMon plugin object. This is called after the plugin is loaded via the shared library.

Parameters
cfnThe configuration file name.
ParmsAny parameters specified in the perf directive. If none, the pointer may be null.
LoggerThe logging object.
cmsMonThe object to be used for async reporting.
EnvInfoEnvironmental information of the caller, may be nil.
isCMSTrue if loaded by the cmsd and false if loaded by xrootd.
Returns
True upon success. False upon failure.

Definition at line 65 of file XrdCmsPerfMon.hh.

71  {(void)cfn; (void)Parms; (void)Logger; (void)cmsMon;
72  (void)EnvInfo; (void)isCMS;
73  return false;
74  }
XrdSysLogger Logger
Definition: XrdGlobals.cc:47

References XrdGlobal::Logger.

Referenced by XrdCmsMeter::Monitor().

+ Here is the caller graph for this function:

◆ GetInfo()

virtual void XrdCmsPerfMon::GetInfo ( PerfInfo info)
inlinevirtual

Obtain performance statistics as load values from 0 to 100. The system calls this method at periodic intervals.

Parameters
infoReference to the structure that should be filled out with load values, as desired. See the PerfInfo structure.

Definition at line 106 of file XrdCmsPerfMon.hh.

106 {(void)info;}

Referenced by XrdCmsFinderTRG::RunPM(), and XrdCmsMeter::RunPM().

+ Here is the caller graph for this function:

◆ PutInfo()

virtual void XrdCmsPerfMon::PutInfo ( PerfInfo info,
bool  alert = false 
)
inlinevirtual

Report performance statistics as load values from 0 to 100. The performance monitor plugin may call this method to asynchronously report performance via the passed XrdCmsPerfMon object during configuration.

Parameters
infoReference to the structure that should be filled out with load values. See the PerfInfo structure.
alertWhen true, load information is forcibly sent to the cluster's manager. Otherwise, it is only sent if it significantly changes. See the cms.sched directive fuzz parameter.

Reimplemented in XrdCmsMeter, and XrdCmsFinderTRG.

Definition at line 120 of file XrdCmsPerfMon.hh.

121  {(void)info; (void)alert;}

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