Health Monitoring Metrics and Their Parameters

The following tables list the parameters for individual metrics in the Health Monitoring app of SAP Focused Run.

URL Availability (FRUN 2.0 FP01–FRUN 2.0 FP03)

Measures the availability of a URL. The URL is called by the central Simple Diagnostics Agent of the customer network.

URL Availability metrics have the following additional parameters:

FieldDescription
URL

The URL whose availability is monitored

Proxy URL (optional) 

Additional proxy URL used if the URL is outside your customer network.

URL Certificates (available since FRUN 1.0 FP03– FRUN 3.0 SP00)

Measures the remaining validity (in days) of an SSL certificate. The certificate is evaluated by calling the https URL and reading the expiration date from the response header. The URL is called by a central Simple Diagnostics Agent in the customer network.

URL Certificate metrics have the following additional parameters:

FieldDescription
URL

The URL whose certificate expiration is checked

Proxy URL (optional)

Additional proxy URL used if the URL is outside your customer network

Host Availability (FRUN 1.0 FP03–FRUN 2.0 FP03)

Measures the availability of a host. The central Simple Diagnostics Agent of the customer network performs an ICMP ping to the configured host name or IP address.

Host Availability metrics have the following additional parameters:

FieldDescription
HostnameThe name or IP address of the host whose availability is monitored

TCP Port Availability (FRUN 1.0 FP03–FRUN 2.0 FP03)

Measure the availability of a TCP port. The central Simple Diagnostics Agent of the customer network performs a TCP ping to the port on the host name or IP address.

TCP Port Availability metrics have the following additional parameters:

FieldDescription
Hostname / PortThe name (or IP address) and the port number of the host to be monitored. This must be in the format <hostname>:<port>

RFC Availability Metric of Subtype Application Server (FRUN 2.0 FP01FRUN 2.0 FP03)

Measures the availability of an application server instance of an SAP system or the availability of a message server port of an SAP system. A Simple Diagnostics Agent in the customer network performs a ping to an application server instance of an SAP system.

RFC Availability metrics of the subtype Application Server have the following additional parameters:

FieldDescription

Metric Name

Name of metric. It is advisable to choose a descriptive name that can be easily understood by others.
Application ServerApplication server of an SAP system
Instance NumberApplication server instance of an SAP system
System IDID of SAP system to be monitored
SAP Router StringContains information that SAProuter uses to create a connection between different hosts.

RFC Availability Metric of Subtype Logon Group (FRUN 2.0 FP01–FRUN 2.0 FP03)

Measures the availability of a message server port of an SAP system. A Simple Diagnostics Agent in the customer network performs a ping to a message server port of an SAP system.

RFC Availability metrics of the subtype Logon Group have the following additional parameters:

FieldDescription

Metric Name

Name of metric. It is advisable to choose a descriptive name that can be easily understood by others.
Message ServerMessage server of an SAP system
Message Server PortPort of a message server of an SAP system
System IDID of SAP system to be monitored
Logon Group (optional)Logon group of servers belonging to SAP system
SAP Router String (optional)Contains information that SAProuter uses to create a connection between different hosts.

Windows Services (available since FRUN 1.0 FP03)

Measure the status of a Windows service. This is measured by the local Simple Diagnostic Agent of the host.

Windows Services metrics have the following additional parameters:

FieldDescription
Service Name

String from the name of a Windows service that you want to monitor. The data collector searches for a Windows service with a name that includes all or part of the specified service name as a string. The status of the corresponding Windows service is then measured.

Example: You enter “abc” in the Service Name field. Health Monitoring then measures the status of the Windows service with a name containing “abc” – for example, “abcService”.

Host NameName of the host where the Windows service should be monitored. You can select from a list of all Windows hosts in the collection group.

OS Process (available since FRUN 1.0 FP03)

Measures whether an OS process is running on a host. The measurement is performed by the local Simple Diagnostics Agent of the host.

OS Process metrics have the following additional parameters:

FieldDescription
Process NameName of the OS process. This parameter needs to be maintained as a regular expression.
UserName of the OS user. To monitor processes from all users, leave this field empty. This parameter must be entered as a regular expression.
Command LineFull command line of the process. Also contains the command line parameters of the process. This parameter must be entered as a regular expression.
Host NameName of the host where the Windows service should be monitored. You can select from a list of all Windows hosts in the collection group.

OS Scripts (available since FRUN 2.0 FP01)

Measures the execution of a customer-specific operating system script on a host. The measurement is performed by the local Simple Diagnostics Agent of the host.

The OS Scripts metric evaluates the status of a custom operating system script execution. The status is defined by the exit code of the script. Exit code 0 corresponds to status Green. Exit code 1 corresponds to status Yellow. Exit Code 2 or higher corresponds to status Red.

OS Scripts metrics have the following additional parameters:

FieldDescription

Metric Name

Name of metric. It is advisable to choose a descriptive name that can be easily understood by others.
Metric Unit (optional)Unit of metric

Script Name

 
Name of operating system script
Parameters Input parameters for operating system script in the format parametername:parametervalue: for example, DBNAME:H10,DBTYPE:hdb

For details of how to create OS Script metrics, see the document Creating OS Script Metrics with Health Monitoring.

 

Logfile Monitor (available since FRUN 2.0 FP01)

Measures whether one or more log files on a host contain a search term. The measurement is performed by the local Simple Diagnostics Agent of the host.

Logfile Monitor metrics have the following parameters:

FieldDescription

Metric Name

Name of metric. It is advisable to choose a descriptive name that can be easily understood by others.
FolderFolder that contains the log file(s)
File PatternRegular expression to specify the log files to be searched
Search PatternRegular expression that specifies the search term

Delta Read

Checkbox specifying whether to search only the records of the log file that have been added since the last search (with checkmark) or to search through the entire log file (without checkmark).
File EncodingFile encoding of log file (for example, UTF-8, UTF-16)

HTTP Availability (available since FRUN 2.0 FP02)

Measures the availability of a URL.

When creating an HTTP Availability metric containing user credentials (for example, user), it is advisable to enter a technical user instead of a standard user to avoid violating the General Data Protection Regulation (GDPR).

An HTTP Availability metric has the following parameters:

FieldDescription

URL

The URL to be monitored

Proxy URL

Additional proxy URL used if the specified URL is outside your collection group

Proxy

Proxy to be used by the data collector when calling the URL specified in the metric. Available settings:

  • Auto: Use the operating system settings to identify whether a proxy should be used
  • None: No proxy should be used (for example, if automatic detection doesn't work)
  • Proxy URL: Set an explicit proxy URL

Authentication

The type of authentication used when the data collector calls the URL specified in the metric:

  • None: Do not use authentication
  • Basic: Use basic authentication (user/password)
  • OAuth: Use OAuth framework for authentication

Note:
When creating an HTTP Availability metric containing user credentials, it is advisable to enter a technical user instead of a person's user details to avoid violating the General Data Protection Regulation (GDPR).

Content Match

Search function using a regular expression to find content in responses. Can be switched on or off.
When the data collector calls a URL, an HTTP response is returned. When Content Match is switched on, the regular expression is applied to the body of the HTTP response. The result of the regular expression is either true or false. If it is true, the date collector returns the section of the response body that matches the regular expression.

User Agent

A user agent string transferred in the HTTP request when the data collector calls the URL. The user agent parameter is used by the data collector to mimic a Web browser when calling the URL specified in the metric.

Send Post Request

Parameter for sending post requests. Can be switched on or off. When it is switched on, the data collector performs an HTTP POST request instead of an HTTP GET request when calling the URL specified in the metric. Furthermore, you must specify two parameters: POST Payload and POST Payload Content Type. POST Payload contains the payload section used in the HTTP Post request. POST Payload Content Type specifies the type of data that is sent in the HTTP POST request.

To avoid violating the General Data Protection Regulation (GDPR), do not specify user credentials (for example, user and password) in the POST Payload parameter, because the parameter value is stored in the database in unencrypted form. In addition, the parameter value is sent to the Simple Diagnostics Agent in unencrypted form.

If you wish to specify user credentials, use the POST Secret parameter.

POST Secret (as of FRUN30 FP03)

This parameter enables you to include sensitive information such as user credentials (user and password) in the POST payload for an HTTP Availability metric.

To use the POST Secret parameter, first set Send POST Request to on. Select the appropriate POST payload content type from the dropdown. Enter the payload for the POST request, including the placeholder string $postsecret$. Then enter the sensitive information in the POST Secret field. This information is encrypted when you save it to the database.

When you save the metric, the data collector replaces the placeholder string in the payload with the content of the POST Secret field. The data collector then sends a POST request with the modified payload to the URL specified in the metric.

Use Client Certificate

TLS client authentication used against the URL or server specified in the metric. You can activate this parameter when you create a new or change an existing metric. When Use Client Certificate is set to on, the Health Monitoring app checks the HTTP availability using TLS authentication with a client certificate.

You can find the prerequisites for using this function here.

Timeout

Specified period in milliseconds (ms) before a call fails. When the data collector calls the URL specified in the metric, it expects a response within this period. If a response is received within the period, the call to the URL is successful.

If you leave this field empty, the default maximum timeout of 30 seconds is used.

If you enter 0, a timeout of 0 ms is applied. As a result, every collection of the metric ends with the status Timeout reached.

Any other numeric value you enter is applied accordingly: For example, if you enter 25, the call will fail after 25 ms. The maximum value you can enter is 30,000 ms (30 seconds).

Number of Retries

Number of times the data collector calls a URL until it receives a response. If the specified number of retries is exceeded, the call to the URL is unsuccessful.

RFC Availability: Subtype 'Application Server' (available since FRUN 2.0 FP03)

Measures the availability of an application server instance of an SAP system.

An RFC Availability metric of the subtype Application Server has the following parameters:

FieldDescription

Metric Name

Name of metric. It is advisable to choose a descriptive name that can be easily understood by others.

Application Server

Application server of an SAP system

Instance Number

Number of the chosen application server instance of an SAP system

System ID

ID of the SAP system to be monitored

SAP Router String

Contains information that SAProuter uses to create a connection between different hosts.

Authentication

The type of authentication used when the data collector calls the application server instance specified in the metric.

  • None: Do not use authentication
  • Basic: Use basic authentication (user/password)

Note:
When creating an RFC Availability metric of the subtype Application Server containing user credentials, it is advisable to enter a technical user instead of a person's user details to avoid violating the General Data Protection Regulation (GDPR).

Client

Client that is used to log on to the application server instance. This parameter is required only if basic authentication is selected.

Timeout

Specified period in milliseconds (ms) before a call fails. When the data collector calls the application server instance specified in the metric, it expects a response within this period. If a response is received within the period, the call to the application server instance is successful.

If you leave this field empty, the default maximum timeout of 30 seconds is used.

If you enter 0, a timeout of 0 ms is applied. As a result, every collection of the metric ends with the status Timeout reached.

Any other numeric value you enter is applied accordingly: For example, if you enter 25, the call will fail after 25 ms. The maximum value you can enter is 30,000 ms (30 seconds).

Number of Retries

Number of times the data collector calls an application server instance until it receives a response. If the specified number of retries is exceeded, the call to the application server instance is unsuccessful.

RFC Availability: Subtype 'Logon Group' (available since FRUN 2.0 FP03)

Measures the availability of a message server port of an SAP system.

An RFC Availability metric of the subtype Logon Group has the following parameters:

FieldDescription

Metric Name

Name of metric. It is advisable to choose a descriptive name that can be easily understood by others.

Message Server

Hostname of the message server of an SAP system

Message Server Port

Port of the chosen message server of an SAP system

System ID

ID of the SAP system to be monitored

Logon Group

Logon group of servers belonging to the chosen SAP system

SAP Router String

Contains information that SAProuter uses to create a connection between different hosts.

Authentication

The type of authentication used when the data collector calls the message server specified in the metric.

  • None: Do not use authentication
  • Basic: Use basic authentication (user/password)

Note:
When creating an RFC Availability metric of the subtype Logon Group containing user credentials, it is advisable to enter a technical user instead of a person's user details to avoid violating the General Data Protection Regulation (GDPR).

Client

Client that is used to log on to the message server. This parameter is required only if Basic Authentication selected.

Timeout

Specified period in milliseconds (ms) before a call fails. When the data collector calls the message server specified in the metric, it expects a response within this period. If a response is received within the period, the call to the message server is successful.

If you leave this field empty, the default maximum timeout of 30 seconds is used.

If you enter 0, a timeout of 0 ms is applied. As a result, every collection of the metric ends with the status Timeout reached.

Any other numeric value you enter is applied accordingly: For example, if you enter 25, the call will fail after 25 ms. The maximum value you can enter is 30,000 ms (30 seconds).

Number of Retries

Number of times the data collector calls a message server until it receives a response. If the specified number of retries is exceeded, the call to the message server is unsuccessful.

TCP Availability (available since FRUN 2.0 FP03)

Measure either the availability of a TCP port or the availability of a host.

A TCP Availability metric has the following parameters:

FieldDescription

Host Name / Port

The host name (or IP address) and the port number. This must be maintained in the format <hostname>:<port>.

Timeout

Specified period in milliseconds (ms) before a call fails. When the data collector calls the URL specified in the metric, it expects a response within this period. If a response is received within the period, the call to the URL is successful.

If you leave this field empty, the default maximum timeout of 30 seconds is used.

If you enter 0, a timeout of 0 ms is applied. As a result, every collection of the metric ends with the status Timeout reached.

Any other numeric value you enter is applied accordingly: For example, if you enter 25, the call will fail after 25 ms. The maximum value you can enter is 30,000 ms (30 seconds).

Number of Retries

Number of times the data collector calls a URL until it receives a response. If the specified number of retries is exceeded, the call to the URL is unsuccessful.

HTTP Health API (available since FRUN 3.0 SP00)

Measure the health of a cloud application specified by its URL.

An HTTP Health API metric has the following parameters:

FieldDescription

URL

The URL to be monitored

Proxy URL

Additional proxy URL used if the specified URL is outside your collection group

Proxy

Proxy to be used by the data collector when calling the URL specified in the metric. Available settings:

  • Auto: Use the operating system settings to identify whether a proxy should be used
  • None: No proxy should be used (for example, if automatic detection doesn't work)
  • Proxy URL: Set an explicit proxy URL

Authentication

The type of authentication used when the data collector calls the URL specified in the metric:

  • None: Do not use authentication
  • Basic: Use basic authentication (user/password)
  • OAuth: Use OAuth framework for authentication

Note: 
When creating an HTTP Health API  metric containing user credentials, it is advisable to enter a technical user instead of a person's user details to avoid violating the General Data Protection Regulation (GDPR).

Timeout

Specified period in milliseconds (ms) before a call fails. When the data collector calls the URL specified in the metric, it expects a response within this period. If a response is received within the period, the call to the URL is successful.

If you leave this field empty, the default maximum timeout of 30 seconds is used.

If you enter 0, a timeout of 0 ms is applied. As a result, every collection of the metric ends with the status Timeout reached

Any other numeric value you enter is applied accordingly: For example, if you enter 25, the call will fail after 25 ms. The maximum value you can enter is 30,000 ms (30 seconds).

Number of Retries

Number of times the data collector calls a URL until it receives a response. If the specified number of retries is exceeded, the call to the URL is unsuccessful.

Prometheus (available since FRUN 3.0 SP00)

Measure the health of a cloud application specified by its URL.

Prometheus metric has the following parameters:

FieldDescription

URL

The URL to be monitored

Proxy URL

Additional proxy URL used if the specified URL is outside your collection group

Proxy

Proxy to be used by the data collector when calling the URL specified in the metric. Available settings:

  • Auto: Use the operating system settings to identify whether a proxy should be used
  • None: No proxy should be used (for example, if automatic detection doesn't work)
  • Proxy URL: Set an explicit proxy URL

Authentication

The type of authentication used when the data collector calls the URL specified in the metric:

  • None: Do not use authentication
  • Basic: Use basic authentication (user/password)
  • OAuth: Use OAuth framework for authentication

Note: 
When creating a Prometheus  metric containing user credentials, it is advisable to enter a technical user instead of a person's user details to avoid violating the General Data Protection Regulation (GDPR).

Timeout

Specified period in milliseconds (ms) before a call fails. When the data collector calls the URL specified in the metric, it expects a response within this period. If a response is received within the period, the call to the URL is successful.

If you leave this field empty, the default maximum timeout of 30 seconds is used.

If you enter 0, a timeout of 0 ms is applied. As a result, every collection of the metric ends with the status Timeout reached.

Any other numeric value you enter is applied accordingly: For example, if you enter 25, the call will fail after 25 ms. The maximum value you can enter is 30,000 ms (30 seconds).

Number of Retries

Number of times the data collector calls a URL until it receives a response. If the specified number of retries is exceeded, the call to the URL is unsuccessful.