Health Monitoring (Open Component Monitoring)
The Health Monitoring app (formerly Open Component Monitoring) supports Advanced System Management by providing additional monitoring metrics that go beyond standard system monitoring. Use Health Monitoring when configuration differs vastly between managed objects. In addition, Health Monitoring is used to provide low-barrier monitoring for managed objects that are not included in the landscape management database (LMDB).
Health Monitoring provides the following types of metrics for monitoring managed objects:
- General metrics
- Availability metrics
- Application Check metrics
The monitoring data of a metric is collected by a Simple Diagnostics Agent (SDA). Depending on the type of metric, an SDA is used which is either installed on a host of the monitored object or on a host in a collection group in which the monitored object is located.
A collection group corresponds either to a customer network or to a subnetwork of a customer network. Collection groups of the first kind are available in Health Monitoring automatically if the relevant customer networks are defined in SAP Focused Run. You can create, change, and delete collection groups of the second kind in the Health Monitoring app.
General Metrics
| Metric Name | Description | Available since |
|---|---|---|
| URL Availability | Measures the availability of a URL. The URL is called by a Simple Diagnostics Agent in the collection group. | FRUN 1.0 FP03–FRUN 2.0 FP03 |
| URL Certificates | Measures the remaining validity (in days) of an SSL certificate. The URL is called by a Simple Diagnostics Agent in the collection group. | FRUN 1.0 FP03–FRUN 3.0 SP00 |
| Host Availability | Measures the availability of a host. A Simple Diagnostics Agent in the collection group performs a ping to the configured host name or IP address. | FRUN 1.0 FP03–FRUN 2.0 FP03 |
| TCP Port Availability | Measures the availability of a TCP port. A Simple Diagnostics Agent in the collection group performs a TCP ping to the port on the host name or IP address. | FRUN 1.0 FP03–FRUN 2.0 FP03 |
| RFC Availability | 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 collection group performs a ping to an application server instance or to a message server port of an SAP system. | FRUN 1.0 FP03–FRUN 2.0 FP03 |
| Windows Services | Measures whether a service is running on a host with Windows operating system. Measurement is performed by the local Simple Diagnostics Agent of the host. | FRUN 1.0 FP03 |
| OS Processes | Measures whether an operating system process is running on a host. Measurement is performed by the local Simple Diagnostics Agent of the host. | FRUN 1.0 FP03 |
| OS Scripts | Measures the execution of a customer-specific operating system script on a host. Measurement is performed by the local Simple Diagnostics Agent of the host. | FRUN 2.0 FP01 |
| Logfile Monitor | Measures whether one or more log files on a host contain a search term. Measurement is performed by the local Simple Diagnostics Agent of the host. | FRUN 2.0 FP01 |
For details of the various parameters for general metrics, click here.
Availability Metrics
| Metric Name | Description | Available since |
|---|---|---|
| HTTP Availability | Like the URL Availability metric and the URL Certificate metric, this metric measures the availability of a URL and the remaining validity (in days) of an SSL certificate. However, HTTP Availability offers more functionality than the URL Availability metric and the URL Certificate metric. The specified URL is called by a data collector running on a Simple Diagnostics Agent in the collection group. | FRUN 2.0 FP02 |
| RFC Availability | Measures the availability of an application server instance of an SAP system or the availability of a message server port of an SAP system. This RFC Availability metric offers more functionality than the general metric of the same name. A Simple Diagnostics Agent in the collection group performs a ping to an application server instance or to a message server port of an SAP system. | FRUN 2.0 FP03 |
TCP Availability
| Combines the functionality of the general metrics TCP Port Availability and Host Availability. The TCP Availability metric can measure the availability of a TCP port or the availability of a host. It offers more functionality than the TCP Port Availability and Host Availability metrics. A Simple Diagnostics Agent in the collection group performs a TCP ping either to the port of a host or to the host. You specify the host by name or IP address. | FRUN 2.0 FP03 |
For details of the various parameters for Availability metrics, click here.
Application Check Metrics
| Metric Name | Description | Available since |
|---|---|---|
| HTTP Health API | Measures the health of a cloud application specified by its URL. The cloud application implements an API. The API is called by a data collector running on a Simple Diagnostics Agent in the collection group. The data collector uses the API to extract KPIs (key performance indicators) from the cloud application – for example, availability of a cloud service belonging to the application, CPU usage of a cloud service, or disk usage of a cloud service. | FRUN 3.0 SP00 |
| Prometheus | Measures the health of a cloud application specified by its URL. The cloud application implements a Prometheus API to provide monitoring data for the open-source Prometheus systems monitoring and alerting application. The Prometheus API of a cloud application is called by a data collector running on a Simple Diagnostics Agent in the collection group. The data collector uses the Prometheus API to extract KPIs (key performance indicators) from the cloud application. KPIs include, for example, the availability of a cloud service belonging to the application service. | FRUN 3.0 SP00 |
| Health Push | A program executed periodically as a job in the SAP Focused Run system calls APIs on SAP Business Technology Platform (SAP BTP) to extract key performance indicators (KPIs) from SAP BTP, Neo environment. These are either KPIs that refer to Java applications running in the Neo environment or KPIs that refer to database systems running in the Neo environment. Examples of such KPIs include CPU load and OS memory usage. | FRUN 3.0 FP02 |
You can configure your own custom Metric Analysis pages for Availability Check metrics. For more information, see here.
If you want to collect metrics from SAP Business Technology Platform, Neo Environment, check out the setup here.
For details of the various parameters for Application Check metrics, click here.
Configuration
Activate Collection Group
Many Health Monitoring metrics are unmodeled, which means they are not assigned to a specific technical system in the landscape. Nevertheless, they need to be executed by a Simple Diagnostics Agent, which must be located inside the collection group. It is therefore necessary, as a first step, to define a central Simple Diagnostics Agent in the collection group which should execute the Health Monitoring metrics.
To activate a collection group, proceed as follows:
- Choose the Configuration button in the top right corner of the Health Monitoring app.
- Expand the Collection Group area.
- You can see all the collection groups in scope and their status. Choose the switch next to the collection group to activate it.
- Select the Simple Diagnostics Agent that should be used by Health Monitoring and choose Save.
- The collection group is now active and can be used by Health Monitoring.
- Note: You can choose the Edit button to assign another Simple Diagnostics Agent, if necessary.
Create New Metrics
Perform the following steps to create a new Health Monitoring metric:
- Choose the corresponding tab on left of the screen (for example, Availability to create an Availability metric).
- Choose the + button.
- Select a metric type (only relevant for Availability and Application Check metrics).
- Maintain metric and alert attributes (see the table below for descriptions of parameters shared by all metrics).
- Choose Save.
- Your metric is now active and is visible in the Health Monitoring application
If you have to create or change multiple Availability metrics simultaneously, you can use the mass maintenance functionality in Health Monitoring (available since FRUN 3.0 SP00). For further details, see the guide Mass Maintenance of Availability Metrics in Health Monitoring.
Here is a list of the metric parameters used by all metrics in Health Monitoring. There are additional metric-specific parameters, which are described in the respective chapters below.
| Field | Description |
|---|---|
| Metric Name | A descriptive name for the metric. It is advisable to choose a name that can be easily understood by others. |
| Collection Group | The collection group in which the metric is created |
| Collection Interval/ Collection Frequency | How often the metric is collected |
| Threshold | The metric threshold. For each metric, you specify a threshold and what happens when this threshold is reached – for example, set status of metric to red (error). |
| Metric Documentation | Additional information about the metric |
| Alert Active | Parameter that allows an alert to be triggered when the metric fails |
| Alert Name | The name of the alert. It is advisable to choose a descriptive name that can be easily understood by others. |
| Severity | Severity of the alert in Alert Management. Maintain a value between 0 (very low) and 9 (Critical). |
| Notification Variant (optional) | Selection of notification for sending an additional e-mail for the alert, if required |
| Additional Attributes | An attribute and an attribute value (optional) add additional information to a metric. You can also add multiple attribute/value pairs to a metric. For example, you could specify an attribute SID and an attribute value FRN for a metric to specify that this metric refers to an SAP system with the system ID FRN. You can use additional attributes to group the data displayed (for example, in the Attribute Overview tab or in a table). |
| Outbound Connector Variant (optional) | Selection of outbound connector for forwarding the alert via BAdI implementation, if required |
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:
| Field | Description |
|---|---|
| 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:
| Field | Description |
|---|---|
| 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:
| Field | Description |
|---|---|
| Hostname | The 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:
| Field | Description |
|---|---|
| Hostname / Port | The 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 FP01–FRUN 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:
| Field | Description |
|---|---|
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 | Application server instance of an SAP system |
| System ID | ID of SAP system to be monitored |
| SAP Router String | Contains 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:
| Field | Description |
|---|---|
Metric Name | Name of metric. It is advisable to choose a descriptive name that can be easily understood by others. |
| Message Server | Message server of an SAP system |
| Message Server Port | Port of a message server of an SAP system |
| System ID | ID 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:
| Field | Description |
|---|---|
| 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. |
| Host Name | Name 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:
| Field | Description |
|---|---|
| Process Name | Name of the OS process. This parameter needs to be maintained as a regular expression. |
| User | Name of the OS user. To monitor processes from all users, leave this field empty. This parameter must be entered as a regular expression. |
| Command Line | Full command line of the process. Also contains the command line parameters of the process. This parameter must be entered as a regular expression. |
| Host Name | Name 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:
| Field | Description |
|---|---|
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:
| Field | Description |
|---|---|
Metric Name | Name of metric. It is advisable to choose a descriptive name that can be easily understood by others. |
| Folder | Folder that contains the log file(s) |
| File Pattern | Regular expression to specify the log files to be searched |
| Search Pattern | Regular 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 Encoding | File 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:
| Field | Description |
|---|---|
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:
|
Authentication | The type of authentication used when the data collector calls the URL specified in the metric:
Note: |
Content Match | Search function using a regular expression to find content in responses. Can be switched on or off. |
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. |
| 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:
| Field | Description |
|---|---|
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.
Note: |
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:
| Field | Description |
|---|---|
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.
Note: |
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:
| Field | Description |
|---|---|
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:
| Field | Description |
|---|---|
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:
|
Authentication | The type of authentication used when the data collector calls the URL specified in the metric:
Note: |
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.
A Prometheus metric has the following parameters:
| Field | Description |
|---|---|
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:
|
Authentication | The type of authentication used when the data collector calls the URL specified in the metric:
Note: |
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. |
Housekeeping Settings
The SAP_FRN_OCM_HOUSEKEEPING job deletes data that is no longer required from the Health Monitoring database tables (see the Master Guide for SAP Focused Run). The housekeeping job runs once a day.
To view the status of the last run and the scheduled date/time of the next run, proceed as follows:
In the Health Monitoring app, choose the Configuration button (gear icon) at the top right of the screen and then open the Infrastructure panel.
In the database table ocm_hkconfig, you can specify the Health Monitoring database tables from which the data should be deleted. In addition, you can specify a lifespan for the data of each Health Monitoring database. Any data older than the number of days you enter (lifespan) is then deleted. The database table ocm_hkconfig contains default values delivered by SAP. However, these values can be overwritten.
To maintain housekeeping settings in the database table ocm_hkconfig, perform the following steps:
- Go to transaction SM30 (Extended Table Maintenance) and enter OCM_HKCONFIG in the Table/View field. Then choose the Maintain button.
- In the Store Table Name field, enter the Health Monitoring database table from which data is to be deleted (for example, ocm_mon_raw). In the field Partition Field Name, Specify a date field of the database table. The lifespan is calculated with reference to the value in this field. In the Lifespan field, enter a lifespan in days. Then choose Save.
You can maintain the housekeeping settings for each of your SAP Focused Run systems, or you can transport the settings – for example, from a test system to a productive system. To transport the settings, go to transaction SM30 (Extended Table Maintenance), enter OCM_HKCONFIG in the Table/View field, then choose the Maintain button. Next, select the table rows and choose Table View > Transport to store the settings in a Customizing request. You can now transport the Customizing request from your test system to your productive system, for example.
Configuration Examples
Groupware Connector
You can create the following metrics to monitor the availability of a Groupware Connector Server:
Groupware Connector
Create a new Windows Services metric with the following parameters:
- Metric Name: Groupware Connector
- Service Name: MsxGwConnector7.0_0
- Host Name: <host name of groupware server>
- Additional Attributes: Groupware
- Collection Interval: 1 Minute
- Alert Name: Groupware Connector not running
Groupware MS Proxy
Create a new Windows Services metric with the following parameters:
- Metric Name: Groupware MS Proxy
- Service Name: MsxGwProxy7.0_0
- Host Name: <host name of groupware server>
- Additional Attributes: Groupware
- Collection Interval: 1 Minute
- Alert Name: Groupware MS Proxy not running
Other configuration examples are available in our SAP Focused Run - Internet Demo System.