xrootd
Loading...
Searching...
No Matches
Classes | Public Member Functions | List of all members
XrdCmsPerfMon Class Reference

#include <XrdCmsPerfMon.hh>

Inheritance diagram for XrdCmsPerfMon:
Inheritance graph
[legend]

Classes

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

Public Member Functions

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)
 
 XrdCmsPerfMon ()
 Constructor & Destructor.
 
virtual ~XrdCmsPerfMon ()
 

Constructor & Destructor Documentation

◆ XrdCmsPerfMon()

XrdCmsPerfMon::XrdCmsPerfMon ( )
inline

Constructor & Destructor.

◆ ~XrdCmsPerfMon()

virtual XrdCmsPerfMon::~XrdCmsPerfMon ( )
inlinevirtual

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.

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

◆ 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 XrdCmsFinderTRG, and XrdCmsMeter.


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