Web Service Channel

In general three different templates to monitor Web Services exist: Web Service ABAP (SOAP), Web Service ABAP (STAD), and Web Service (Introscope).

Techncial Prerequisites

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:

  • SAP Solution Manager 7.2 SP 05
  • SAP Basis release ≥ 7.02 on managed systems
  • ST-PI 2008_1_700 ≥ SP15 or ST-PI 2008_1_740 ≥ SP05
 
Web Service ABAP (SOAP)

The following technical prerequisites have to be met in order to use this template:

  • Basis release ≥ 7.0 on all managed systems
  • Switch enabled as described in note 1639329

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:

  • SAP J2EE system or Apache Tomcat
  • Managed System Setup has been executed for this system
  • Metrics are aggregated in Introscope Enterprise Manager to system level (agentcluster.xml) 
 

Available Monitoring Content

Please, select...

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_UTIL

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_UTIL

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

  • Only outgoing web service calls can be measured.
  • Metrics are always retrieved from the Introscope Enterprise Manager for the source system.

Configuration

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.

Please, select...

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:

  1. Select the scenario and click 'Next'
  2. In step 'Preparation' perform all relevant manual activities and run all automatic activities.
  3. In step 'Configuration' click the 'Add' button.
    • Channel Name: Enter a meaning full name (max. 30 characters)
    • Type: Select 'Web Service'
    • Monitoring Template: Select 'Web Service ABAP (SOAP)'
    • Description: Enter a description for the channel
  4. Click Next.
  5. Source type:
    • Select 'Technical System'
    • If the source system is not on-premise please select 'External Service' if it is a cloud service or 'Unspecified Managed Object'.
  6. Source: Select the source system from the drop-down list or enter the name for the unspecified managed object
  7. Target Type:
    • Select 'Technical System'
    • If the target system is not on-premise please select 'External Service' if it is a cloud service or 'Unspecified Managed Object'.
  8. Target: Select the target system from the drop-down list or enter the name for the unspecified managed object
  9. The measuring point is selected automatically. Please note that for this template either the target or the source system must be an ABAP system! If both source and target are ABAP systems you can select the measuring point as necessary.
  10. If more than one client are connected for the on premise system please select the correct client for the monitoring
  11. Click Next.
  12. Click Finish.

Maintain the Interface:

  1. Select the interface channel you created
  2. On the 'Interfaces' tab click the 'Add' button.
  3. Provide the following information
    • Interface Name: The name of the interface
    • WS name / WS proxy: internal Web Service name. You can use the input help to select a web service and the method. In case the internal name is unknown, wildcards can be used for initial identification.
    • WS method: Web service method
    • WS user (on Server side): Web Service user
    • Logical Port (on Client side): Web Service logical port

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:

  1. 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.

  2. 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): Enter the name of the UXMon script used to monitor the WS availability.

    • Metric: Number of AppLog Errors (WS)
      • Parameter set name: You can enter a name for the parameter set to distinguish it if you have more than one
      • Technical System (mandatory): The technical system in which the application log is written
      • Object name (mandatory): The object name for the application log entry
      • Sub-object name (mandatory): The sub-object for the application log entry
      • User name: Name of the user who caused the logged event
      • External ID (Expert field): External ID for the application log entry
      • Message ID (Expert field): Message ID for the application log entry
      • Message no. (Expert field): Message number for the application log entry
      • Message text (Expert field): Message text for the application log entry
      • Program (Expert field): Name of the program which caused the logged event
      • Transaction code (Expert field): Name of the transaction which caused the logged event
    • Metric: Executions below threshold
      • Parameter set name: You can enter a name for the parameter set to distinguish it if you have more than one
      • Threshold: Maintain the threshold for the Web Service execution in milliseconds

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:

  1. Select the Alert for the channel (the alert is the line with the red flash icon next to it)
    • On alert level you can maintain notification and incident message creation
  2. Select the Metrics
    • You can adjust the thresholds on the tab Thresholds.
    • Do not change the data collector type or data collector name on the tab 'Data Collection' as the monitor will not work anymore if this is changed.
    • Only change the collection interval if you know what you do or if advised to do this by SAP.
  3. Click 'Apply and Activate' → <Choose one option> to activate the monitoring

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:

  1. Select the scenario and click 'Next'
  2. In step 'Preparation' perform all relevant manual activities and run all automatic activities.
  3. In step 'Configuration' click the 'Add' button.
    • Channel Name: Enter a meaning full name (max. 30 characters)
    • Type: Select 'Web Service'
    • Monitoring Template: Select 'Web Service ABAP (STAD)'
    • Description: Enter a description for the channel
  4. Click Next.
  5. Source type:
    • Select 'Technical System'
    • If the source system is not on-premise please select 'External Service' if it is a cloud service or 'Unspecified Managed Object'.
  6. Source: Select the source system from the drop-down list or enter the name for the unspecified managed object
  7. Target Type:
    • Select 'Technical System'
    • If the target system is not on-premise please select 'External Service' if it is a cloud service or 'Unspecified Managed Object'.
  8. Target: Select the target system from the drop-down list or enter the name for the unspecified managed object
  9. The measuring point is selected automatically. Please note that for this template either the target or the source system must be an ABAP system! If both source and target are ABAP systems you can select the measuring point as necessary.
  10. If more than one client are connected for the on premise system please select the correct client for the monitoring
  11. Click Next.
  12. Click Finish.

Maintain the Interface:

  1. Select the interface channel you created
  2. On the 'Interfaces' tab click the 'Add' button.
  3. Provide the following information
    • Interface Name: The name of the interface
    • WS name / WS proxy: internal Web Service name. You can use the input help to select a web service and the method. In case the internal name is unknown, wildcards can be used for initial identification.
    • WS method: Web service method
    • WS user (on Server side): Web Service user
    • Logical Port (on Client side): Web Service logical port

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:

  1. 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.

  2. 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): Enter the name of the UXMon script used to monitor the WS availability. To learn how to record the UXMon script please refer to the wiki page ICMon Availability Script.

    • Metric: Number of AppLog Errors (WS)
      • Parameter set name: You can enter a name for the parameter set to distinguish it if you have more than one
      • Technical System (mandatory): The technical system in which the application log is written
      • Object name (mandatory): The object name for the application log entry
      • Sub-object name (mandatory): The sub-object for the application log entry
      • User name: Name of the user who caused the logged event
      • External ID (Expert field): External ID for the application log entry
      • Message ID (Expert field): Message ID for the application log entry
      • Message no. (Expert field): Message number for the application log entry
      • Message text (Expert field): Message text for the application log entry
      • Program (Expert field): Name of the program which caused the logged event
      • Transaction code (Expert field): Name of the transaction which caused the logged event

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:

  1. Select the Alert for the channel (the alert is the line with the red flash icon next to it)
    • On alert level you can maintain notification and incident message creation
  2. Select the Metrics
    • You can adjust the thresholds on the tab Thresholds.
    • Do not change the data collector type or data collector name on the tab 'Data Collection' as the monitor will not work anymore if this is changed.
    • Only change the collection interval if you know what you do or if advised to do this by SAP.
  3. Click 'Apply and Activate' → <Choose one option> to activate the monitoring

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:

  1. Select the scenario and click 'Next'
  2. In step 'Preparation' perform all relevant manual activities and run all automatic activities.
  3. In step 'Configuration' click the 'Add' button.
    • Channel Name: Enter a meaning full name (max. 30 characters)
    • Type: Select 'Web Service'
    • Monitoring Template: Select 'Web Service (Introscope)'
    • Description: Enter a description for the channel
  4. Click Next.
  5. Source type:
    • Select 'Technical System'
  6. Source: Select the source system from the drop-down list. The source system for this channel type can only be a JAVA system and that the measuring point is always the Java source system. The Java system has to be part of the Scope (Technical Scenario) for which the setup is running.
  7. Target Type:
    • Select 'Technical System'
    • If the target system is not on-premise please select 'External Service' if it is a cloud service or 'Unspecified Managed Object'.
  8. Target: Select the target system from the drop-down list or enter the name for the unspecified managed object
  9. The measuring point is selected automatically.
  10. Click Next.
  11. Click Finish.

Maintain the Interface:

  1. Select the interface channel you created
  2. On the 'Interfaces' tab click the 'Add' button.
  3. Provide the following information
    • Interface Name: The name of the interface
    • WS name: Web Service name.
    • WS method: Web service method

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:

  1. 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.

  2. 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): Enter the name of the UXMon script used to monitor the WS availability. To learn 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:

  1. Select the Alert for the channel (the alert is the line with the red flash icon next to it)
    • On alert level you can maintain notification and incident message creation
  2. Select the Metrics
    • You can adjust the thresholds on the tab Thresholds.
    • Do not change the data collector type or data collector name on the tab 'Data Collection' as the monitor will not work anymore if this is changed.
    • Only change the collection interval if you know what you do or if advised to do this by SAP.
  3. Click 'Apply and Activate' → <Choose one option> to activate the monitoring