#include "irods/msParam.h"
#include "irods/rods.h"
#include "irods/rsGlobalExtern.hpp"
#include "irods/rcGlobalExtern.h"
#include "irods/rodsLog.h"
#include "irods/sockComm.h"
#include "irods/getRodsEnv.h"
#include "irods/rcConnect.h"
#include "irods/generalRowInsert.h"
#include "irods/generalRowPurge.h"
#include "irods/generalAdmin.h"
#include <string>

Include dependency graph for reIn2p3SysRule.hpp:

This graph shows which files directly or indirectly include this file:

Classes
struct	ThreadInput

struct	ResourceInfo

Macros
#define	NFIELDS 4

#define	MAXLEN 100

#define	MAXSTR 30

#define	MAXLIST 40

#define	MON_PERF_SCRIPT "irodsServerMonPerf"

#define	NRESULT 7

#define	MAX_VALUE 512

#define	MAX_MESSAGE_SIZE 2000

#define	MAX_NSERVERS 512

#define	TIMEOUT 20

#define	MON_OUTPUT_NO_ANSWER "#-1#-1#-1#-1#-1#-1#-1#-1#"

#define	LEN_SECONDS 4

Typedefs
using	thrInp_t = ThreadInput

using	monInfo_t = ResourceInfo

Functions
int	checkHostAccessControl (const std::string &_user_name, const std::string &_client_host, const std::string &_groups_name)

int	msiCheckHostAccessControl (ruleExecInfo_t *rei)

int	msiDigestMonStat (msParam_t cpu_wght, msParam_t mem_wght, msParam_t swap_wght, msParam_t runq_wght, msParam_t disk_wght, msParam_t netin_wght, msParam_t netout_wght, ruleExecInfo_t rei)

int	msiFlushMonStat (msParam_t timespan, msParam_t tablename, ruleExecInfo_t *rei)

int	msiServerMonPerf (msParam_t verbosity, msParam_t probtime, ruleExecInfo_t *rei)

Macro Definition Documentation

◆ LEN_SECONDS

#define LEN_SECONDS 4

Definition at line 30 of file reIn2p3SysRule.hpp.

◆ MAX_MESSAGE_SIZE

#define MAX_MESSAGE_SIZE 2000

Definition at line 26 of file reIn2p3SysRule.hpp.

◆ MAX_NSERVERS

#define MAX_NSERVERS 512

Definition at line 27 of file reIn2p3SysRule.hpp.

◆ MAX_VALUE

#define MAX_VALUE 512

Definition at line 25 of file reIn2p3SysRule.hpp.

◆ MAXLEN

#define MAXLEN 100

Definition at line 19 of file reIn2p3SysRule.hpp.

◆ MAXLIST

#define MAXLIST 40

Definition at line 21 of file reIn2p3SysRule.hpp.

◆ MAXSTR

#define MAXSTR 30

Definition at line 20 of file reIn2p3SysRule.hpp.

◆ MON_OUTPUT_NO_ANSWER

#define MON_OUTPUT_NO_ANSWER "#-1#-1#-1#-1#-1#-1#-1#-1#"

Definition at line 29 of file reIn2p3SysRule.hpp.

◆ MON_PERF_SCRIPT

#define MON_PERF_SCRIPT "irodsServerMonPerf"

Definition at line 23 of file reIn2p3SysRule.hpp.

◆ NFIELDS

#define NFIELDS 4

Definition at line 18 of file reIn2p3SysRule.hpp.

◆ NRESULT

#define NRESULT 7

Definition at line 24 of file reIn2p3SysRule.hpp.

◆ TIMEOUT

#define TIMEOUT 20

Definition at line 28 of file reIn2p3SysRule.hpp.

Typedef Documentation

◆ monInfo_t

using monInfo_t = ResourceInfo

Definition at line 54 of file reIn2p3SysRule.hpp.

◆ thrInp_t

using thrInp_t = ThreadInput

Definition at line 44 of file reIn2p3SysRule.hpp.

Function Documentation

◆ checkHostAccessControl()

int checkHostAccessControl	(	const std::string &	_user_name,
		const std::string &	_client_host,
		const std::string &	_groups_name
	)

Definition at line 324 of file reIn2p3SysRule.cpp.

References ERROR, i, irods::KW_CFG_ACCESS_ENTRIES, irods::KW_CFG_ADDRESS, irods::KW_CFG_GROUP, irods::KW_CFG_HOST_ACCESS_CONTROL, irods::KW_CFG_MASK, and irods::KW_CFG_USER.

Referenced by msiCheckHostAccessControl().

◆ msiCheckHostAccessControl()

msiCheckHostAccessControl ( ruleExecInfo_t * rei )

Description:\n This microservice sets the access control policy. It checks the: access control by host and user based on the the policy given in the HostAccessControl file.

Module:: core

Since: pre-2.1

Author: Jean-Yves Nief

Note: This microservice controls access to the iRODS service based on the information in the host_access_control information of server_config.json.

Example Usage:\n See clients/icommands/test/rules/

Parameters

[in,out] rei - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation.

Session Variables Used:: none

Session Variables Modified:: none

iCAT Attributes Used:: none

iCAT Attributes Modified:: none

Side Effect:\n none

Returns: integer

Return values

0	upon success

Precondition: N/A

Postcondition: N/A

See also: N/A

Definition at line 437 of file reIn2p3SysRule.cpp.

References addInxIval(), addInxVal(), checkHostAccessControl(), clearGenQueryInp(), RsComm::clientUser, COL_USER_GROUP_NAME, COL_USER_NAME, freeGenQueryOut(), i, SqlResult::len, LOG_NOTICE, MAX_NAME_LEN, MAX_SQL_ROWS, GenQueryInp::maxRows, NULL, RE_TEST_MACRO, RsComm::remoteAddr, rodsLog(), GenQueryOut::rowCnt, RuleExecInfo::rsComm, rsGenQuery(), rstrcpy(), GenQueryInp::selectInp, GenQueryInp::sqlCondInp, GenQueryOut::sqlResult, RuleExecInfo::status, UserInfo::userName, and SqlResult::value.

Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().

◆ msiDigestMonStat()

msiDigestMonStat	(	msParam_t *	cpu_wght,
		msParam_t *	mem_wght,
		msParam_t *	swap_wght,
		msParam_t *	runq_wght,
		msParam_t *	disk_wght,
		msParam_t *	netin_wght,
		msParam_t *	netout_wght,
		ruleExecInfo_t *	rei
	)

Description:\n This microservice calculates and stores a load factor for each connected: resource based on the weighting values passed in as parameters.

Module:: core

Since: pre-2.1

Author: Jean-Yves Nief

Note

The following values are loaded from R_LOAD_SERVER:

cpu_used
mem_used
swap_used
runq_load
disk_space
net_input
net_output

The stored load factor is calculated as such:

load_factor = cpu_wght*cpu_used + mem_wght*mem_used + swap_wght*swap_used + runq_wght*runq_load + disk_wght*disk_space + netin_wght*net_input + netout_wght*net_output

Example Usage:\n See clients/icommands/test/rules/ and https://wiki.irods.org/index.php/Resource_Monitoring_System

Parameters

[in]	cpu_wght	- Required - a msParam of type STR_MS_T defining relative CPU weighting.
[in]	mem_wght	- Required - a msParam of type STR_MS_T defining relative memory weighting
[in]	swap_wght	- Required - a msParam of type STR_MS_T defining relative swap weighting
[in]	runq_wght	- Required - a msParam of type STR_MS_T defining relative run queue weighting
[in]	disk_wght	- Required - a msParam of type STR_MS_T defining relative disk space weighting
[in]	netin_wght	- Required - a msParam of type STR_MS_T defining relative inbound network weighting
[in]	netout_wght	- Required - a msParam of type STR_MS_T defining relative outbound network weighting
[in,out]	rei	- The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation.

Session Variables Used:: none

Session Variables Modified:: none

iCAT Attributes Used:: R_SERVER_LOAD table content

iCAT Attributes Modified:: R_SERVER_LOAD_DIGEST table content

Side Effect:\n none

Returns: integer

Return values

0	upon success

Precondition: N/A

Postcondition: N/A

See also: N/A

Definition at line 871 of file reIn2p3SysRule.cpp.

References addInxIval(), addInxVal(), generalRowInsertInp_t::arg1, generalRowInsertInp_t::arg2, GenQueryOut::attriCnt, clearGenQueryInp(), COL_SL_CPU_USED, COL_SL_CREATE_TIME, COL_SL_DISK_SPACE, COL_SL_MEM_USED, COL_SL_NET_INPUT, COL_SL_NET_OUTPUT, COL_SL_RESC_NAME, COL_SL_RUNQ_LOAD, COL_SL_SWAP_USED, freeGenQueryOut(), i, MsParam::inOutStruct, SqlResult::len, LOG_ERROR, MAX_NAME_LEN, MAX_NSERVERS, MAX_SQL_ROWS, GenQueryInp::maxRows, NRESULT, NULL, RE_TEST_MACRO, RsComm::rError, rodsLog(), rodsLogAndErrorMsg(), GenQueryOut::rowCnt, RuleExecInfo::rsComm, rsGeneralRowInsert(), rsGenQuery(), rstrcpy(), SELECT_MAX, GenQueryInp::selectInp, GenQueryInp::sqlCondInp, GenQueryOut::sqlResult, RuleExecInfo::status, STR_MS_T, generalRowInsertInp_t::tableName, MsParam::type, and SqlResult::value.

Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().

◆ msiFlushMonStat()

msiFlushMonStat	(	msParam_t *	inpParam1,
		msParam_t *	inpParam2,
		ruleExecInfo_t *	rei
	)

Description:\n This microservice flushes the servers' monitoring statistics.

Module:: core

Since: pre-2.1

Author: Jean-Yves Nief

Note: This microservice removes the servers' metrics older than the number of hours in "timespan".

Example Usage:\n See clients/icommands/test/rules/ and https://wiki.irods.org/index.php/Resource_Monitoring_System

Parameters

[in]	inpParam1	- Required - a msParam of type STR_MS_T defining the timespan in hours. "default" is equal to 24 hours.
[in]	inpParam2	- Required - a msParam of type STR_MS_T defining the tablename to be flushed. Currently must be either "serverload" or "serverloaddigest".
[in,out]	rei	- The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation.

Session Variables Used:: none

Session Variables Modified:: none

iCAT Attributes Used:: table R_SERVER_LOAD content

iCAT Attributes Modified:: table R_SERVER_LOAD content

Side Effect:\n none

Returns: integer

Return values

0	upon success

Precondition: N/A

Postcondition: N/A

See also: N/A

Definition at line 742 of file reIn2p3SysRule.cpp.

References MsParam::inOutStruct, LOG_ERROR, MAXLEN, NULL, RE_TEST_MACRO, RsComm::rError, rodsLog(), rodsLogAndErrorMsg(), RuleExecInfo::rsComm, rsGeneralRowPurge(), generalRowPurgeInp_t::secondsAgo, RuleExecInfo::status, STR_MS_T, generalRowPurgeInp_t::tableName, and MsParam::type.

Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().

◆ msiServerMonPerf()

msiServerMonPerf	(	msParam_t *	verb,
		msParam_t *	ptime,
		ruleExecInfo_t *	rei
	)

Description:\n This microservice monitors the servers' activity and performance.

Module:: core

Since: pre-2.1

Author: Jean-Yves Nief

Note: This microservice monitors the servers' activity and performance for CPU, network, memory and more. It retrieves the list of servers to monitor from the MON_CFG_FILE if it exists, or the iCAT if the configuration file does not exist.; The MON_PERF_SCRIPT is executed on each host. The result is put in the OUTPUT_MON_PERF file and will also be put in the iCAT in the near future.

Example Usage:\n See clients/icommands/test/rules/ and https://wiki.irods.org/index.php/Resource_Monitoring_System

Parameters

[in]	verb	- a msParam of type STR_MS_T defining verbose mode: "default" - not verbose "verbose" - verbose mode
[in]	ptime	- a msParam of type STR_MS_T defining probe time in seconds. "default" is equal to 10 seconds.
[in,out]	rei	- The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation.

Session Variables Used:: none

Session Variables Modified:: none

iCAT Attributes Used:: none

iCAT Attributes Modified:: resource status flag, resource free space available, table R_SERVER_LOAD

Side Effect:\n none

Returns: integer

Return values

0	upon success

Precondition: N/A

Postcondition: N/A

See also: N/A

Definition at line 531 of file reIn2p3SysRule.cpp.

References ThreadInput::addPathToArgv, delim, irods::get_irods_home_directory(), getListOfResc(), i, if(), MsParam::inOutStruct, LEN_SECONDS, LOG_ERROR, LOG_NOTICE, LONG_NAME_LEN, MAX_NAME_LEN, MAX_NSERVERS, MAX_VALUE, MAXSTR, MON_CFG_FILE, MON_OUTPUT_NO_ANSWER, MON_PERF_SCRIPT, my_mutex, NULL, RE_TEST_MACRO, rodsLog(), rodsMonPerfLog(), RuleExecInfo::rsComm, rstrcat(), rstrcpy(), startMonScript(), RuleExecInfo::status, strcpy(), ThreadInput::threadId, threadIsAlive, TIMEOUT, and ResourceInfo::vaultPath.

Referenced by irods::lookup_table< ValueType, KeyType, HashType >::lookup_table().

Classes

Macros

Typedefs

Functions

Macro Definition Documentation

◆ LEN_SECONDS

◆ MAX_MESSAGE_SIZE

◆ MAX_NSERVERS

◆ MAX_VALUE

◆ MAXLEN

◆ MAXLIST

◆ MAXSTR

◆ MON_OUTPUT_NO_ANSWER

◆ MON_PERF_SCRIPT

◆ NFIELDS

◆ NRESULT

◆ TIMEOUT

Typedef Documentation

◆ monInfo_t

◆ thrInp_t

Function Documentation

◆ checkHostAccessControl()

◆ msiCheckHostAccessControl()

◆ msiDigestMonStat()

◆ msiFlushMonStat()

◆ msiServerMonPerf()