In general three different templates to monitor Web Services exist: Web Service ABAP (SOAP), Web Service ABAP (STAD), and Web Service (Introscope).
The technical prerequisites depend on which of the monitoring templates you want to use.
Template | Technical Prerequisites | |
---|---|---|
Web Service ABAP (STAD) | The following technical prerequisites have to be met in order to use this template:
| |
Web Service ABAP (SOAP) | The following technical prerequisites have to be met in order to use this template:
Please follow the description in step "Preparation" activity "Activate Web Service Monitoring" to activate Web Service monitoring capabilities in the managed system. | |
Web Service (Introscope) | The following technical prerequisites have to be met in order to use this template:
|
This template provides metrics to monitor the response time, the number of executions and whether exceptions of synchronous web services occurred in the managed ABAP system. The data is collected via the enterprise extension /SDF/WS_MON which has to be activated in the Switch Framework.
Metric Name | Description | MAI Category | Since SP |
---|---|---|---|
Average WS Response Time |
Average WS Response Time in ms |
Performance |
7.1 SP 05 |
Average WS Response Time per Instance |
Average WS Response Time per Instance in ms |
Performance |
7.1 SP 08 |
Number of AppLog Errors (WS) |
Exceptions from Application log (SLG1) |
Exceptions |
7.1 SP 05 |
Number of Web Service Exceptions |
Exceptions from SRT_LOG |
Exceptions |
7.1 SP 05 |
Number of WS executions |
Number of WS executions |
Performance |
7.1 SP 05 |
Number of WS executions below threshold |
Number of executions below a defined threshold |
Performance |
7.1 SP 12 |
Number of WS executions per Instance |
Number of WS executions per Instance |
Performance |
7.1 SP 08 |
Percentage of WS executions below threshold |
Percentage of executions below a defined threshold |
Performance |
7.1 SP 12 |
WS Channel available |
Availability measured by a script |
Availability |
7.1 SP 05 |
Supported Web Service Types
This monitoring template only supports synchronous Web Services. Only web service calls using the SOAP runtime can be measured. PI web services are not instrumented with this template.
You can check in statistics records which protocol is used. Call transaction STAD after the webservice was executed. Select the correct time interval and task type 9. Select OK. Double-click on the right entry to display the single statistical record details. Press button Web Service and check the Web Service Records .
Currently only the WS protocol is supported.
PI Protocol is not supported by this template.
This template provides metrics to monitor the response time, the number of executions and whether exceptions of web services occurred in the managed ABAP system. The data collector can extract web service performance information from STAD in the ABAP managed system. No additional business function needs to be activated for this functionality. Also this supports SOAP as well as PI web service calls.
Metric Name | Description | MAI Category | Since SP |
---|---|---|---|
Average WS Response Time (STAD) |
Average WS Response Time in ms |
Performance |
7.2 SP 05 |
Number of AppLog Errors (WS) |
Exceptions from Application log (SLG1) |
Exceptions |
7.2 SP 05 |
Number of Web Service Exceptions |
Exceptions from SRT_LOG |
Exceptions |
7.2 SP 05 |
Number of WS executions (STAD) |
Number of WS executions |
Performance |
7.2 SP 05 |
WS Channel available |
Availability measured by a script |
Availability |
7.2 SP 05 |
This template provides metrics to monitor the response time, the number of executions and whether exceptions of synchronous web services occurred in the managed NON-ABAP system.
Metric Name | Description | MAI Category | Since SP |
---|---|---|---|
Average WS Response Time (Introscope) |
Average Response Time (ms) |
Performance |
7.1 SP 06 |
Number of Web Service Exceptions (Introscope) |
Number of SOAP Faults Per Interval |
Exceptions |
7.1 SP 06 |
Number of WS executions (Introscope) |
Responses Per Interval |
Performance |
7.1 SP 06 |
WS Channel available | Availability measured by a script | Availability | 7.1 SP 05 |
Restrictions
The Interface and Connection Monitoring setup can be accessed via SAP Solution Manager Configuration (SOLMAN_SETUP).
To access the Integration Monitoring setup please go to SAP Solution Manager Configuration (SOLMAN_SETUP) → Application Operations → Integration Monitoring → Interface and Connections.
If you didn't perform the infrastructure configuration yet, please follow the Interface and Connection Monitoring Setup with SAP Solution Manager 7.2.
Navigate to the step 'Define Scope'. You can create a new scenario or use an existing one. Make sure the sender and the receiver system are part of the Interface and Connection Monitoring scenario.
Create the Interface Channel:
Maintain the Interface:
Leaving a parameter empty will result in an aggregation over this parameter. You also have the possibility to use wildcards, which will result in single metrics reported for each match during data collection.
Select Metrics:
On the tab 'Metrics' select the metrics you want to monitor. Please note that the selected metrics are collected for each WS destination entered above.
Enter Metric Parameters:
Metric: WS Channel available
Parameter set name: You can enter a name for the parameter set to distinguish it if you have more than one
Script Name (mandatory): Select the name of the UXMon script used to monitor the WS availability from the drop-down list. For information how to record the UXMon script please refer to the wiki page ICMon Availability Script.
Performance Warning
Because of potentially high data volume instance specific data collection is turned off by default.
You can maintain attributes as described in the Interface and Connection Monitoring Setup on the tab 'Attributes'.
Thresholds and the collection schedule are maintained in the next step of the guided procedure. Once you have maintained all your channels, click 'Next' in the main guided procedure to move to the step 'Activation'.
Maintain Thresholds and Schedule:
Navigate to the step 'Define Scope'. You can create a new scenario or use an existing one. Make sure the sender and the receiver system are part of the Interface and Connection Monitoring scenario.
Create the Interface Channel:
Maintain the Interface:
Leaving a parameter empty will result in an aggregation over this parameter. You also have the possibility to use wildcards, which will result in single metrics reported for each match during data collection.
The data source for the metric "Number of Web Service Exceptions" is the web service error log (transaction SRT_LOG). When you activate this metric, Solution Manager automatically creates customizing in Exception Management to capture the web service errors from this log. The customizing uses a filter on the column "Interface Name" in the error log. The value for this filter is the value you entered in the field "WS name" or "WS proxy".
The input help for the field "WS name" or "WS proxy" will return the internal name as known in transaction SOAMANAGER.
Unfortunately for asynchronous web services, this is not the value that is used for the column "Interface" in the web service error log. Instead the error log uses the ABAP name in this column. However the internal name is used to identify the web service in STAD to measure the number of web service executions and the web service performance. Hence, for asynchronous web services we have to distinguish between the filter values used for the collection of performance metrics and the filter values used to collect exceptions.
As a workaround you can create two line items (two interfaces) for each asynchronous web service in your web service channel.
You can use the same "Interface Name" for both interfaces.
To find out the ABAP name of an asynchronous web service use transaction SPROXY.
Select Metrics:
On the tab 'Metrics' select the metrics you want to monitor. Please note that the selected metrics are collected for each WS destination entered above.
Enter Metric Parameters:
Metric: WS Channel available
Parameter set name: You can enter a name for the parameter set to distinguish it if you have more than one
Script Name (mandatory): Select the name of the UXMon script used to monitor the WS availability from the drop-down list. For information how to record the UXMon script please refer to the wiki page ICMon Availability Script.
You can maintain attributes as described in the Interface and Connection Monitoring Setup on the tab 'Attributes'.
Thresholds and the collection schedule are maintained in the next step of the guided procedure. Once you have maintained all your channels, click 'Next' in the main guided procedure to move to the step 'Activation'.
Maintain Thresholds and Schedule:
Navigate to the step 'Define Scope'. You can create a new scenario or use an existing one. Make sure the sender and the receiver system are part of the Interface and Connection Monitoring scenario.
Create the Interface Channel:
Maintain the Interface:
Leaving a parameter empty will result in an aggregation over this parameter. You also have the possibility to use regular expressions, which will result in single metrics reported for each match during data collection.
Select Metrics:
On the tab 'Metrics' select the metrics you want to monitor. Please note that the selected metrics are collected for each WS destination entered above.
Enter Metric Parameters:
Metric: WS Channel available
Parameter set name: You can enter a name for the parameter set to distinguish it if you have more than one
Script Name (mandatory): Select the name of the UXMon script used to monitor the WS availability from the drop-down list. For information how to record the UXMon script please refer to the wiki page ICMon Availability Script.
You can maintain attributes as described in the Interface and Connection Monitoring Setup on the tab 'Attributes'.
Thresholds and the collection schedule are maintained in the next step of the guided procedure. Once you have maintained all your channels, click 'Next' in the main guided procedure to move to the step 'Activation'.
Maintain Thresholds and Schedule: