SAP Instance - Custom Checks

Please enter the active user count to be used as the Warning threshold

Please enter the active user count to be used as the Critical threshold

In order to find the appropriate values for this field, log into your SAP System and proceed to transaction RZ20.

If this flag is set the Avantra Agent automatically confirms the CCMS Alerts corresponding to the Monitoring Tree Element and imports them into Avantra where they can be viewed using Avantra WebUI.

Choose the check status Avantra is to display in case the SAP status is either unknown or invalid.

Specify the file systems to be included. Wildcards * and ? are supported.

Specify the thresholds, see as well FSUsageWarn and FSUsageWarn. For Unix, you can as well define thresholds for the inodes, see FSNodeWarn and FSNodeCrit.

Specify the thresholds for monitoring the inodes on Unix, see as well FSNodeWarn and FSNodeCrit.

Define the absolute path name of the file monitored in this field. File name substitution is provided in case wildcard characters (like * or ?) are used.

Define the check status to be returned if the file exists.

Define the check status to be returned if the file does not exist.

Define the absolute path name of the file monitored in this field. File name substitution is provided in case wildcard characters (like * or ?) are used.

Define the Warning threshold.

Define a Critical threshold.

Performs an HTTP HEAD request, i.e. only the header of the response will be retrieved.

Performs an HTTP GET request. Basic Authentication is supported as well

Performs an HTTP POST request. HTML Form data can be provided URL-encoded

The URL of the site you want to verify.

Set this flag if you want to interpret JavaScript eventually returned with the response.

If you need to define a proxy server in order to access the site defined in the URL field you may fill in this value.

By default, the Avantra Agent uses the string agent/[version] in order to identify as a user agent. Some web servers may restrict access to certain browsers, like the Microsoft Internet Explorer or Mozilla Firefox, or they behave differently using one of these browsers.

Choose HEAD or GET or POST.

In case you have chosen GET in the Method field you may fill in a user name and a password in this field if Basic Authentication is required by the requested URL.

In case you have chosen POST in the Method field, you have to fill in the form data in URL-encoded format.

You may define a value for the connection timeout. The default is 10 seconds. Please note: This is a timeout for the sub-process spawned to perform the connection attempt. The timeout for the HTTP request itself will always be 80% of the defined value.

If filled with a value > 1, all consecutive failed connection attempts will return a Warning check status until the threshold is exceeded. The Check turns to Critical afterwards.

You can filter the response for one or multiple strings by filling in data in this field.

If there is a value defined in the Content must contain string and the string is not found in the response, this check status is returned.

If there is a value defined in the Content must contain string and the string is found in the response, this check status is returned.

Fill in a Warning threshold for the response time.

Fill in a Critical threshold for the response time.

Fill in a Warning threshold if the check shall verify SSL certificate expiry time.

Fill in a Critical threshold if the check shall verify SSL certificate expiry time.

Select the check status to return in case an SSL certificate is invalid.

This parameter defines the component type the mapping shall be applied to.

Specify the Name Pattern for the components to be mapped. You may enter an exact name, a name with wildcards (? for a single-character wildcard, * for a multiple-character wildcard), or a regex. For a regex, you’ll have to provide '/' at the beginning and at the end of the expression. Regex mapping will always be case insensitive.

Specify a list of status names to be mapped, separated by commas. The status names correspond directly to the data retrieved from the SAP Control interface, usually, the following status names are available: running, stopped, failed, starting, stopping.

Select the sub Status for the entry if the mapping matches.

Select the sub Status for the entry if the mapping doesn’t match.

This path defines the Monitor MBean you want to access. Use one of the following methods to retrieve the Monitor MBean path:

Specify the node type this check should be applied to. There are many MBeans with the same path for server and dispatcher nodes, but some MBeans exist only for server nodes and vice-versa. There are even MBeans that exist for both node types but are registered under a different path (like for example /Services/Memory Info/UsedMemory on a dispatcher node and /Services/Memory/UsedMemory on a server node).

Select the monitor type. In the Visual Administrator, you can find this value in the Type field of the Monitor Configuration dialog window for the selected monitor object. Apparently, there is no equivalent information in the SAP NetWeaver Administrator, so you probably have to perform educated guessing based on the information provided in the Value field.

The available options for this field depend on the value selected in Monitor Type. Choose the one of your interest. There are some special cases if the selected value in Monitor Type is Table Monitor or Configuration Monitor.

See the description of Monitor Value.

See the description of Monitor Value.

See the description of Monitor Value.

Specify a Warning threshold and the desired comparison operator.

Specify a Critical threshold and the desired comparison operator.

Choose the check status Avantra is to display in case the SAP status is either unknown or invalid.

The JavaScript program providing the check data retrieval and evaluation logic. See section API Documentation.

If this option is enabled, the time to run the script is appended to the check result text. This might be useful to check if the performance of a script is good.

Starting with Avantra Version 21.11, you can run tests for newly created RUN_JS checks on the selected Agent directly from the Avantra WebUI. This feature does not require saving or activating the check, i.e. it can be tested before affecting the execution of the check on other systems.

The type of a Log Adapter.

Select your desired Log Adapter. As soon as you have selected a Log Adapter, the available Macros are loaded and the Expression Editors in various fields are initialized.

If you have selected File Adapter in Log Adapter Type you have to fill in this value, which indicates the path and file name of the target log files.

See Log File Path Pattern.

This setting defines which entries of the log files are to be processed. Log entries written since last check cycle processes all log entries that have been added after the last read of the file. Log entries written in last x minutes reads all entries that have been added during the past Log Entry Timespan minutes.

Fill in the period of time the {avantra-agent} should look back while processing the log file if Log entries written in last x minutes is selected in _Log Adapter Processing>.

Define a conditional expression that indicates log entries considered as Warning.

Define a conditional expression that indicates log entries considered as Critical.

In the Warning Trigger section, this value defines how many entries must be matched to the condition before the check status will be set as Warning. I.e. if there are only 2 entries matching and this value is set to 3, then the check status will be OK. If there are 3 or more entries matching, then the check status will be set as Warning.

Define a conditional expression that indicates log entries that resolve issues found using Warning Condition or Critical Condition.

You can specify the format of the check message shown in RealTime Monitoring or used in Notifications.

Define the display of a matched log entry in the check message. You may enter arbitrary text tokens in the field, and you may use all Macros available for the selected Log Adapter (using the icon) to build a meaningful description text.

Fill in the host name or the IP address of the remote host.

Define a Warning threshold for packet loss.

Define a Critical threshold for packet loss.

Define a Warning threshold for the average round-trip time.

Define a Critical threshold for the average round-trip time.

Define a time out for the Check. The check status will be Critical if the time out is exceeded.

Define the number of ICMP packets to send per Check

Define the size of ICMP echo request packets

The type of system configuration to be verified, either Profile Parameter for parameters found in an SAP instance profile, or Java Service Property for parameters of Services and Managers found in the section Java System Properties of the SAP NetWeaver Administrator.

The name of the profile parameter, you want to verify the value of. Examples in the security area of an ABAP instance are login/no_automatic_user_sapstar or in the compliance area rec/client.

The operator used to compare the actual value against the given value. You can choose from a variety of text and numerical operators, a between operator, and regular expressions. If you use numerical operators, the given value and the actual value will be checked if they look like a number. A wide range of numerical notations is supported, integers, floating point, scientific. The between operator will evaluate to true, when the actual value is inclusively between the two given values.

The given value of the profile parameter, i.e. the value the monitoring parameter should have. This value will be compared against the actual value. The actual value is retrieved by RFC using a kernel function, so no matter if it is defined in the default or instance profile, the actual effective value will be used.

Free text field to add a custom reference which will appear in the check output. This might be useful in Service Level Reports to document a certain paragraph or the like.

Select the status, in case the parameter actual value does not match the given value, either Warning or Critical.

Select the status, in case the parameter actual value does not exist, either Ok, Warning or Critical.

Select the status, in case the parameter actual value is the null value, either Ok, Warning, or Critical.

Enter the name of the process you want to monitor.

If the number of running processes falls below this threshold, a Critical check status is returned.

If the number of running processes falls below this value, but does not exceed the value defined in Critical alert if number of processes is lower than, a Warning check status is returned.

If the number of running processes exceeds this threshold, but is still below the value defined in Critical alert if number of processes is higher than, a Warning check status is returned.

If the number of running processes exceeds this threshold, a Critical check status is returned. If the field is left blank, no Critical Check Results will be returned.

Define the full command line call to be executed by the Avantra Agent. It is recommended to use absolute path names whenever possible.

/bin/sh "%%PROG_DIR%%/proggy.sh" -param 1 -param 2

"C:\Program Files\system32\cmd.exe" "%%PROG_DIR%%\proggy.cmd" /param 1 /param 2

Define a working directory of the executed script or program.

Define environment variables for the executed script or program. Please note that multiple entries must be separated by commas or semicolons. The format is name ‘=' value { (';' | ',’) name '=’ value}

Define a timeout for the executed script or program.

Use this field to define the exit code of your program that shall indicate an Unknown check status.

If you want the {custom-check} to collect performance data (which must be written to console output by the program), check _Select Performance Resource Type and choose a previously defined custom performance resource type from the list. See Configuring Custom Performance Data Resource Types on how to define custom performance resource types.

Determine whether to return the check status as Ok, Warning, Critical, Unknown if the timeout specified in the Time out setting is exceeded.

Check the box to not display the command line in the check result.

Use the Upload Program button in order to select a script or program to deploy.

Read-only field containing the name of the script or program once it is deployed. The name is displayed as a link that allows you to download the script or program.

Read-only field containing the MD5http://en.wikipedia.org/wiki/Checksum[checksum] of the script or program once it is deployed. This value is used to detect whether the file copied to the target System's filesystem has not been modified.

Read-only field containing the date the script or program was uploaded.

You may define where the script/program is supposed to reside in the target System's filesystem by filling in the appropriate directory.

If you set this flag, the Avantra Agent will take care to remove the script/program once the Custom Check is deleted. The Program Directory is also removed if it is empty.

If you enter a value, the Custom Check will record the Service Availability for use in e.g. Service Level Reports.

If Service Availability is recorded, a Warning check status is usually considered Down. Set this flag if you want the Warning check status to be considered Up instead.

Set the alert nodes you want to include in the check. Click on + and - to include multiple nodes. You can use wildcard * to select multiple alerts.

Alert nodes are hierarchically in a tree structure organized. Mark this option if you want to include the full path to the alert nodes in the check result.

If checked, unknown alerts (GRAY) are included in the check result.

Set to report unknown/GRAY alerts as a different status. E.g. report unknown alerts as CRITICAL.

If set, the overall check status remains OK even though some alerts are RED or YELLOW. Use this option if you are only interested in the value of the alerts but not in the status.

Define the check status in case a matching system log entry is found.

Enter the time span you wish to monitor.

Define whether you want to watch for certain system log entries or for a whole problem class.

Define a message text you want to filter. The wildcard * is supported.

Fill in a (blank-separated) list of message numbers to watch for.

Select the problem class you want to monitor.

Restrict to certain transactions. Multiple entries have to be separated by a blank. The wildcard * is supported.

Restrict to certain clients. Multiple entries have to be separated by a blank.

Restrict to certain users. Multiple entries have to be separated by a blank. The wildcard * is supported.

Restrict to a certain work process type.

Exclude a list of message numbers or a list of message number ranges.

Define at least one RFC destination.

Choose the check status to return in case the connection test fails.

Define the transaction code of the transaction to be monitored. If you do not know your transaction code, open the transaction to be monitored with SAP GUI and choose System  Status. You will find the transaction code in the dialog displayed.

If you want to restrict the runtime to be evaluated in a single client only, you may enter the client number. It is possible to monitor all transactions of a given client as well. In this case, leave the Transaction field blank and fill in the client only.

Define a Warning threshold for the runtime.

Define a Critical threshold for the runtime.

Number of days from today to check for event queue errors. If blank, then it defaults to 7 days.

Filter for including object type(s). The format is comma-separated without spaces, i.e., ADDRESS, BUS20* Default is all object types.

Define the display name or the technical service name in this field. You can find the technical Service Name in the field Service Name of the General tab in the Properties of the respective service.

Select the check status in case the service is running.

Select the check status in case the service exists but is not running.

Select the check status in case the service does not exist.