Open Component Monitoring

Open Component Monitoring (OCM) in SAP Focused Run supports Advanced System Management by providing additional monitoring metrics that go beyond standard system monitoring. Use Open Component Monitoring when configuration vastly differs between managed objects. Furthermore, Open Component Monitoring is used to provide low-barrier monitoring for managed objects which are not contained in the Landscape Management Database (LMDB).

Open Component Monitoring provides the following metrics to monitor managed objects:

Metric Description Availability
since
URL Availability Measures the availability of a URL. The URL is called from a Simple Diagnostic Agent in the customer network. FRUN1.0 FP03
URL Certificates Measures the remaining validity (in days) of a SSL certificate. The URL is called from a Simple Diagnostic Agent in the customer network. FRUN1.0 FP03
Host Availability Measures the availability of a host. A Simple Diagnostics Agent in the customer network performs a ping to the configured host name or IP address. FRUN1.0 FP03 
TCP Port Availability

Measures the availability of a TCP port. A Simple Diagnostic Agent in the customer network performs a TCP ping to the port on the host name or IP address.

FRUN1.0 FP03 
RFC Availability

Measures the availability of an Application Server Instance of a SAP System or the availability of a Message Server Port of an SAP System. A Simple Diagnostic Agent in the customer network performs a ping to an Application Server Instance or to a Message Server Port of an SAP System.

FRUN20 FP01
Windows Services Measures if a service is running on a host with Windows Operating System. Measurement is done by the local Simple Diagnostic Agent of the host. FRUN1.0 FP03 
OS Processes

Measures if an operating system process is running on a host. Measurement is done by the local Simple Diagnostic Agent of the host.

FRUN1.0 FP03
OS Scripts Measures the execution of a customer specific operating system script on a host. Measurement is done by the local Simple Diagnostic Agent of the host. FRUN20 FP01
Logfile Monitor Measures if one or several log files on a host contain a search term. Measurement is done by the local Simple Diagnostic Agent of the host. FRUN20 FP01 
HTTP Availability Like Metric ‘URL Availability' this Metric measures the availability of an URL. The URL is called from a Data Collector running on Simple Diagnostic Agent (SDA) in the customer network. FRUN20 FP02

For each Metric you define how often the Metric is measured within a time interval by a Simple Diagnostics Agent (Collection Interval). For example a Collection Interval of one minute means that a Simple Diagnostics Agent measures the Metric once per minute.

For each Metric you specify a Threshold. In Addition you specify what shall happen when a Threshold is reached e. g. set status of the Metric to red (Error).

Optionally you can define for each Metric an Alert which is created when the Threshold is reached. An Alert is shown in FRUN applications Open Component Monitoring and Alert and Event Management (AEM).

For Metrics which are collected by a Simple Diagnostics Agent in a customer network you can specify a managed object contained in Landscape Management Database. Currently managed objects of type ‘Technical System' with subtype ‘External Service' are supported.

Configuration

Activate Customer Network

Many Open Component Monitoring metrics are unmodeled, which means that they are not assigned to a specific technical system in the landscape. Nevertheless, they need to be executed by a Simple Diagnostic Agent, which needs to be located inside the customer network. Therefore, it is necessary as a first step to define a central Simple Diagnostic Agent in the customer network which should execute the Open Component Monitoring metrics.

Proceed as Follows to Activate a Customer Network

  • Click the “Configuration” button in the top right corner of the Open Component Monitoring application
  • Open the area “Customer Networks”
  • You can see all customer networks in scope and their status. Click on the switch next to the customer network to activate it.
  • Select the Simple Diagnostic Agent which should be used for Open Component Monitoring and click on “Save”
  • The customer network is now active and can be used for Open Component Monitoring
  • Remark: You can click on the “Edit” button to assign another Simple Diagnostic Agent if necessary.

Create New Metrics

Perform the following steps to create a new Open Component Monitoring metric:

  • Click the “Configuration” button in the top right corner of the Open Component Monitoring application
  • Open the area “Metrics”
  • Click the “Edit” button next to the metric type (e.g. “URL Availability”)
  • The table shows all existing metrics. Click on “Add Metric” to define a new metric.
  • Maintain the metric and alert attributes (see table below for common parameter descriptions)
  • Click "Save"
  • Your metric is now active and will become visible in the Open Component Monitoring application.

Here is a list of the common metric parameters to be used in Open Component Monitoring. There are additional metric specific parameters which are described in the respective chapters below.

Field Description
Metric Name Maintain a descriptive name for the metric
Customer Network Select the customer network
Collection Interval Defines how often the metric is collected
Threshold Define the metric threshold.
Metric Documentation Here you can provide additional documentation of the metric.
Alert Active Trigger an alert when the metric fails
Alert Name Maintain the name of the alert
Severity Severity of the alert in AEM. Maintain a value between 0 (very low) and 9 (very high)
Notification (optional) Select a notification variant if you want to send an additional email for the alert
Outbound Connector (optional) Select an outbound connector variant if you want to forward the alert via BAdI implementation

URL Availability

This metric will measure the availability of a URL. The URL is called from the central Simple Diagnostic Agent of the customer network. The URL Availability is checked every minute.

URL Availability metrics have the following additional parameters:

Field Description
URL

Maintain the URL

Proxy URL (optional) 

Maintain the additional proxy URL if the URL is outside your customer network. 

URL Certificates

Measure 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 from a central Simple Diagnostic Agent in the customer network.

URL Certificate metrics have the following additional parameters:

Field Description
URL

Maintain the URL

Proxy URL (optional) 

Maintain the additional proxy URL if the URL is outside your customer network. 

Host Availability

Measure the availability of a host. The central Simple Diagnostic Agent of the custom performs an ICMP ping to the configured host name or IP address.

Host Availability metrics have the following additional parameters:

Field Description
Hostname Maintain the host name or IP address

TCP Port Availability

Measure the availability of a TCP port. The central Simple Diagnostic Agent of the custom 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 Maintain the host name (or IP address) and the port number. This needs to be maintained in the format <hostname>:<port>

RFC Availability Metric of Subtype ‘Application Server'

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

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

Field Description

Metric Name

Name of Metric
Application Server Application Server of a SAP System
Instance Number Application Server Instance of a SAP System
System ID ID of SAP System
SAP Router String SAP Router String (optional)

RFC Availability Metric of Subtype ‘Logon Group'

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

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

Field Description

Metric Name

Name of Metric
Message Server Message Server of a SAP System
Message Server Port Port of a Message Server of a SAP System
System ID ID of SAP System
Logon Group Logon Group of Servers belonging to SAP System (optional)
SAP Router String SAP Router String (optional)

Windows Service

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

Windows Service metrics have the following additional parameters:

Field Description
Service Name Maintain the name of the Windows Service you want to monitor.
Host Name The name of the host where the Windows Service should be monitored. You can select from a list of all Windows hosts in the customer network

OS Process

Measure if a OS Process is running on a host. This is measured by the local Simple Diagnostic 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. Leave this field empty to monitor processes from all users. This parameter needs to be maintained as a regular expression.
Command Line Full command line of the process. This also contain the command line parameters of the process. This parameter needs to be maintained as a regular expression.
Host Name The name of the host where the Windows Service should be monitored. You can select from a list of all Windows hosts in the customer network

OS Scripts

Measures the execution of a customer specific operating system script on a host. Measurement is done by the local Simple Diagnostic Agent of the host.

This 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
Metric Unit Unit of Metric (optional)

Script Name

 
Name of operating system script
Parameters  Input Parameters for operating system script in the format ‘parametername:parametervalue' e. g. DBNAME:H10,DBTYPE:hdb

Logfile Monitor

Measures if one or several log files on a host contain a search term. Measurement is done by the local Simple Diagnostic Agent of the host.

Logfile Monitor metrics have the following parameters:

Field Description

Metric Name

Name of Metric
Folder Folder which contains the log file(s)
File Pattern Regular Expression to specify the log files to be searched
Search Pattern Regular Expression which specifies the search term

Delta Read

‘X': Search only the records of the log file which have been added since the last search
‘ ‘: Search through the entire log file
File Encoding  File encoding of log file e. g. UTF-8, UTF-16

HTTP Availability

Like Metric ‘URL Availability' this Metric measures the availability of an URL. The URL is called from a Data Collector running on Simple Diagnostic Agent (SDA) in the customer network.

When you create a HTTP Availability Metric containing user credentials (e. g. user) it is recommended to use a Technical User instead of a normal User in order to avoid a conflict with General Data Protection Regulation (GDPR).

Compared to Metric ‘URL Availability' the ‘HTTP Availability' Metric contains the following additional parameters:

Field Description
Proxy

Defines whether a Proxy should be used by the Data Collector when calling the URL specified in the Metric.

  1. Auto: Use the operating system settings to identify if a Proxy should be used 
  2. None: No Proxy should be used (e.g. if automatic detection doesn't work) 
  3. Proxy URL: Set an explicit Proxy URL
Authentication

Specifies the type of authentication which is used when the URL specified in the Metric is called by the Data Collector.

  1. None: Do not use authentication
  2. Basic: Use Basic Authentication (User/Password)
  3. OAuth : OAuth Framework is used for authentication

Remark:

When you create a ‘HTTP Availability' Metric containing user credentials it is recommended to use a Technical User instead of a normal User in order to avoid a conflict with General Data Protection Regulation (GDPR).

Content Match This parameter can be switched on or off. When it is switched on you have to specify a Regular Expression.
When the Data Collector calls an URL a 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. In case it is true the section of the response body which matches the Regular Expression is returned by the Data Collector.
User Agent This is a User Agent String which is transferred in the HTTP request when the Data Collector calls the URL. User Agent is used by the Data Collector to mimic a web browser when calling the URL specified in the Metric.
Send Post Request This parameter can be switched on or off. When it is switched on the Data Collector performs a HTTP Post request when calling the URL specified in the Metric instead of a HTTP Get request. Furthermore you have to 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 which is sent in the HTTP Post request.
Timeout Specifies a period of time in milliseconds (ms). When the Data Collector calls the URL specified in the Metric it expects a response within that period. If a response is received within the period the call of the URL was successful.
Number of Retries Specifies how often an URL is called by the Data Collector until a response is received by the Data Collector. When Number of Retries is exceeded the call of the URL was not successful.

Configuration (FRUN 1)

Activate Customer Network

Many Open Component Monitoring metrics are unmodeled, which means that they are not assigned to a specific technical system in the landscape. Nevertheless, they need to be executed by a Simple Diagnostic Agent, which needs to be located inside the customer network. Therefore, it is necessary as a first step to define a central Simple Diagnostic Agent in the customer network which should execute the Open Component Monitoring metrics.

Proceed as follow to activate a customer network

  • Select the application “Open Component Monitoring – Configuration” from the Launchpad (Transaction: FRUN)
  • Click “Customer Network Monitoring”
  • Select the tab “Agent Assignment”
  • Select a customer network in the table and click “Assign”
  • You can now search and display the Simple Diagnostic Agents in the customer network
  • Select the Simple Diagnostic Agent which should be used for Open Component Monitoring
  • Click on “Save”

URL Availability

This metric will measure the availability of a URL. The URL is called from the central Simple Diagnostic Agent of the customer network. The URL Availability is checked every minute.

How to create a URL Availability metric

  • Select the application “Open Component Monitoring – Configuration” from the Launchpad (Transaction: FRUN)
  • Click “Customer Network Monitoring”
  • Select the tab “Metric Configuration”
  • Click on “Add” … “URL Availability”
  • Maintain the metric and alert attributes:

Field Description
Managed Object Name Select the customer network
URL Maintain the URL 
Proxy URL  (optional) Maintain the additional proxy URL if the URL is outside your customer network. This field is only available as of FRUN 1.0 FP3.
Threshold Define the metric threshold. The recommended threshold for URL Availability metrics is "Already Rated (Best of last 3)"
Alert Active Trigger an alert when the metric fails
Alert Name Maintain the name of the alert
Severity Severity of the alert in AEM. Maintain a value between 0 (very low) and 9 (very high)
Notification (optional) Select a notification variant if you want to send an additional email for the alert
Outbound Connector (optional) Select an outbound connector variant if you want to forward the alert via BAdI implementation

  • Confirm your settings by clicking "OK" 
  • Click "Save"

Your metric is now active and will become visible in the Open Component Monitoring application.

URL Certificates

Measure 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 from a central Simple Diagnostic Agent in the customer network.

How to Create a URL Certificate Metric

  • Select the application “Open Component Monitoring – Configuration” from the Launchpad (Transaction: FRUN)
  • Click “Customer Network Monitoring”
  • Select the tab “Metric Configuration”
  • Click on “Add” … “Https Certificate Expiration”
  • Maintain the metric and alert attributes:

Field Description
Managed Object Name Select the customer network
URL Maintain the URL 
Proxy URL  (optional) Maintain the additional proxy URL if the URL is outside your customer network. This field is only available as of FRUN 1.0 FP3.
Threshold Define the metric threshold.
Alert Active Trigger an alert when the metric fails
Alert Name Maintain the name of the alert
Severity Severity of the alert in AEM. Maintain a value between 0 (very low) and 9 (very high)
Notification (optional) Select a notification variant if you want to send an additional email for the alert
Outbound Connector (optional) Select an outbound connector variant if you want to forward the alert via BAdI implementation

  • Confirm your settings by clicking "OK" 
  • Click "Save"

Your metric is now active and will become visible in the Open Component Monitoring application.

Host Availability

Measure the availability of a host. The central Simple Diagnostic Agent of the custom performs an ICMP ping to the configured host name or IP address.

How to Create a Host Availability Metric

  • Select the application “Open Component Monitoring – Configuration” from the Launchpad (Transaction: FRUN)
  • Click “Customer Network Monitoring”
  • Select the tab “Metric Configuration”
  • Click on “Add” … “Host Availability”
  • Maintain the metric and alert attributes:

Field Description
Managed Object Name Select the customer network
Hostname Maintain the host name or IP address
Threshold Define the metric threshold.
Alert Active Trigger an alert when the metric fails
Alert Name Maintain the name of the alert
Severity Severity of the alert in AEM. Maintain a value between 0 (very low) and 9 (very high)
Notification (optional) Select a notification variant if you want to send an additional email for the alert
Outbound Connector (optional) Select an outbound connector variant if you want to forward the alert via BAdI implementation

  • Confirm your settings by clicking "OK" 
  • Click "Save"

Your metric is now active and will become visible in the Open Component Monitoring application.

TCP Port Availability 

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

How to Create a TCP Port Availability Metric

  • Select the application “Open Component Monitoring – Configuration” from the Launchpad (Transaction: FRUN)
  • Click “Customer Network Monitoring”
  • Select the tab “Metric Configuration”
  • Click on “Add” … “TCP Port Availability”
  • Maintain the metric and alert attributes:

Field Description
Managed Object Name Select the customer network
Hostname Maintain the host name (or IP address) and the port number. This needs to be maintained in the format <hostname>:<port>
Threshold Define the metric threshold.
Alert Active Trigger an alert when the metric fails
Alert Name Maintain the name of the alert
Severity Severity of the alert in AEM. Maintain a value between 0 (very low) and 9 (very high)
Notification (optional) Select a notification variant if you want to send an additional email for the alert
Outbound Connector (optional) Select an outbound connector variant if you want to forward the alert via BAdI implementation

  • Confirm your settings by clicking "OK" 
  • Click "Save"

Your metric is now active and will become visible in the Open Component Monitoring application.

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 Service 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 Service 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