ABAP Web Services
Web Services are a standardized way of communication between a client application which consumes e.g. information from a server application in service-oriented architectures. SAP NetWeaver Application Server ABAP can be used both as a provider and a consumer of Web services. You can create, configure, publish, and consume services.
The communication using web services needs to be monitored for errors and performance issues to ensure a smooth information flow.
Technical Prerequisites
Performance measurements are based on Real-User Monitoring (RUM) which is also a part of SAP Focused Run. When Web Service performance monitoring is set up, RUM is automatically configured in the background.
Advanced Integration Monitoring Setup
To be able to monitor interfaces of an on-premise system you first have to add it to Interface & Cloud Monitoring and select the monitoring categories you want to monitor for the system.
- Open the Advanced Integration Monitoring Application by clicking on the 'Integration & Cloud Monitoring' tile in transaction FRUN
- Click on the pinwheel in the upper right corner of the 'Integration & Cloud Monitoring' application
- In the configuration panel expand the 'Technical Systems' tray and click on the pen icon in the upper right corner. This will open the 'Integration and Cloud Monitoring - Systems' view.
- If your system is not on the list yet, click the 'Add' button to add it. If it is on the list, click on the system ID of the system.
In the next step, you see all monitoring categories which are available for the system, depending on the system type and the installed software components. Some recommended standard monitoring categories are preselected.
Select the monitoring categories in scope.
Available Monitoring Categories
For Web Service Monitoring, different monitoring categories are available:
- Web Service (Performance): Can be collected for SAP Java systems or for SAP ABAP systems
- Web Service Messages (ABAP): Web Service messages collected from SRT_UTIL → Message Monitor. Can be collected for ABAP systems.
- ABAP Web Service Consumer: Web service exceptions collected from the SRT_UTIL → Error Log. Can be collected for ABAP systems.
- ABAP Web Service Provider: Web service exceptions collected from the SRT_UTIL → Error Log. Can be collected for ABAP systems
For the category 'Web Service Messages (ABAP)' you can collect payload information from the web service message and display this payload in the AIM application in SAP Focused Run. You can then use this information to search for related messages in PI or CPI, related IDocs, or related web service calls. Find out how to set up the collection of payload information here.
After selecting your monitoring categories you have to maintain filters to define what exactly you want to monitor. Some monitoring categories come with standard filters that usually just select all items of this monitoring category. SAP Focused Run can handle this high amount of monitoring data, so you can stick to this standard filters. Or you can set up filters of your own. You can create more than one filter for a monitoring category.
Available Filter Options
For all monitoring categories, you can opt to use the default filter, that collects all web service communication. You can also use the following filters to restrict the web service communication:
Web Service Messages (ABAP)
- Processing Status Group: The status group of the message. Please use the input help to select a status group
- Adapter Type: The adapter used for the WS. Please use the input help to select an adapter.
- Sender Party: Sender Communication party
- Sender Interface Name: Sender Interface
- Receiver Party: Receiver Communication party
- Receiver Interface Name: Receiver Interface
- User Name: Login name of the user.
- Payload Field Name: User Defined Selection search field
Web Service (Performance)
- Web Service Name: The name of the web service called
- Method: The called web service method
ABAP Web Service Consumer
- Host: Application Server as in the Error Log
- Message: Short Text in the Error Log
- Proxy Name: Interface Name in the Error Log
- User: User in the Error Log
ABAP Web Service Provider
- Host: Application Server as in the Error Log
- Message: Short Text in the Error Log
- WS Name (Proxy): Interface Name in the Error Log
- User: User in the Error Log
The setup of the filters for the monitoring categories only makes sure that the data is collected, however, alerts are not created automatically. To create alerts and notifications you have to create an alert individually. If you didn't use specific filters in the setup before, but rather opted to collect all data, you have to create filters for the alerts.
- Click on the 'New Alert' button in the upper right corner of the alerts table. A new panel will appear below the table for you to enter the alert information
- Select the monitoring category
- Select the metric name. The available metrics depend on the monitoring category.
- Enter a name for the alert
- Enter a name for the filter
In the next sub-step, you have to maintain the filter. The filter values are the same as described above. For some metrics, you have to maintain metric parameters. Find details below in the overview of the available metrics.
In the last sub-step you have to activate the alert:
- Check the checkbox next to 'Active'
- You can adjust the calculation frequency and the severity
- Available threshold types depend on the metric selected. If the threshold type allows it you can adjust the threshold value which triggers the alert.
- Select the notification variant and the outbound connector variant from the drop-down list.
For single exceptions, the threshold type is always 'Already Rated'. This means depending on the calculation frequency the number of exceptions is checked and an alert is created if this number is bigger than 0. If you want to reduce the number of alert for these metrics, you could increase the value for the calculation frequency to increase the time between checks.
Available Metrics
The following metrics are collected for the different Web service categories:
Web Service Messages (ABAP)
- Number of Web Service messages: The metric specifies the number of Web Service messages within the collection interval.
- Average Web Service response time [ms]: The metric specifies the average runtime of successful Web Service messages in milliseconds within the collection interval.
- Number of erroneous Web Service messages: The metric specifies the number of erroneous Web Service messages within the collection interval.
Web Service (Performance)
- Web Service Response Time: The average response time of the Web Service requests as collected by RUM
ABAP Web Service Consumer
- ABAP Web Service Consumer exceptions: Indicates that ABAP Web Service Consumer exceptions were collected during the last collection period
ABAP Web Service Provider
- ABAP Web Service Provider exceptions: Indicates that ABAP Web Service Provider exceptions were collected during the last collection period