Integration & Exception Monitoring - Setup & Configuration

Prerequisites

Before you can set up Integration & Exception Monitoring in SAP Cloud ALM, you have to connect your subscribed SAP cloud services to your SAP Cloud ALM instance. 

This is done by setting up the Landscape Management Service. Please follow the Setting Up Landscape Management guide in SAP Help  on how to perform the setup.

Supported Products

To set up Integration & Exception Monitoring please follow the monitoring setup guide provided in the section "Monitoring Configuration" below.

On the product-specific pages you find additional information for each supported product like setup prerequisites, available monitoring categories, and available filter parameters.

 

Monitoring Configuration

Configure Data Collection and Alerting

The following video describes:

  • How to activate or deactivate the monitoring data collection for a managed cloud service
  • How to create additional alerts for a cloud service
  • How to create notifications for the alert

Attention: The setup of alerts and notification has recently changed. Please follow the written documentation below this video to learn about the new process.

Prerequisites for the video:

  • You need one of the following the SAP Cloud ALM roles
    • Integration Architect
    • Integration Owner
    • Global Administrator
  • Make sure that the cloud service you want to configure is successfully connected to SAP Cloud ALM
  • Note: Some of the features, shown in the video, are not released yet, like for example the possibility to define Exception Monitoring related filters at Business Scenarios or Event level. 

Activate the Monitoring Data Collection

The data collection for all monitoring categories available for a managed system or service can be activated directly in the configuration tray in Integration & Exception Monitoring.

  1. Open the Integration & Exception Monitoring application from the launchpad
  2. Open the scope selection via the bulls-eye icon in the upper right corner
  3. Change the drop-down for "Display Service" to "All"
  4. Select the cloud service you want to set up in the scope
  5. Click "Apply"
  6. Click the rack-wheel icon in the upper right corner to access the configuration
  7. Expand the "Configuration" tray
  8. Change the toggle button next to the cloud service you want to set up from OFF to ON

Customize the Monitoring Data Collection

It is possible to customize the data collection for the managed services and systems by:

  • Activating or deactivating single monitoring categories
  • Adding filters to monitoring categories to collect only a subset of the messages or exceptions
  • Configure the collection of payload data for the categories IDoc and Web Services
  1. In the configuration tray, click on the name of the managed service or system
  2. The "Configuration of Services / Systems" screen opens
  3. In the "Configuration for Services / Systems" screen, click the > button at the end of the line for the service or system you want to change
  4. Use the toggle button in the column Active to turn a monitoring category "ON" or "OFF"
  5. To add filters on the data collection level access the filter configuration click on the > button at the end of the line for the category
    1. Click the "Add" button to create a new filter
    2. Enter a filter name
    3. Select the filter category
    4. Enter the filter parameters
    5. Press "Save"

Create Monitoring Events

Events are used to trigger a reaction if Integration & Exception Monitoring detects a situation that requires attention. These reactions can be an alert, sending a notification and/or triggering an operation flow.

  1. Navigate to the "Events" tab
  2. Use the toggle button in the column Active to turn on of off a predefined event
    1. You can change the setting of a predefined event by clicking on the > button at the end of the line
    2. Press the > button at the end of the line to access the detail setup for an existing event
  3. Use the "Add" button to create a new event
  4. Select the event you want to set up from the "Event Name" drop-down box
  5. Adjust the default "Display Name" to a descriptive name
  6. Expand the Event Actions tray. Trigger the desired action by switching them ON or OFF using the slider button:
    1. You can create an alert that will show up in the applications alert inbox
    2. To send an email, select the recipients from the list of verified recipients by click the '+' button
    3. To start an operations flow, select the relevant operations flow from the list of available flows using the '+' button
  7. Add filters to your event, to restrict the messages you react to.
  8. Expand the Filter Configuration tray
    1. Enter a filter name
    2. Select the filter category
    3. Maintain the available filter fields. Which filter fields are available depends on the managed service and system and the selected category.
  9. Save your changes.

Delete Monitoring Configuration

If necessary it is possible to delete the monitoring configuration for a service or system. The deletion goes further than just a deactivation, as it removes all configuration from the service or system and sets its status back to "Not Configured" for Integration & Exception Monitoring.

  1. In the configuration tray, click on the name of the managed service or system
  2. The "Configuration of Services / System" screen opens
  3. In the "Configuration for Services / System" screen, select the row of the service by clicking on the row selector in the very first column.
  4. Click the button "Remove Configuration" in the upper right corner of the table.
  5. Confirm the pop-up.

Business Services Configuration

A business service in Integration & Exception Monitoring of SAP Cloud ALM allows you to group point-to-point interfaces that belong to a more complex interface scenario. All connections that are part of a business service can then be displayed together in a topology. By adding filters to the connections you can define which messages and exceptions are in scope for a business service and isolate their status information in the monitoring application.

The following video explains the configuration of business services. You can find a step-by-step textual description of the business service setup below.

Prerequisites for the video:

  • You need one of the following the SAP Cloud ALM roles
    • Integration Architect
    • Integration Owner
    • Global Administrator
  • Make sure that the cloud service you want to configure is successfully connected to SAP Cloud ALM
  • Note: Some of the features, shown in the video, are not released yet, like for example the possibility to define Exception Monitoring related filters at Business Scenarios or Event level.

Create Business Service

  1. Click the 'Configuration' button in the Integration & Exception Monitoring UI
  2. Scroll down to the 'Business Services' section
  3. Click the pen icon to open the 'Configuration for Business Services'
  4. Click the Add button
  5. Enter the name and the description for the Business Service

Maintain Business Services Components

At first, you have to add the components to the business service.

  1. Click the Add button on top of the 'Services / Systems' table
  2. Select the services from the list by checking the checkbox in front of them
  3. Click the OK button
For each of the services in the business service, you can maintain filters and alerts. The filters make sure that only certain messages and exceptions are considered as part of the business service, even if the monitoring was activated for all of them.
  1. Select the service for which you want to add the filter
  2. Click the Add button on top of the 'Filter for Data' table
  3. Select an available Category 
  4. Enter a name for the filter and maintain the filter values
    • The available Categories depend on the selected service
    • The filter fields depend on the selected category
    • For more information on the meaning of the different filter fields please refer to the setup information for the respective service type
  5. Activate or deactivate alerts
    1. Select the alert in the table 'Event Details for Filter' below the 'Filter for data' table
    2. Click the Edit button
    3. You can change the Display name and the alert description
    4. Use the 'Status' slider to activate or deactivate an alert

Maintain Paths

You can also maintain paths between the components to visualize a message flow.

  1. On the tab 'Paths' you find a matrix with all the components in the business service
  2. Select the row that stands for the desired source
  3. Check the checkbox in the column that stands for the desired target

Housekeeping

Single Messages

As a customer, you can manage the retention time of single messages and exceptions as follows:

Retention Time (days) for single messages and exceptions: Defines the time period for which data is retained for single messages and exceptions. Once the retention time has passed, the single messages will be deleted and the messages will be aggregated.

Enter a value between 1 and 14(days).

Note: Select the option “Retain messages until all correlated messages are deleted”, in case you don't want the messages to be deleted until all the correlated messages are eligible for deletion.


Aggregated Messages

Retention Time (Months) for Aggregated Messages: Defines the time period for which data is retained in the aggregated data history. Once the retention time for aggregated messages has passed, the data is deleted.

Enter a value between 1 and 120(Months).

The specified retention times are valid for all monitored systems and services.