XrdCmsPerfMon.hh

Go to the documentation of this file.

#ifndef __CMS_PERFMON__
#define __CMS_PERFMON__
/******************************************************************************/
/*                                                                            */
/*                      X r d C m s P e r f M o n . h h                       */
/*                                                                            */
/* (c) 2019 by the Board of Trustees of the Leland Stanford, Jr., University  */
/*                            All Rights Reserved                             */
/*   Produced by Andrew Hanushevsky for Stanford University under contract    */
/*              DE-AC02-76-SFO0515 with the Department of Energy              */
/*                                                                            */
/* This file is part of the XRootD software suite.                            */
/*                                                                            */
/* XRootD is free software: you can redistribute it and/or modify it under    */
/* the terms of the GNU Lesser General Public License as published by the     */
/* Free Software Foundation, either version 3 of the License, or (at your     */
/* option) any later version.                                                 */
/*                                                                            */
/* XRootD is distributed in the hope that it will be useful, but WITHOUT      */
/* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or      */
/* FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public       */
/* License for more details.                                                  */
/*                                                                            */
/* You should have received a copy of the GNU Lesser General Public License   */
/* along with XRootD in a file called COPYING.LESSER (LGPL license) and file  */
/* COPYING (GPL license).  If not, see <http://www.gnu.org/licenses/>.        */
/*                                                                            */
/* The copyright holder's institutional names and contributor's names may not */
/* be used to endorse or promote products derived from this software without  */
/* specific prior written permission of the institution or contributor.       */
/******************************************************************************/
 
class  XrdOucEnv;
class  XrdSysLogger;
 
/******************************************************************************/
/*                   c l a s s   X r d C m s P e r f M o n                    */
/******************************************************************************/
 
/* The XrdCmsPerfMon is used to report performance metrics. It is obtained
   from the shared library loaded at run time and identified by the cms.perf
   directive. The library should contain an implementation of this class.
*/
  
class XrdCmsPerfMon
{
public:
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
virtual bool   Configure(const char    *cfn,
                               char    *Parms,
                         XrdSysLogger  &Logger,
                         XrdCmsPerfMon &cmsMon,
                         XrdOucEnv     *EnvInfo,
                         bool           isCMS)
                        {(void)cfn; (void)Parms; (void)Logger; (void)cmsMon;
                         (void)EnvInfo; (void)isCMS;
                         return false;
                        }
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
struct PerfInfo
      {unsigned char cpu_load; 
       unsigned char mem_load; 
       unsigned char net_load; 
       unsigned char pag_load; 
       unsigned char xeq_load; 
       unsigned char xxx_load; 
       unsigned char yyy_load; 
       unsigned char zzz_load; 
 
       void Clear() {cpu_load = mem_load = net_load = pag_load = xeq_load = 0;
                     xxx_load = yyy_load = zzz_load = 0;
                    }
 
       PerfInfo() {Clear();}
      ~PerfInfo() {}
      };
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
virtual void   GetInfo(PerfInfo &info) {(void)info;}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
virtual void   PutInfo(PerfInfo &info, bool alert=false)
                      {(void)info; (void)alert;}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
               XrdCmsPerfMon() {}
 
virtual       ~XrdCmsPerfMon() {}
};
 
/******************************************************************************/
/*       L i b r a r y   X r d C m s P e r f M o n   D e f i n i i o n        */
/******************************************************************************/
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
#endif