SAP Instance - Monitoring Parameters

Here you will find detailed information about monitoring parameters for SAP Instance monitored objects.

Monitoring parameters are the mechanism for you to configure how your systems are monitored. They are how you set configuration of how the agent runs, how checks are executed, thresholds for checks (when does a check go critical or warning) and much more. All Monitoring Parameters have a carefully chosen default value. As soon as you add a new system, Avantra uses these defaults. You may change these defaults by defining a parameter and by modifying its values. Monitoring Parameters can be defined for a single system, or for collections of systems using Monitoring Parameter Sets. You can also define your own Custom Monitoring Parameters for use within Custom Checks and automations.

AutoChangeDetectionIgnore

Controls the System Change Auto Detection (for Servers)

Description

AutoChangeDetectionIgnore is used to exclude parameters from System Change Auto Detection. If, for example, a parameter value changes regularly and this behavior 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.

For SAP Instances, INSTPROFPARAM, J2EESYSPROP, and J2EEVMPARAM are currently supported. Wildcard * is supported to define multiple parameters.

Example 1. Ignored Changes
J2EEVMPARAM: java.proc.id, java.mem*; J2EESYSPROP: *
Reference Data
Configures

System Change Auto Detection

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 \ (backslash) if used as a value.

DispatcherQueueFillRatioCrit

Configures critical threshold for per work process dispatcher queue usage

Description

If the current number of entries in one of the dispatcher queues exceeds DispatcherQueueFillRatioCrit times the number of available work processes, the DispatcherQueue Check turns to Critical.

Reference Data
Configures

DispatcherQueue

Default Value

10

Unit

Number

DispatcherQueueFillRatioWarn

Configures warning threshold for per work process dispatcher queue usage

Description

If the current number of entries in one of the dispatcher queues exceeds DispatcherQueueFillRatioWarn times the number of available work processes, the DispatcherQueue Check turns to Warning (unless one of the critical thresholds is exceeded).

Reference Data
Configures

DispatcherQueue

Default Value

5

Unit

Number

DispatcherQueuePercentCrit

Configures critical threshold for dispatcher queue usage

Description

If the current number of entries in one of the dispatcher queues compared to the maximum number of queue entries exceeds this threshold, the DispatcherQueue Check turns to Critical.

Reference Data
Configures

DispatcherQueue

Default Value

40

Unit

Percent

DispatcherQueuePercentWarn

Configures warning threshold for dispatcher queue usage

Description

If the current number of entries in one of the dispatcher queues compared to the maximum number of queue entries exceeds this threshold, the DispatcherQueue Check turns to Warning (unless one of the critical thresholds is exceeded).

Reference Data
Configures

DispatcherQueue

Default Value

20

Unit

Percent

ERSConnectErrsCrit

Configures sensitivity of the Enqueue Replication Server connection check

Description

Starting from ERSConnectErrsCrit failed connection attempts the check status will turn from Warning to Critical.

Reference Data
Configures

ERS_Connect

Default Value

1

Unit

Number

ICMConnUsageCrit

Configures critical threshold value for ICM connection usage

Description

If the ratio of current connections to the maximum available connections exceeds ICMConnUsageCrit percent, the check status turns to Critical.

Reference Data
Configures

ICMSTAT

Default Value

95

Unit

Percent

ICMConnUsageWarn

Configures warning threshold value for ICM connection usage

Description

If the ratio of current connections to the maximum available connections exceeds ICMConnUsageWarn percent, but not ICMConnUsageCrit percent, and none of the thresholds ICMQueueUsageCrit or ICMThreadsUsageCrit is exceeded, the check status turns to Warning.

Reference Data
Configures

ICMSTAT

Default Value

85

Unit

Percent

ICMQueueUsageCrit

Configures critical threshold for ICM queue usage

Description

If the ratio of current queues to maximum available queues exceeds ICMQueueUsageCrit percent, the check status turns to Critical.

Reference Data
Configures

ICMSTAT

Default Value

95

Unit

Percent

ICMQueueUsageWarn

Configures warning threshold for ICM queue usage

Description

If the ratio of current queues to maximum available queues ICMQueueUsageWarn percent, but not ICMQueueUsageCrit percent, and none of the thresholds ICMConnUsageCrit or ICMThreadsUsageCrit is exceeded, the check status turns to Warning.

Reference Data
Configures

ICMSTAT

Default Value

85

Unit

Percent

ICMThreadsUsageCrit

Configures critical threshold for ICM thread usage

Description

If the ratio of current created worker threads to maximum available worker threads exceeds ICMThreadsUsageCrit percent, the check status turns to Critical.

Reference Data
Configures

ICMSTAT

Default Value

95

Unit

Percent

ICMThreadsUsageWarn

Configures warning threshold for ICM thread usage

Description

If the ratio of current created worker threads to maximum available worker threads exceeds ICMThreadsUsageWarn percent, but not ICMThreadsUsageCrit percent, and none of the thresholds ICMConnUsageCrit or ICMQueueUsageCrit is exceeded, the check status turns to Warning.

Reference Data
Configures

ICMSTAT

Default Value

85

Unit

Percent

IgnoreJavaAddIn

Ignores the Java part of a double-stack SAP Instance

Description

In case the SAP Instance Auto Discovery finds a double-stack instance but the Java part is not used intentionally you can use this parameter to prevent the Java add-in from being monitored.

Reference Data
Configures

SAP Instance Auto Discovery

Default Value

0

Unit

Boolean

IgnoreWebDisp

Ignores integrated Web Dispatcher of an Abap_Scs with Web Dispatcher instance

Description

To suppress monitoring of the integrated Web Dispatcher on an Abap_Scs with Web Dispatcher instance, you may set this parameter to true. The Abap_Scs with Web Dispatcher instance will then be regarded as an ordinary Abap_Scs instance, and all checks and performance values related to Web Dispatcher monitoring won’t be available.

Reference Data
Configures

SAP Instance Auto Discovery

Default Value

0

Unit

Boolean

InstanceDowntimeCrit

Defines an acceptable amount of time an SAP Instance may be shut down

Description

If the downtime of a properly shut down SAP Instances exceeds InstanceDowntimeCrit minutes the RFCConnect, J2EECONNECT, or SCS_MSGSRV check status turn from Warning to Critical.

Reference Data
Configures

RFCConnect, J2EECONNECT, SCS_MSGSRV

Default Value

120

Unit

Minutes

J2EEApplThreadsPoolUsageCrit

Configures critical threshold for application thread pool usage

Description

If the number of used application threads exceeds J2EEApplThreadsPoolUsageCrit percent of the maximum thread pool size, the check status is set to Critical.

Reference Data
Configures

J2EEApplThreadsPool

Default Value

90

Unit

%

J2EEApplThreadsPoolUsageWarn

Configures warning threshold for application thread pool usage

Description

If the number of used application threads exceeds this value but does not exceed J2EEApplThreadsPoolUsageCrit percent of the maximum thread pool size, the check status is set to Warning.

Reference Data
Configures

J2EEApplThreadsPool

Default Value

80

Unit

%

J2EEConnectErrsCrit

Configures sensitivity of the Java SAP Instance connection check

Description

Starting from J2EEConnectErrsCrit consecutive failed connection attempts the check status will turn from Warning to Critical.

Reference Data
Configures

J2EECONNECT

Default Value

1

Unit

Number

J2EEConnectHttpErrsCrit

Configures sensitivity of the Java SAP Instance HTTP connection check

Description

Starting from J2EEConnectHttpErrsCrit consecutive failed HTTP connection attempts the on the system info page check status will turn from Warning to Critical.

Reference Data
Configures

J2EEConnectHttp

Default Value

1

Unit

Number

J2EEConnectHttpPageKeywords

Configures custom keywords for validity check of the /nwa/sysinfo page retrieved by check J2EEConnectHttp

Description

The parameter can be used to configure custom keywords, which serve to verify the validity of the /nwa/sysinfo page, which is retrieved by the J2EEConnectHttp check. If one of the keywords is found on the page, the page is considered to be valid and the J2EEConnectHttp check is OK.

By default, the check J2EEConnectHttpPageKeywords looks for the instance host name on the page. For customised pages, which do not contain the instance host name, this turns the check to Critical.

If you specifiy a '*', the page verification is omitted, and a successful login to any page is accepted.

Reference Data
Configures

J2EEConnectHttp

Default Value

empty (the default keyword is set to instance host )

Unit

Number

J2EEConnectUrlSuffix

Configures the URL being used by the Java SAP Instance HTTP connect Check J2EEConnectHttp

Description

Defines the URL to be used by the J2EEConnectHttp Check.

The following syntax is supported:

  • Suffix only, e.g. /sap/monitoring/SystemInfo. The Suffix is appended to the default URL (http://localhost:5<sysno>00) by the Avantra Agent internally.
    For SAP systems 7.10 and newer, the default path is /nwa/sysinfo.
    For SAP systems 7.0x and older, the default path is /sap/monitoring/SystemInfo.

  • Suffix with leading port, e. g. :8080/sap/monitoring/SystemInfo. (The leading colon is mandatory!). You will have to use this syntax if the HTTP port has been changed from its default value 5<system_number>00.

  • Whole URL starting with http://. You can freely define which URL to be checked. This mode may be used for special purposes.

  • Whole URL starting with https://. You can use this option if you want to access an https service. You also have to use this option if the default SystemInfo page is accessed via https.

In the #http/https[] options, placeholders for hosts and ports can be used. Specify <host> to let the Avantra Agent use the default host (usually 'localhost') and/or <port> to let it use the default port of the specified protocol (5<sysno>00 for http and 5<sysno>01 for https).

Example 2. J2EEConnectUrlSuffix monitoring parameter
https://<host>:<port>/sap/monitoring/SystemInfo
http://192.168.123.456:<port>/myhtmlpage

You can also use client authentication in conjunction with https. See the description of the J2EEKeystoreName Monitoring Parameter for further information.

If you cannot get J2EEConnectHttp to work using J2EEConnectUrlSuffix, then you might need to disable the check.

Reference Data
Configures

J2EEConnectHttp

Default Value

sap/monitoring/SystemInfo

Unit

String

J2EEKeyPw

Defines (optional) a key password for use with the Java SAP Instance connect Check

Description

This password is used to retrieve the keys from the keystore specified in the J2EEKeystoreName Monitoring Parameter. Do not define this parameter unless the keystore keys are password protected. See the description of the J2EEKeystoreName Monitoring Parameter.

Reference Data
Configures

J2EECONNECT

Unit

String

J2EEKeystoreName

Defines keystore for secure authentication with the Java SAP Instance connect Check

Description

If you use the J2EECONNECT check with https, you might also want to use certificates to authenticate the server and client. Whereas server certificates are handled without further configuration (the Avantra Agent trusts all incoming certificates by default), client certificates must be configured and installed manually.

In order to enable client authentication in the J2EECONNECT check, a java keystore file containing the accurate certificate must have been generated, stored in a location readable by the Avantra Agent, and defined in this parameter. (If you do not define this parameter, no client authentication will be performed.)

The path of the keystore file can be specified as follows: * Fully qualified path, e.g.. /usr/keys/keystore.ks * Relative path. A relative path is applied to the {avantra-agent}'s cfg directory, e.g. keystore.ks (will resolve to `<syslink`install_dir>/lyceus/cfg/keystore.ks.)

Reference Data
Configures

J2EECONNECT

Unit

String

J2EEKeystorePw

Defines an optional keystore password for secure authentication with the Java SAP Instance connect Check

Description

Password for an optional integrity check of the keystore. If you specify this parameter, the used keystore is checked for integrity, otherwise, the keystore is loaded without an integrity check. For this to work, the keystore must have been stored using the same integrity password before.

Reference Data
Configures

J2EECONNECT

Unit

String

J2EEKeystoreType

Defines an optional keystore type for secure authentication with the Java SAP Instance connect Check

Description

Indicates the type of the keystore specified in J2EEKeystoreName. The keystore type must exactly correspond to the type of the used java keystore. If a keystore is specified but not a keystore type, pkcs12 is used as the default keystore type.

Reference Data
Configures

J2EECONNECT

Unit

String

J2EEP4Port

Configures the P4 port used with the Java SAP Instance connect Check

Description

The Avantra Agent connects the Java instance at the P4 port, as SAP Visual Administrator does. If this TCP/IP port has been changed from its default value, you need to adapt J2EEP4Port to the correct value.

Reference Data
Configures

J2EECONNECT

Default Value

5<sysnr>04

Unit

String

J2EEP4TransportType

Configures the transport type used with the Java SAP Instance connect Check

Description

The Avantra Agent connects the Java instance at the P4 port defined by J2EEP4Port. The J2EEP4TransportType Monitoring Parameter defines the transport layer (or protocol) used for this connection. By default, the value is None and the P4 protocol is used.

You can choose SSL in order to use the P4S protocol scheme in case of which the Avantra Agent uses Transport Layer Security (TLS) for the connection.

You can choose HTTPS to use the P4HTTPS protocol scheme. The Avantra Agent then tunnels the connection through HTTPS.

Reference Data
Configures

J2EECONNECT

Default Value

None

Unit

String

J2EESystemThreadsPoolUsageCrit

Configures critical threshold for system thread pool usage

Description

If the number of used system threads exceeds J2EESystemThreadsPoolUsageCrit percent of the maximum thread pool size, the check status is set to Critical.

Reference Data
Configures

J2EESystemThreadsPool

Default Value

90

Unit

%

J2EESystemThreadsPoolUsageWarn

Configures warning threshold for system thread pool usage

Description

If the number of used system threads exceeds this value but does not exceed J2EESystemThreadsPoolUsageCrit percent of the maximum thread pool size, the check status is set to Warning.

Reference Data
Configures

J2EESystemThreadsPool

Default Value

80

Unit

%

JavaASAvgRespTimeConsiderBest

Defines which server processes are used to calculate the Java average response time

Description

Per default, the response times of all server processes are used to get the overall average response time of an instance. If you have multiple server processes, and most of them perform well but a few very bad, the overall response time may be affected and display a false alert.

This is where JavaASAvgRespTimeConsiderBest will help. It defines the percentage of the best performing server processes used to calculate the overall server response time. The remaining will not be considered. If, for example, you set it to 50, it will only consider the best 50 percent of your server response times, i.e. if you’ve got 6 servers, only the best 3 response times of those 6 servers will be compared to the thresholds. The default value of the parameter is 100 %, which corresponds to the original behavior of the check, that all server processes are used to calculate the overall value.

Reference Data
Configures

JavaASAvgRespTime

Default Value

100

Unit

%

JavaASAvgRespTimeCrit

Configures critical threshold for Java average response time

Description

If the JARM average response time exceeds this value the check status is set to Critical.

Reference Data
Configures

JavaASAvgRespTime

Default Value

3000

Unit

Milliseconds

JavaASAvgRespTimeReset

Controls Java average response time reset

Description

Defines if or if not the JavaASAvgRespTime check resets the JARM statistic records. By default it does. There is no need to change this value unless you use other tools that also try to reset the JARM statistic records.

Reference Data
Configures

JavaASAvgRespTime

Default Value

1

Unit

Boolean

JavaASAvgRespTimeWarn

Configures warning threshold for Java average response time

Description

If JARM average response time exceeds this value but does not exceed JavaASAvgRespTimeCrit, the check status is set to Warning.

Reference Data
Configures

JavaASAvgRespTime

Default Value

1500

Unit

Milliseconds

JavaHttpPort

Configures the HTTP port used for the J2EEConnectHttp and PI checks on a Java SAP Instance.

Description

The Avantra Agent tries to determine the HTTP port of a Java SAP Instance automatically from the instance profile entries ICM/SERVER_PORT_nn with protocol HTTP (for pre 7.10 instances ICM/HTTP/J2EE_nn); by default 5<sysno>00 is used.

If an HTTPS port is detected in the profile as well, the HTTPS port will be preferred to the HTTP port, and the connection will be established using SSL and the HTTPS port. To overrule this behavior, you may set JavaHttpPort, which in turn overrides HTTPS and forces the usage of HTTP on the specified port.

If detection fails and the default port is wrong, JavaHttpPort may be used to force-set the HTTP port.

JavaHttpsPort

Configures the HTTPS port used for the J2EEConnectHttp and PI checks on a Java SAP Instance.

Description

The Avantra Agent tries to determine the HTTPS port of a Java SAP Instance automatically from the instance profile entries ICM/SERVER_PORT_nn with protocol HTTPS (for pre 7.10 instances ICM/HTTPS/J2EE_nn);. If no HTTPS port is detected, HTTPS won’t be used by default.

If both HTTP and HTTPS ports are detected in the profile, the HTTPS port will be preferred over the HTTP port, and the connection will be established using SSL and the HTTPS port. See the description of JavaHttpPort for further details.

If detection fails for an HTTPS port, JavaHttpsPort may be used to force-set the HTTPS port, overruling any JavaHttpPort setting.

JavaLongRunningThreadsCountCrit

Configures Critical threshold for JavaLongRunningThreads

Description

If the long-running threads count of any cluster node of an AS Java is equal to or above this setting, the check status of JavaLongRunningThreads will be Critical, otherwise, Warning if higher than 0.

Reference Data
Configures

JavaLongRunningThreads

Default Value

1

Unit

Number

JavaLongRunningThreadsCountWarn

Configures Warning threshold for JavaLongRunningThreads check

Description

If the long-running threads count of any cluster node of an AS Java is higher than zero, the JavaLongRunningThreads check status will be Warning

Reference Data
Configures

JavaLongRunningThreads

Default Value

1

Unit

Number

JavaServerNodesRunningPctCrit

Configures Critical threshold for JavaServerNodes

Description

If the percentage of running server nodes of an SAP J2EE instance compared to all nodes is equal to or below this value, the check status will be Critical.

The "Disabled" nodes are not considered in the calculation.
Reference Data
Configures

JavaServerNodes

Default Value

50

Unit

%

JavaServerNodesRunningPctWarn

Configures Warning threshold for JavaServerNodes

Description

If the percentage of running server nodes of an SAP J2EE instance compared to all nodes is equal to or below JavaServerNodesRunningPctWarn but still above JavaServerNodesRunningPctCrit, the check status will be Warning.

The "Disabled" nodes are not considered in the calculation.
Reference Data
Configures

JavaServerNodes

Default Value

80

Unit

%

JavaStackMonitor

Configures monitor access protocol for Java Stacks

Description

When SAPControl is available and configured for a system / instance in the Avantra WebUI (see ), it’s possible to monitor the Java by means of SAPControl instead of the traditional JMX/P4 monitor.

The SAPControl setting might be useful if the JMX/P4 monitor doesn’t work reliably or is not accessible for some reason.

Reference Data
Configures

J2EECONNECT

Default Value

JMX/P4

Unit

JMX/P4, SAPControl

JVMGCRatioCrit

Configures Critical threshold for JVMGarbageCollector check

Description

If the time spent on garbage collection is equal to or above JVMGCRatioCrit percent of the JVM total runtime, the check status will be Critical.

Reference Data
Configures

JVMGarbageCollector

Default Value

40

Unit

%

JVMGCRatioWarn

Configures Warning threshold for JVMGarbageCollector check

Description

If the time spent on garbage collection is equal to or above JVMGCRatioWarn percent of the JVM total runtime, but still below JVMGCRatioCrit, the status of the GC ratio sub-check will Warning.

Reference Data
Configures

JVMGarbageCollector

Default Value

20

Unit

%

JVMMemoryUsageCrit

Configures critical threshold for Java virtual memory usage

Description

If the amount of the Java virtual memory used exceeds JVMMemoryUsageCrit percent of the available memory, the check status is set to Critical.

Reference Data
Configures

JVM_MEMORY

Default Value

90

Unit

%

JVMMemoryUsageWarn

Configures warning threshold for Java virtual memory usage

Description

If the amount of the Java virtual memory used exceeds this value but does not exceed JVMMemoryUsageCrit percent of the available memory, the check status is set to Warning.

Reference Data
Configures

JVM_MEMORY

Default Value

80

Unit

%

LyjconCmdLineParams

Special purpose parameter to control the Avantra Agent

Description

Do not use unless instructed by the Avantra Support Team.

Reference Data
Configures

Avantra Agent

Default Value
Unit

String

LyjconLibPath

Special purpose parameter to control the Avantra Agent

Description

Special purpose parameter for setting the relative Jar search path of Avantra Agent. Do not use unless instructed by the Avantra Support Team.

Reference Data
Configures

Avantra Agent

Default Value
Unit

String

LyjconLibs

Special purpose parameter to control the Avantra Agent

Description

Special purpose parameter for setting the Jars loaded by Avantra Agent. Do not use unless instructed by the Avantra Support Team.

Reference Data
Configures

Avantra Agent

Default Value
Unit

String

RdispMsservInternal

Description

The MessageServer daily check checks the parameter rdisp/msserv_internal according to SAP recommendations and standard configurations. If this parameter has a different value and you know that your systems are running safely with your value, you can override the default behavior of the MessageServer daily check with this monitoring parameter.

Set the port of your rdisp/msserv_internal parameter value. Typical values are 39xx. You can also use regular expressions, use 39\d\d to allow all ports from 3900 to 3999.

Reference Data
Configures

MessageServer daily check.

Unit

String

OSCollectorMaxAge

Deprecated

Description

Deprecated

Reference Data
Configures

All Agentless Monitoring checks depending on SAP process saposcol.

Default Value

15

Unit

Minutes

PerfDataCollectABAPTaskTypes

Choose ABAP task types for performance data collection

Description

Per default, Avantra Agent collects performance data for ABAP task types DIALOG and additionally for the task types listed in this parameter. Task type DIALOG is always recorded so it is not required to specify it using PerfDataCollectABAPTaskTypes. Per default, performance is also collected for background jobs and HTTP requests.

You can list possible task types using SAP transaction Workload (ST03). For example, possible values are AUTOABAP, AUTOCCMS, AUTOJAVA, AUTOTH, BACKGROUND, BUFFER SYNC, DDLOG CLEANUP, DEL. THCALL, DIALOG, HTTP, RFC, RPCTH, SPOOL, UPDATE, UPDATE2.

Reference Data
Configures

SAP Instance Performance Data Collection

Default Value

BACKGROUND, HTTP

Unit

String, i.e. list of task types separated by comma or semicolon (,;). Leading, trailing or multiple spaces between the separation chars are allowed and will be trimmed away. Though unlikely to be necessary, you must escape ,; by a backslash \, should these chars appear in a task type name.

PerfDataCollection

Turns Performance Data Collection on or off (for SAP Instances)

Description

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.

Reference Data
Configures

System

Default Value

On

Unit

Check box

PredictiveAnalyticsEngine

Configures the Predictive Analytics engine for the SAP Instance

Description

Use this monitoring parameter to configure the Predictive Analytics engine for the SAP Instance. By default the engine is configured as Balanced.

  • Use Off to turn off the Predictive Analytics engine.

  • Use Best Performance to configure the Predictive Analytics engine to run with best performance.

  • Use Balanced to configure the Predictive Analytics engine to run in a balanced way.

  • Use Highest Precision to configure the Predictive Analytics engine to run with highest precision.

Reference Data
Configures

== RelevantDailyCheckDetails

Configures Daily Check contributing check details (for SAP Instances)

Description

Defines a list of Daily Check details that are considered relevant for the Daily Check status, i.e. the status of which contributes to the overall status. By default, the parameter is not defined, i.e. all Daily Check details contribute.

If you define an empty list, no Daily Check detail will contribute. In this case, the status of the Daily Check will be always Unknown.

Reference Data
Configures

Daily Checks

Default Value
Unit

List of Checks

RemoveFromDBDelay

Description

If an SAP Instance is no longer discovered by any Avantra Agent, it will be marked in Avantra as NOT_SEEN. (In this state, it can only be removed from the system manually using Avantra WebUI.)

If it is discovered again by any Avantra Agent within the RemoveFromDBDelay days period, the NOT_SEEN flag is simply removed.

If the SAP Instance is not discovered by any Avantra Agent for RemoveFromDBDelay days, it will be removed from the Avantra Database.

Reference Data
Configures

SAP Instance Auto Discovery

Default Value

7

Unit

Days

RFCConnectErrsCrit

Configures sensitivity of the ABAP SAP Instance connection check

Description

Starting from RFCConnectErrsCrit failed RFC connection attempts the check status will turn from Warning to Critical.

Reference Data
Configures

RFCConnect

Default Value

1

Unit

Number

SAPControlProtocol

Configures the protocol to access the SAPControl Web Service of an instance.

Description

This parameter allows you to configure the protocol to access the SAPControl Web Service Interface of an SAP instance.

If you specify OFF, SAPControl won’t be used for the instance.

If you specify Adaptive, the SAPControl connector will use Windows Named Pipes / Unix Domain Sockets to connect to the SAPControl Web Service, unless the optional SAPControl User is defined for the SAP System, see Defining SAP Systems. If the SAPControl User is defined, HTTP/HTTPS will be used automatically.

If you specify NamedPipes, the SAPControl connector will use Windows Named Pipes / Unix Domain Sockets to connect to the SAPControl Web Service of the underlying instance, regardless of its type. Make sure the Agent OS user has sufficient permissions to access the Named Pipe / Domain Socket.

If you specify HTTP, the SAPControl connector will use HTTP to connect to the SAPControl Web Service of the underlying instance, regardless of its type. The HTTP port defaults to 5<sysno>13, unless the services file (i.e. /etc/services on Unix, C:\Windows\System32\drivers\etc\services on Windows) contains an entry sapctrl<sysno> (HTTP) defining a different port. When you specify this option, you have to define a SAPControl User in the corresponding SAP System properties; see Defining the SAPControl User.

If you specify HTTPS, the SAPControl connector will use HTTPS to connect to the SAPControl Web Service of the underlying instance, regardless of its type. The HTTPS port defaults to 5<sysno>14, unless the services file (i.e. /etc/services on Unix, C:\Windows\System32\drivers\etc\services on Windows) contains an entry sapctrls<sysno> (HTTPS) defining a different port. When you specify this option, you have to define a SAPControl User in the corresponding SAP System properties; see Defining the SAPControl User.

Reference Data
Configures

ERS_Connect, WD_Connect, WD_ConnectionStat, WD_QueueStat, WD_ThreadStat

Default Value

Adaptive

Unit

Off, Adaptive, NamedPipes, HTTP, HTTPS

SAPHost

Configures the host name to be used if host name detection fails

Description

If host name detection fails, then the SAP host with the defined value is used.

Reference Data
Configures

All SAP checks

Default Value

Empty

Unit

String

SAPPSECertCrit

Define the critical threshold for the SAP PSE certificate valid to date

Description

If any of the 5 valid to dates PSE files is within the specified threshold set by monitoring parameter SAPPSECertCrit, the check status is set to Critical.

Reference Data
Configures

SAPPSECertificates

Default Value

10

Unit

Day

SAPPSECertWarn

Define the warning threshold for the SAP PSE certificate valid to date

Description

If any of the 5 valid to dates PSE files is within the threshold set by monitoring parameter SAPPSECertWarn, but not lower than the SAPPSECertCrit value, the check status is set to Warning.

Reference Data
Configures

SAPPSECertificates

Default Value

30

Unit

Day

SAPPSECertIgnore

Define the expiration period for the SAPPSECertificates check

Description

Expired certificates no longer contribute to SAPPSECertificates status if they are expired for SAPPSECertIgnore days or more.

Reference Data
Configures

SAPPSECertificates

Default Value

10

Unit

Days

SAPPSECertExclude

Configure the certificates for the SAPPSECertificates check not to consider

Description

Use this monitoring parameter to create a list of certificate files in CSV format (wildcard * is supported). The specified certificates will be excluded by the SAPPSECertificates check.

Reference Data
Configures

SAPPSECertificates

Default Value

sap_system_pki_instance.pse, TEMP*.pse

Unit

String

SAPPSECertInclude

Configure the certificates for the SAPPSECertificates to check

Description

Use this monitoring parameter to create a list of certificate files in CSV format (wildcard * is supported). Only the specified certificates will be scanned and processed by the SAPPSECertificates check. If left blank, all the certificates except the ones specified in the SAPPSECertExclude are considered.

Reference Data
Configures

SAPPSECertificates

Default Value

Empty

Unit

String

SAPRouterString

Configures route string describing a connection between two hosts

Description

Configure a route string describing a connection between two hosts using one or more SAProuters.

Reference Data
Configures

N/A

Default Value

Empty

Unit

String

SCSMsgSrvConnectErrsCrit

Configures sensitivity of the Java_Scs and Abap_Scs SAP Instance connection checks

Description

Starting from SCSMsgSrvConnectErrsCrit failed message server connection attempts the check status will turn from Warning toCritical.

Reference Data
Configures

ASCS_MSGSRV, SCS_MSGSRV

Default Value

1

Unit

Number

SCSMsgSrvHttpPort

Configures Java_Scs or Abap_Scs Messaging Server port

Description

Define the port to connect to the Java_Scs or Abap_Scs Messaging Server. By default, this is 81<system_number>.

Reference Data
Configures

ASCS_MSGSRV, SCS_MSGSRV

Default Value
Unit

Number

SCSMsgSrvHttpsPort

Configures Messaging Server’s HTTPS port to be used in case of HTTPS port detection fail

Description

If messaging server’s HTTPS port detection fails, then the defined value is used.

Reference Data
Configures

Messaging Server

Default Value

Empty

Unit

String

SNCLibraryPath

Overrides the SAP System Monitoring Parameter of the same name

Description

See the description of SNCLibraryPath.

Reference Data
Configures

RFCConnect

Default Value

n/a

Unit

String

SNCSecuDir

Overrides the SAP System Monitoring Parameter of the same name

Description

See the description of SNCSecuDir.

Reference Data
Configures

RFCConnect

Default Value

n/a

Unit

String

TimeOutCCMS

Configures timeout for CCMS

Description

The Avantra Agent waits TimeOutCCMS seconds before it cancels CCMS Custom Checks.

On very slow systems with a lot of CCMS Custom Checks defined it may be necessary to increase this parameter.

The parameter controls the cumulated runtime of all defined CCMS Custom Checks of a particular SAP Instance.

Reference Data
Configures

All Custom Checks of type CCMS*

Default Value

60

Unit

Seconds

TimeOutFullCheck

Controls the Daily Check timeout

Description

The Avantra Agent waits TimeOutFullCheck seconds before it cancels a running Daily Check.

It might be necessary to increase the timeout on very big systems (in terms of data size) and depending on the set of active checks.

The parameter controls the cumulated runtime of all Checks executed during a Daily Check.
Reference Data
Configures

Daily Check

Default Value

450

Unit

Seconds

TimeOutJ2EEConnect

Configures timeout for Java SAP Instanceconnection check

Description

The Avantra Agent waits TimeOutJ2EEConnect seconds before it cancels a running Java SAP Instance connection attempt.

Reference Data
Configures

J2EECONNECT

Default Value

60

Unit

Seconds

TimeOutMediumCheck

Controls timeout of checks executed in the Medium Check Cycle

Description

This is a legacy parameter only valid for Avantra Agents of release 5.2.

Avantra Agent waits TimeOutMediumCheck seconds before it cancels a running Medium Check Cycle. On very slow systems it may be necessary to increase this parameter.

Reference Data
Configures

MEDIUMCHECK

Default Value

300

Unit

Seconds

TimeOutMsgSrvConnect

Controls timeout of Abap_Scs and Java_Scs connection attempts

Description

The Avantra Agent waits TimeOutMsgSrvConnect seconds before it cancels a connection attempt to the Abap_Scs or Java_Scs message server.

Reference Data
Configures

ASCS_MSGSRV, SCS_MSGSRV

Default Value

30

Unit

Seconds

TimeOutRFCConnect

Controls timeout of ABAP SAP Instance connection attempt

Description

The Avantra Agent waits TimeOutRFCConnect seconds before it cancels a running RFC connection attempt.

Reference Data
Configures

RFCConnect

Default Value

30

Unit

Seconds

TimeOutSAPControl

Defines a timeout for SAPControl actions per instance.

Description

SAPControl is used for several operations during monitoring, like remote detection of instances for agentless SAP system monitoring, certain checks, etc. This monitoring parameter allows you to configure the connect and read timeout for those SAPControl operations per instance.

Reference Data
Configures

{WebDispatcher monitoring, ERS monitoring, _DispatcherQueue }

Default Value

30

Unit

Seconds

TimeOutTREXConnect

Controls timeout of TREX SAP Instance connection attempt

Description

The Avantra Agent waits TimeOutTREXConnect seconds before it cancels a running TREX connection attempt.

Reference Data
Configures

TREX Connect

Default Value

60

Unit

Seconds

TREXAlertStatusMapping

Configures mapping of Alert Server check status to Avantra check status.

Description

This parameter allows you to reconfigure the mapping of the check states of a TREX Alert Server to the check states of Avantra. You must specify a comma-separated list of numbers, which get assigned in order of their appearance to the Avantra states 2 (CRITICAL), 1 (WARNING), 0 (OK), -1 (UNKNOWN), -2 (DISABLED). Not all states must be specified, so it is sufficient to assign the first 3 values to get a proper mapping.

Optionally, you can specify mappings for the check name in addition to the default mapping, or you can simply change the mapping for individual checks. Consider the following examples:

2,1,0 : All TREX checks use mapping 2,1,0

2,1,0;TREX Alertserver Start: 3,2,1 : All TREX checks use mapping 2,1,0 except for check TREX Alertserver Start, which uses 3,2,1

TREX Disk Usage: 2,1,0; TREX CPU Usage: 2,1,0 : All TREX checks use the default mapping 3,2,1,0 except for checks TREX Disk Usage (2,1,0) and TREX CPU Usage (2,1,0).

The default assignment is 3 → 2 (CRITICAL), 2 → 1 (WARNING), 1 → 0 (OK), 0 → -1 (UNKNOWN)

Reference Data
Configures

All TREX checks retrieved from the AlertServer.

Default Value

3,2,1,0

Unit

List of numbers

TREXConnectErrsCrit

Configures sensitivity of the TREX SAP Instance connection check

Description

Starting from TREXConnectErrsCrit failed RFC connection attempts, the check status will turn from Warning to Critical.

Reference Data
Configures

TREX Connect

Default Value

1

Unit

Number

TREXLandscapeID

Configures the value to be used in case detection of the TREX landscape id fails

Description

If detection of TREX landscape id fails, then the defined value is used.

Reference Data
Configures

TREX checks

Default Value

Empty

Unit

String

WDCertAllowSelfSigned

Configures whether or not self-signed certificates are allowed

Description

If disabled, WD_Certificates will check the trust chain to the root certificate authority. If enabled, the trust chain is not verified, so that self-signed certificates will be OK.

Reference Data
Configures

WD_Certificates

Default Value

1

Unit

Boolean

WDCertDaysCrit

Configures Critical threshold for Web Dispatcher SSL certificate check

Description

If the number of days before the SSL certificate of the SAP Web Dispatcher expires is below this value, the check status is set to Critical.

Reference Data
Configures

WD_Certificates

Default Value

30

Unit

Days

WDCertDaysWarn

Configures Warning threshold for Web Dispatcher SSL certificate check

Description

Same as WDCertDaysCrit above, only this is the threshold for Warning check status.

Reference Data
Configures

WD_Certificates

Default Value

60

Unit

Days

WDConnectErrsCrit

Configures sensitivity of the Web Dispatcher SAP Instance connection check

Description

Starting from WDConnectErrsCrit failed connection attempts the check status will turn from Warning to Critical.

Reference Data
Configures

WD_Connect

Default Value

1

Unit

Number

WDConnUsageCrit

Configures Critical threshold for SAP Web Dispatcher connection usage

Description

If the number of used connections exceeds WDConnUsageCrit percent of the maximum number of connections available, the check status is set to Critical.

Reference Data
Configures

WD_ConnectionStat

Default Value

95

Unit

%

WDConnUsageWarn

Configures Warning threshold for SAP Web Dispatcher connection usage

Description

If the number of used connections exceeds this value but does not exceed WDConnUsageCrit percent of the maximum number of connections available, the check status is set to Warning.

Reference Data
Configures

WD_ConnectionStat

Default Value

85

Unit

%

WDQueueUsageCrit

Configures Critical threshold for SAP Web Dispatcher queue usage

Description

If the number of used queue entries exceeds WDQueueUsageCrit percent of the maximum number of entries available, the check status is set to Critical.

Reference Data
Configures

WD_QueueStat

Default Value

95

Unit

%

WDQueueUsageWarn

Configures Warning threshold for SAP Web Dispatcher queue usage

Description

If the number of used queue entries exceeds this value but does not exceed WDQueueUsageCrit percent of the maximum number of queue entries available, the check status is set to Warning.

Reference Data
Configures

WD_QueueStat

Default Value

85

Unit

%

WDThreadsUsageCrit

Configures Critical threshold for SAP Web Dispatcher worker threads usage

Description

If the number of used worker threads exceeds WDThreadsUsageCrit percent of the maximum number of worker threads available, the check status is set to Critical.

Reference Data
Configures

WD_ThreadStat

Default Value

95

Unit

%

WDThreadsUsageWarn

Configures Warning threshold for SAP Web Dispatcher worker threads usage

Description

If the number of used worker threads exceeds this value but does not exceed WDThreadsUsageCrit percent of the maximum number of worker threads available, the check status is set to Warning.

Reference Data
Configures

WD_ThreadStat

Default Value

85

Unit

%

WorkProcDiaStatusCrit

Configures work processes having a certain status or reason to be considered critical

Description

WorkProcDiaStatusCrit controls the optional part of the WorkProcesses check.

You can define a list of work process status (i.e. On Hold, Stopped, Shutdown, Reserved, Starting) and / or reasons (from the reason column of SAP transaction Work Process Overview`SM50`). If a work process is found with either the defined status or reason the Check will turn to Critical.

Reference Data
Configures

WorkProcesses

Default Value
Unit

List of status and reasons of work processes

WorkProcDiaStatusNOkPctCrit

Configures a critical threshold for the number of non-OK work processes

Description

Controls the first mandatory sub-check of WorkProcesses.

If the number of non-OK work processes exceeds WorkProcDiaStatusNOkPctCrit percent of the total number of work processes, the WorkProcesses check will turn to Critical.

Reference Data
Configures

WorkProcesses

Default Value

60

Unit

%

WorkProcDiaStatusNOkPctWarn

Configures a warning threshold for the number of non-OK work processes

Description

Controls the first mandatory sub-check of WorkProcesses. Warning threshold corresponding to WorkProcDiaStatusNOkPctCrit above.

If the number of non-OK work processes exceeds this value but not WorkProcDiaStatusCrit percent of the total number of work processes, the check will turn to Warning, unless any other of the executed sub-checks is Critical.

Reference Data
Configures

WorkProcesses

Default Value

30

Unit

%

WorkProcDiaStatusWarn

Configures work processes that have a certain status or reason for being considered a warning

Description

WorkProcDiaStatusWarn controls the optional part of the WorkProcesses check.

You can define a list of work process status (i.e. On Hold, Stopped, Shutdown, Reserved, Starting) and / or reasons (from the reason column of SAP transaction Work Process Overview`SM50`). If a work process is found with either the defined status or reason the Check will turn to Warning, unless any other of the executed sub-checks is Critical.

Reference Data
Configures

WorkProcesses

Default Value
Unit

List of status and reason of work processes

WorkProcDiaTimeUsageCrit

Configures critical threshold for work process CPU usage

Description

Controls the second mandatory sub-check of WorkProcesses.

If the elapsed CPU time of the dialog work process with the lowest CPU time is ≥ WorkProcDiaTimeUsageCrit % of the total elapsed time between two snapshots, the Check Result will be Critical.

Reference Data
Configures

WorkProcesses

Default Value

10

Unit

%

WorkProcDiaTimeUsageWarn

Configures warning threshold for work process CPU usage

Description

Controls the second mandatory sub-check of WorkProcesses.

If the elapsed CPU time of the dialog work process with the lowest CPU time is ≥ WorkProcDiaTimeUsageWarn but < WorkProcDiaTimeUsageCrit % of the total elapsed time between two snapshots, the Check Result will be Warning, unless any other of the executed sub-checks is Critical.

Reference Data
Configures

WorkProcesses

Default Value

5

Unit

%