Reference: Server Monitoring Parameters
This section contains a reference of all Server (and System-independent) Monitoring Parameters provided by Avantra.
AgentConnectRoute
Define routing string for use with the avantra-gateway
Description
It is recommended to use The Route Configurator instead of configuring this parameter directly.
|
If the Avantra Master connects to the Avantra Agent through one or more avantra-gateways, you can define this value.
Configures | |||||
Unit |
String. The format of a routing string is defined by the following EBNF: Routing ::== Sequence | Backup Backup ::== '(' Sequence ')' { '|(' Sequence ')' } Sequence ::== [ URL { ' ' URL }] URL ::== ( target | reverse) ['?' query ] target ::== protocol '//' host ':' port reverse ::== '//' reverse-id query ::== param {'&' param} protocol ::== 'a5' | 'a5s' param ::== key '=' value host ::== hostname | ip-address port ::== integer key ::== url-encoded string value ::== url-encoded string The meaning of protocol is as follows:
|
AgentConnectTimeCrit
Configure critical threshold for AgentConnect
If no connection could be established to a Avantra Agent for more than AgentConnectTimeCrit minutes, the Avantra Master will set the status of the AgentConnect Check to Critical.
Configures |
Agent |
Default Value |
60 |
Unit |
Minutes |
AgentConnectTimeWarn
Configure warning threshold for AgentConnect
If no connection could be established to a Avantra Agent for more than AgentConnectTimeWarn minutes, the Avantra Master will set the status of the AgentConnect Check to Warning.
Configures |
Agent |
Default Value |
10 |
Unit |
Minutes |
AgentEnvironment
Set Environment variables effective for the Avantra Agent.
General purpose parameter. Do not use it unless instructed by the Avantra support team.
Configures |
Agent |
Unit |
String |
AgentListenerPort
Configure the Avantra Agent TCP/IP listener port.
Defines the Avantra Agent TCP/IP listener port. Do not change this value unless the default port is already in use.
If you need to change it, please contact our support for assistance.
If you are not familiar with TCP/IP, or you do not know what a port is, you may want to start further reading at RFC 1180.
Configures |
Agent |
Default Value |
9051 |
Unit |
Number |
AgentProtocolUseSSL
Configures, whether the communication between Avantra Agent and Avantra Master uses SSL encryption or not.
By default, the communication between Avantra Agent and Avantra Master is secured by SSL using client-side certificates. Turning SSL off should only be required under rare circumstances, i.e. to work around SSL problems with the Avantra Agent Java Runtime Environment. Please be aware that without SSL communication between Avantra Agent and Avantra Master will be plain text HTTP.
Configures |
Agent |
Default Value |
true |
Unit |
Boolean |
AliveTimeout
Defines the timeout value for the Avantra Agent
If the Avantra Master did not receive data for more than AliveTimeout minutes, it will set the status of Check AGENTALIVE to Critical. You may decrease this parameter for productive systems, and increase it for systems connected via low speed/low bandwidth links.
Configures | |
Default Value |
10 |
Unit |
Minutes |
AutoChangeDetectionIgnore
Control the System Change Auto Detection (for Servers)
AutoChangeDetectionIgnore is used to exclude parameters from System Change Auto Detection. If, for example, a parameter value changes regularly and this behaviour is well known, you may add the parameter to the exclude list. The parameter value is still updated in the Avantra Database, but no change record will be created. Since there are several change detection objects, you must prefix the list with a keyword to indicate the object type.
This parameter has currently no effect for Servers.
Configures | |
Unit |
Keyword followed by comma separated value list, optionally followed by a semicolon followed by a keyword followed by comma separated value list, … Colon, semicolon, and comma must be escaped by |
CheckCycleTime
Modifies scheduling of the Basic Check Cycle
Defines the time interval between two consecutive runs of the Basic Check Cycle.
Configures |
All Checks in the Basic Check Cycle |
Default Value |
5 |
Unit |
Minutes |
CloudDetection
Enable/disable cloud detection on Agent.
Determine if the Agent shall perform cloud detection. For the purpose of cloud detection several predefined URLs have to be accessed, which may lead to firewall messages depending on your environment. In this case you can turn off cloud detection by this parameter.
Configures |
Cloud detection |
Default Value |
On |
Unit |
Boolean |
ClusterSwitchMsgDisplayDuration
Configures Cluster Switch Visibility in RealTime Monitoring
Defines how long (in minutes) the AGENTALIVE Check remains in status Warning after a Virtual Cluster Server has switched from one Physical Server to the other.
Configures |
AGENTALIVE (for Virtual Cluster Servers only) |
Default Value |
30 |
Unit |
Minutes |
CPULoadAverageTime
Configures CPU usage computation interval
The value of CPULoadAverageTime defines the time period used to compute the average CPU load over. CPULOAD will only result in Warning or Critical status, if the CPU load of the system was over the corresponding threshold for CPULoadAverageTime minutes or more. The higher this value is, the less likely you will get alerts due to CPU peaks over a small period of time only.
Configures | |
Default Value |
10 |
Unit |
Minutes |
CPULoadCrit
Configures a critical threshold for the CPU usage
If the server’s average CPU load exceeds CPULoadCrit percent the check status of CPULOAD turns to Critical.
Configures | |
Default Value |
95 |
Unit |
% |
CPULoadWarn
Configures a warning threshold for the CPU usage
If the server’s average CPU load exceeds CPULoadWarn percent, but does not exceed CPULoadCrit percent, the check status of CPULOAD turns to Warning.
Configures | |
Default Value |
80 |
Unit |
% |
DailyCheckSendTimeRange
Configures a random delay for Daily Check delivery
Usually Daily Checks are executed at DailyCheckStart and delivered immediately. In a large scale environment with hundreds of Avantra Agents and if DailyCheckStart has the same value for all Avantra Agents it may cause a high load of the Avantra Master.
If you set this parameter the Avantra Agent randomly chooses a time between 0 and DailyCheckSendTimeRange minutes before the Daily Check is actually delivered.
Configures | |
Default Value |
0 |
Unit |
Minutes |
DailyCheckStart
Configures Daily Check execution time
Defines the start time of the FULLCHECK in the Avantra Agent's local time zone. It affects all SAP Instances eventually installed on the same Physical Server or Virtual Cluster Server.
Configures | |
Default Value |
07:00 |
Unit |
Formatted String: |
DumpData
Dump data for debugging purposes
Use only if instructed by Avantra.
Configures |
Agent |
Unit |
List |
FSExCrit
Configure filesystem forecasting critical threshold
If the predicted point in time when the filesystem usage limit is exceeded is within the upcoming FSExCrit hours, the check status of FILESYSTEMS is set to Critical.
Configures | |
Default Value |
2 |
Unit |
Hours |
Monitoring Exception Parameter available |
Yes |
FSExWarn
Configure filesystem forecasting warning threshold
If the predicted point in time when the filesystem usage limit is exceeded is within the upcoming FSExWarn hours, but not within the upcoming FSExCrit hours, the check status of FILESYSTEMS is set to Warning (unless the FSUsageCrit threshold is exceeded for some file system).
Configures | |
Default Value |
12 |
Unit |
Hours |
Monitoring Exception Parameter available |
Yes |
FSForecast
Enables forecasting for FILESYSTEMS check
Defines weather the forecasting algorithm is active or inactive. See Forecasting for more information.
Configures | |
Default Value |
Active |
Unit |
Enum (Active/Inactive) |
Monitoring Exception Parameter available |
Yes |
FSMonitorNetwork
Configure monitoring of network filesystems
If the parameter is selected the FILESYSTEMS Check also monitors non-local file systems, i.e. mapped network drives (in the Windows world) and NFS-mounted file systems (in the Unix world).
Configures | |
Default Value |
Not set |
Unit |
Check box |
FSNodeCrit
Configure critical filesystem inode usage threshold
If one or more of the Physical Server’s filesystem inode usage exceeds FSNodeCrit percent, the Check status is set to Critical (on Unix-like operating systems only).
Configures | |
Default Value |
95 |
Unit |
% |
FSNodeWarn
Configure warning filesystem inode usage threshold
If one or more of the Physical Server’s filesystem inode usage exceeds FSNodeWarn percent, but none of them exceeds FSNodeCrit percent, the check status is set to Warning (unless any other Critical threshold is exceeded for some filesystem; on Unix-like operating systems only).
Configures | |
Default Value |
90 |
Unit |
% |
FSTypeLocal
Configure filesystem types considered local
A list of (local) filesystem types. Avantra Agent does not monitor filesystems having a type not defined in this parameter.
Configures | |
Default Value |
advfs aix ext2 ext3 ext4 gpfs hfs jfs jfs2 minix ntfs ocfs2 reiser4 reiserfs ufs vxfs xfs xiafs zfs |
Unit |
String |
FSTypeRemote
Configure filesystem types considered as network filesystems
A list of (network) filesystem types. Avantra Agent does not monitor filesystems having a type not defined in this parameter. The parameter is only effective if FSMonitorNetwork is selected.
Configures | |
Default Value |
afs dfs nfs nfs2 nfs3 nfsv2 nfsv3 smbfs |
Unit |
String |
FSUsageCrit
Configure critical filesystem usage threshold
If one or more of the Physical Server’s filesystem usage exceeds the FSUsageCrit threshold, the Check status is set to Critical.
You can define the threshold either in percentage of the total size of the resource, or in KB
, MB
, or GB
values of the remaining free space. In the first case, the parameter gets effective if the usage measured in %
of the total space is higher than the defined threshold. In the second case the parameter gets effective if the remaining free space is lower than the defined threshold.
Configures | |
Default Value |
95 |
Unit |
% |
Monitoring Exception Parameter available |
Yes |
FSUsageWarn
Configure warning filesystem usage threshold
If one or more of the Physical Server’s filesystem usage exceeds the FSUsageWarn thrreshold, but none of them exceeds the FSUsageCrit threshold, the check status is set to Warning (unless any other Critical threshold is exceeded for some filesystem).
You can define the threshold either in percentage of the total size of the resource, or in KB
, MB
, or GB
values of the remaining free space. In the first case, the parameter gets effective if the usage measured in %
of the total space is higher than the defined threshold. In the second case the parameter gets effective if the remaining free space is lower than the defined threshold.
Configures | |
Default Value |
80 |
Unit |
% |
Monitoring Exception Parameter available |
Yes |
GatewayTunnels
Configure Tunnels maintained by the Avantra Agent.
This parameter is used to configure Tunnels to other Avantra Agents used as Gateways or the Avantra Master.
Do not change this Monitoring Parameter unless you really know what you are doing. This parameter can be set using The Route Configurator. |
Configures |
All checks assigned to the System. |
Default Value |
(not defined) |
Unit |
Boolean |
LocalMonitoringOff
Turn local monitoring off
If you set this parameter Avantra will stop monitoring the System.
This setting can be used if you want to monitor this System only using End-to-End Application Monitoring (from a different System).
Do not change this Monitoring Parameter unless you really know what you are doing. |
Configures |
All checks assigned to the System. |
Default Value |
(not defined) |
Unit |
Boolean |
LogKeepFiles
Control how many log files to preserve
Defines how many old log files to keep. If set to 0
, there is one log file kept called lyceus.log.old
.
If set to a value n
greater 0, n
log files are kept named with time stamp suffix.
Configures | |
Default Value |
0 |
Unit |
Number |
MasterConnectRoute
Define routing string for more sophisticated routing from the Avantra Agent to the Avantra Master. and as replacement for parameters MasterHost and MasterPort.
Description
It is recommended to use The Route Configurator instead of configuring this parameter directly.
|
Use this parameter if MasterHost and MasterPort parameters are not sufficient to specify the routing from Avantra Agent to Avantra Master.
Configures | |||||
Unit |
String. The format of a routing string is defined by the following EBNF: Routing ::== Sequence | Backup Backup ::== '(' Sequence ')' { '|(' Sequence ')' } Sequence ::== [ URL { ' ' URL }] URL ::== ( target | reverse) ['?' query ] target ::== protocol '//' host ':' port reverse ::== '//' reverse-id query ::== param {'&' param} protocol ::== 'a5' | 'a5s' param ::== key '=' value host ::== hostname | ip-address port ::== integer key ::== url-encoded string value ::== url-encoded string The meaning of protocol is as follows:
|
MasterHost
Configure how to connect to the Avantra Master
Host name or IP address of the Avantra server, more precisely, of the server running Avantra Master.
The default value is taken from the Avantra Master property Network.masterhost which itself is determined automatically.
If you use AgentConnectRoute you probably need to set MasterHost to the host name of the last gateway defined in AgentConnectRoute
Configures | |
Default Value |
The value of Network.masterhost |
Unit |
Formatted String: Full Qualified Domain Name or IP Address |
MasterPort
Configure how to connect to the Avantra Master
TCP/IP port number the Avantra Master is listening to.
The default value is taken from the Avantra Master property Network.masterport.
If you use AgentConnectRoute you probably need to set MasterPort to the TCP/IP port number of the last gateway defined in AgentConnectRoute.
Configures | |
Default Value |
The value of Network.masterport. |
Unit |
Number |
MediumCheckCycleTime
Modifies scheduling of the Medium Check Cycle
Defines the time interval between two consecutive runs of the Medium Check Cycle. Please be aware that the cycle time is always 'rounded' up to the next CheckCycleTime time. For example, if you enter 8 minutes as the MediumCheckCycleTime and the CheckCycleTime is set to 5 minutes, the check will be executed every 10 minutes in every 2nd check interval.
Configures |
Medium Check Cycle |
Default Value |
3 |
Unit |
Number |
MemoryUsageCrit
Configure critical threshold for physical memory check MEMORY
If the physical memory usage exceeds the MemoryUsageCrit threshold, the check status is set to Critical.
You can define the threshold either in percentage of the total size of the resource, or in KB
, MB
, or GB
values of the remaining free space. In the first case, the parameter gets effective if the usage measured in %
of the total space is higher than the defined threshold. In the second case the parameter gets effective if the remaining free space is lower than the defined threshold.
Configures | |
Default Value |
95 |
Unit |
% |
MemoryUsageWarn
Configure warning threshold for physical memory check MEMORY
If the physical memory usage exceeds the MemoryUsageWarn threshold, but does not exceed the MemoryUsageCrit threshold, the check status is set to Warning.
You can define the threshold either in percentage of the total size of the resource, or in KB
, MB
, or GB
values of the remaining free space. In the first case, the parameter gets effective if the usage measured in %
of the total space is higher than the defined threshold. In the second case the parameter gets effective if the remaining free space is lower than the defined threshold.
Configures | |
Default Value |
90 |
Unit |
% |
MessageSuppressTime
Suppress Avantra Agent communication
The Avantra Agent re-sends a Check Result after MessageSuppressTime minutes, if check status and check message have not changed during this time.
Configures |
All Checks |
Default Value |
60 |
Unit |
Minutes |
PagingSpaceCrit
Configure critical threshold for virtual memory check
If the total amount of paging space usage exceeds the PagingSpaceCrit threshold, the check status is set to Critical.
You can define the threshold either in percentage of the total size of the resource, or in KB
, MB
, or GB
values of the remaining free space. In the first case, the parameter gets effective if the usage measured in %
of the total space is higher than the defined threshold. In the second case the parameter gets effective if the remaining free space is lower than the defined threshold.
Configures | |
Default Value |
95 |
Unit |
% |
PagingSpaceWarn
Configure warning threshold for virtual memory check
If the total amount of paging space usage exceeds the PagingSpaceWarn threshold, but does not exceed the PagingSpaceCrit threshold, the check status is set to Warning.
You can define the threshold either in percentage of the total size of the resource, or in KB
, MB
, or GB
values of the remaining free space. In the first case, the parameter gets effective if the usage measured in %
of the total space is higher than the defined threshold. In the second case the parameter gets effective if the remaining free space is lower than the defined threshold.
Configures | |
Default Value |
80 |
Unit |
% |
PagingSpacePhysMemRatioWarn
Configure warning threshold for the amount of virtual memory
If the Server's total amount of paging space is less PagingSpacePhysMemRatioWarn percent of the physical memory, the check status of Check PAGINGSPACE is set to Warning.
The default is 0
in case of which this sub-Check is disabled.
Configures | |
Default Value |
0 |
Unit |
% |
PerfDataCollection
Turn Performance Data Collection on or off (for Servers)
Controls whether or not Performance Data Collection is turned on for Systems. If you do not want the Avantra Agent to collect performance data you may remove the flag.
Configures | |
Default Value |
On |
Unit |
Check box |
PerfDataDiskIOFileSystems
Configures FILESYSTEMS Check to collect disk IO performance data
Use this monitoring parameter to collect disk IO performance data of file systems. Disk IO performance data is not collected by default for file systems. It must be turned on using this monitoring parameter. Define the names of the file systems you want to collect data of. Multiple entries can be separated with one or more spaces, comma, or semicolon. If one of these characters appear in a file system path, you must escape it with \
. You can use wildcard *
to define multiple file systems.
Use *
to collect performance data of all file systems.
Use /usr/sap*
to collect performance data of all filesystems starting with /usr/sap
.
Use C:* D:* E:*
to collect performance data of logical drives On Microsoft Windows operating systems.
Do not use C:\
since \
must be quoted itself.
Configures | |
Default Value |
n/a |
Unit |
String |
PerfDataNetworkIOInterfaces
Configures network interfaces to collect performance data
Use this monitoring parameter to collect performance data of network I/O interfaces. Performance data is not collected by default for network interfaces. It must be turned on with this monitoring parameter. Define the names of the network interfaces, multiple network interfaces can be separated with spaces, comma, or semicolon. You can use wildcard \*
to define network interfaces.
Use *
to collect performance data of all network I/O interfaces.
Use eth*
to collect performance data of all network I/O interfaces with a name starting with eth.
RTMMaxMessageSize
Restrict amount of transmitted RealTime Monitoring Check data.
Defines the maximum number of bytes of the check message that are transferred to the Avantra Master. This is to prevent network transmission problems in case of very large message sizes.
Configures | |
Default Value |
16384 |
Unit |
Number |
SAPInstanceDetection
Control SAP Instance Auto Discovery
This parameter controls the SAP Instance Auto Discovery algorithm of the Avantra Agent.
By default only SAP Instances with an instance profile file ending on the hostname
(on Physical Servers) or the Virtual Cluster Server Name (on Virtual Cluster Servers)
are monitored. In case your profiles are named differently and you are using logical host names,
first have a look at SAPLogicalHostDetection and SAPLogicalHostResolution.
- White List Mode
-
You can define a list of SAP Instance names of SAP Instances which shall be discovered on the corresponding Server. In this mode you define all the SAP Instances in question as a formatted string.
Only if the Avantra Agent cannot find instance profiles after setting SAPLogicalHostDetection and SAPLogicalHostResolution, you should consider using SAPInstanceDetection in White List Mode. |
- Black List Mode
-
Let the Avantra Agent automatically discover all the SAP Instances and define a list of SAP Instance names which shall be excluded. In this mode you define all the excluded SAP Instances as a formatted string., and add the keyword
EXCEPT
as a prefix to this list. You can even useEXCEPT *
in order to turn off SAP Instance Auto Discovery completely
You can change this behaviour by using the keyword ALL
. The keywords ALL
and EXCEPT
can be combined.
Do NOT use the value |
BEN: pinot_BEN_00, merlot_BEN_01; P11: riesling_P11_00
with BEN
and P11
the Real SAP SID of the SAP Instances followed by the corresponding instance names, in case of BEN
separated by comma.
EXCEPT BEN: merlot_BEN_01
with BEN
the Real SAP SID of the SAP Instances followed by the corresponding instance name.
EXCEPT *
Configures | |
Unit |
Formatted String: |
SAPInstanceProfiles
Control SAP Instance Auto Discovery
This parameter is deprecated and supported only for backward compatibility. Please use the improved SAPInstanceDetection parameter instead. |
Configures | |
Unit |
Formatted String: |
SAPLogicalHostDetection
Lets the Agent detect instances using Logical Host Names automatically.
If the hostname used by the instance (SAPLOCALHOST) is a Logical Host Name and doesn’t match the Server Name defined in Avantra, monitoring will not be performed.
But if this parameter is activated on the corresponding SAP System, the Agent will do a /etc/hosts
and DNS lookup for the Logical Host Name, and if the name resolves to a matching IP address, the instance will be monitored by the Agent.
Configures |
Instance Detection |
Default Value |
false |
Unit |
Boolean |
Monitoring Exception Parameter available |
No |
SAPLogicalHostResolution
Allows to define custom host name / ip mappings augmenting Logical Host Name resolution.
In addition to the SAPLogicalHostDetection parameter, this parameter can be used to define IP addresses or host names for Logical Host name resolution. Normally the automatic resolution using the hosts file or DNS will work, but in case of DNS problems or Agentless Monitoring, this parameter can be set to customize the resolution. On a per host basis, mappings of multiple host names to an IP address or host name can be defined. In case Logical Host detection is active, but this parameter doesn’t provide a mapping, the detection falls back to hosts file / DNS mapping.
The format of the parameter looks as follows:
logical-host-name-mappings ::= logical-host-name-mapping { ';' logical-host-name-mapping } logical-host-name-mapping ::= real-name ':' logical-name { ',' logical-name } real-name ::= ip-address | host-name logical-name ::= host-name
The following examples show how to set the parameter:
192.168.10.105: baker, berthe
192.168.10.105: baker, berthe; 192.168.10.106: baltimore
Configures |
Instance Detection |
Unit |
String |
SocketReadTimeOut
Configure Avantra Agent network timeout
Defines the maximum time (in seconds) the Avantra Agent reads an incoming TCP/IP connection. There usually is no need to change this value.
Configures | |
Default Value |
20 |
Unit |
Seconds |
TimeOffsetCrit
Critical threshold for the TimeOffset check.
Defines the Critical threshold for the TimeOffset check; if the Agent server UTC time differs from the Avantra Master UTC time more than the configured value, TimeOffset becomes Critical.
Configures | |
Default Value |
60 |
Unit |
Seconds |
TimeOffsetWarn
Warning threshold for the TimeOffset check.
Defines the Warning threshold for the TimeOffset check; if the Agent server UTC time differs from the Avantra Master UTC time more than the configured value, TimeOffset becomes Warning.
Configures | |
Default Value |
30 |
Unit |
Seconds |
TimeOutOsCalls
Configure operating system call timeout
Defines the timeout for Avantra Agent child processes performing operating system calls. If the value exceeds, the process is terminated. There usually is no need to change this value. This parameter affects Solaris systems only.
Configures | |
Default Value |
10 |
Unit |
Seconds |
TraceLevel
Configure Avantra Agent logging
Defines how verbose the Avantra Agent performs logging.
Valid values range from 0
to 5
Configures | |
Default Value |
2 |
Unit |
Number |