Skip to end of metadata
Go to start of metadata

Content

Introduction

SAP Solution Manager 7.1 supports IBM WebShpere products with End-to-End Root Cause Analysis and System Monitoring. Following IBM WebSphere products are supported.

SAP Solution Manager  IBM WebSphere
Solution Manager 7.1 SP1

IBM WebSphere Application Server 6.0/6.1

Solution Manager 7.1 SP6IBM WebSphere Application Server 7.0
Solution Manager 7.1 SP8IBM WebSphere Application Server 8.0

If the diagnostics templates for a particular IBM WebSphere Application Server product version is missing in the SAP Solution Manager system, please download and import the template from following SAP notes:

  • SP07: 1783886
  • SP08: 1811700
  • SP09: 1882778
  • SP10: 1940337
  • SP11: 1989380

Note : The WebSphere Application Server 6.0 templates are delivered incorrect in the following Solution Manager SPs: SP8, SP9 and SP10. Please download and import the template from the corresponding SAP note above.

 

For more details please also refer to the following SAP notes:

  • SAP note 1482727 "SAP SLD Data Supplier for IBM WebSphere Application Server
  • SAP note 1438005 “Wily Introscope Agent for IBM WebSphere server”
  • SAP note 1651892 "SAP Solution Manager 7.1 E2E RCA Setup for IBM WebSphere"

Overview E2E RCA setup for IBM WebSphere Server

End-to-End Root Cause Analysis in SAP Solution Manager 7.1 is based on different components listed below.

  • SAP Host Agent
  • Solution Manager Diagnostics Agent
  • SAP Solution Landscape Directory (SLD)
  • SLD Data Supplier for IBM WebSphere
  • Landscape Management (LMDB)
  • Wily Introscope Enterprise Manager
  • Wily Introscope Java Agent

The figure below depicts the key components in the Solution Manager landscape. http://wiki.sdn.sap.com/download/attachments/250776381/image001.png

The following table lists the steps necessary to set up E2E Root Cause Analysis for an IBM WebSphere Application Server system.

Setup Step

To be performed on

Remarks

Step1: Install SAP Host Agent

Managed system (host)

Once per WebSphere host

Step2:  Install SMD Agent

Managed system (host)

Once per WebSphere host

Step3:  Install Introscope Java Agent* *

Managed system (WebSphere)

Once per WebSphere server

Step4:  Configure WebSphere Server* *

Managed system (WebSphere)

Once per WebSphere server

Step5:  Install SLD Data Supplier

Managed system (WebSphere)

Once per WebSphere server

Step6:  Run Managed System Setup

SAP Solution Manager

Once per WebSphere system

Step7: Manual Managed System Setup Steps

SAP Solution Manager

Once per WebSphere system

 

1. Install SAP Host Agent

With the current Diagnostics Agent installers the SAP Host Agent is installed automatically. Refer to the next section.

2. Install SMD Agent

Please refer to SAP Note 1365123- Installation of Diagnostics Agents, and to SAP Note 1833501 - Diagnostics Agent Installer Versions.

3. Install Introscope Java Agent

Please refer to SAP note 1418638 “Wily Introscope Agent for IBM WebSphere server” for details.

4. Install and run SLD Data Supplier

SAP Solution Manager depends on the technical system definition in the Landscape Management (LMDB). The SLD-DS documentation describes how to install and run the SLD-DS for IBM WebSphere Application Server. Please refer to SAP note 1482727 "SAP SLD Data Supplier for IBM WebSphere Application Server" for details.
Please consult Solution Manager Documentation for general topics like for the steps needed to create or maintain your technical systems inside the Landscape Management of SAP Solution Manager.
Note:

Consider to assign an appropriate System ID to the WebSphere system describing your Tomcat server in a meaningful way. Use the SYSTEM_ID configuration property of the SLD-DS for that.  For example,
                SYSTEM_ID = WS61MFR
Otherwise the System ID identifier will be automatically assigned by the Solution Manager.

5. Run Managed System Configuration

Managed System Configuration makes your IBM WebSphere system known to the SAP Solution Manager
The Managed System Configuration activity is performed in the SAP Solution Manager Configuration Work Center.

Start the “Managed System Setup” wizard for the IBM WebSphere Application Server system.

  1. Start the Open the Configuration Work Center -> Managed System Configuration -> Technical Systems.
  2. Select the WebSphere system from the list. It is possible to filter on the system type (IBM WebSphere Application Server) or on the System ID (e.g. WS61MFR) or look for the entry by the Tomcat port/host name.
  3. Click on "Configure System". "Managed System Setup" wizard will be opened in a separate window.

Note:
The "Technical Systems" lists all technical systems known by the Landscape Management (LMDB) in the Solution Manager. If the Tomcat system cannot be found in the list, please check whether the SLD Data Supplier is installed and runs properly.

Perform “Managed System Configuration” wizard

The “Managed System Configuration” wizard consists of several steps you need to perform to complete Managed System Configuration for the Tomcat system.

  1. Select Product – to identify the IBM WebSphere product as "Diagnostics Relevant".
  2. Assign Diagnostics Agent – to connect the SMD agent on the WebSphere host(s) to the Solution Manager.
  3. Enter System Parameters – to specify parameters like the WebSphere Administration Console’s host/port or which Introscope Enterprise Manager to be used.
  4. Enter Landscape Parameters – to specify WebSphere’s installation path.
  5. Configure Automatically – to run Introscope Host Adapter and Extractor setup.

Select Product

On the "Select Product" page you need to select diagnostics – relevant products installed on the IBM WebSphere system.
The “WEBSPHERE APPSERVER BY IBM” product is the installed product for the IBM WebSphere Application Server software.
a)      Please click on the “Edit Technical System Software” button. Technical System Editor application starts in a separate window.

b)      In the Technical System Editor select the Diagnostics Relevant checkbox on the Software -> Product Instances tab, save the data and close the dialog. 

c)       Press the Refresh button on the “Select Product” screen. Now the IBM WebSphere product is marked as diagnostics relevant.

Go the Assign Diagnostics Agent step.

Assign Diagnostics Agent

Connect the Diagnostics Agent to the Solution Manager and assign it to the WebSphere host(s).


  

 

Enter System Parameters

Specify or verify system parameters for the IBM WebSphere Application Server system.
Common parameters

  • "Introscope EM" - the Introscope Enterprise Manager’s host and port to which Wily Java Agent on the Tomcat server reports to.
  • "Integrated Solutions Console Host" – the host name there the WebSphere’s Admin UI (Administration Console) is installed
  • "Integrated Solutions Console Port" – the WebSphere’s Admin UI Https port.
  • "HTTPs" checkbox – whether HTTPS protocol should be used (typically yes)


WebSphere Administration Console is typically installed on the Deployment Manager host and secured via HTTPs. The SLD Data Supplier for IBM WebSphere will report the data to SLD. You will find the correct values for the host and port parameters in the LMDB UI.

.

WebSphere parameters

  • "Setup User" – the WebSphere role name used, for example, to trigger Thread Dumps from the Solution Manager in the OS Command Console for WebSphere.
  • "Password" – the password for the WebSphere setup user.

    Enter the data pressing the "Save" button.

Go to the Enter Landscape Parameters step.

Enter Landscape Parameters

In the "Enter Landscape Parameters" you have to provide the paths to the WebSphere’s files like the profile path or server log path.
Following parameters are required for WebSphere nodes:

  • Instance Installation Path – the path to the root directory of the WebSphere installation; the WebSphere’s WAS_INSTALL_ROOT variable, for example, C:/IBM/WAS6.1ND/AppServer
  • Instance Profile Path – the path to the node’s profile directory; the value of the WebSphere’s USER_INSTALL_ROOT variable, for example, C:\IBM\WAS6.1ND\AppServer\profiles\AppSrv01
  • Instance Log Path  - the path there the node’s logs are stored; the value of the WebSphere’s LOG_ROOT variable, for example,  $USER_INSTALL_ROOT/logs

Following parameters are required for WebSphere’s servers:

  • Node Log Path – the path to the directory, there the server logs are stored; the value of the WebSphere’s SERVER_LOG_ROOT variable, for example  $LOG_ROOT/server1

SLD DS automatically reports the parameters for the WebSphere system. Please inspect the Landscape Objects in the hierarchy and check whether any user input is required.  Please note following status labels:
The status is set to “No Parameter”: no input required.
The status is set to “Default used”: verify the parameter.
The status is set to “Input missing”: enter the parameter.

Please check the parameters for the WebSphere system and update if appropriate. You will find the values for all the parameters in the Technical System Editor.
Important: for the first time, please save the data in that dialog in any case even if did change any values. Otherwise the landscape parameters will not be propagated to the configuration store of the Solution Manager.

Configure Automatically

Perform the “Extractor Setup” and “Introscope Host Adapter” activities. It may take several minutes.

Please verify that both activities have been completed successfully. The status for both must be set to Green.

Check also the messages and other detailed information in the Log area at the end of the screen.
The IBM WebSphere Application Server system is configured now for End-to-End Root Cause Analysis. Please go to the last step “Complete” and finish the Managed System Setup by pressing the “Finish” button.

The system status in the Managed System Configuration will be set to "green".

Manual Setup Steps and Troubleshooting

Typically, no manual configuration is necessary for IBM WebSphere server.  The described setup steps should enable E2E Root Cause Analysis for IBM WebSphere Application Server system. However, for some E2E RCA application it might be necessary to perform addition configuration in Solution Manager/WebSphere Server. This chapter provides the details helpful for troubleshooting/manual configuration in problem cases.

Configuration for E2E Exception Analysis and Log Viewer

Solution Manager 7.1 can display WebSphere’s log files in the Log Viewer application and collect and analyze errors in the E2E Exception Analysis application. However, logging in WebSphere is very flexible. WebSphere logging can be configured very differently.  Logging depends also on the OS settings/user preferences. 

The Log Viewer/E2E EA for WebSphere functionality depends on correct configuration that matches the log settings of the particular WebSphere system.

E2E Exception Analysis configuration

Open “SAP Solution Manager Administration WorkCenter” -> “Framework” -> “Root Cause Analysis” -> Tab “Views”

Click on the “Display configuration” and inspect the configuration for WebSphere (search for “SystemOut” in the config.xml file)

Following WebSphere log files are configured in E2E Exception Analysis for IBM WebSphere

SystemOut*.log

SystemErr*.log

The files are collected from the WebSphere server’s log folder specified by the ”Instance Log Path”  parameter.

Log Viewer configuration

Open “SAP Solution Manager Administration WorkCenter” -> “Framework” -> “Root Cause Analysis” -> Tab “Stores”

Navigate to the node “IBM WEBSPHERE APPL.SERVER V6.0” and inspect the stores.

SERVER LOGS

Following WebSphere server log files are configured for the LogViewer application for IBM WebSphere Application Server:

SystemErr*.log

SystemOut*.log

trace*.log

stopServer*.log

startServer*.log

NODEAGENT LOGS

Following  log files are configured for the  LogViewer application for IBM WebSphere nodeagent

SystemErr*.log

SystemOut*.log

trace*.log

stopServer*.log

startServer*.log

Log file parser configuration

Regular expressions are used to parse WebSphere’s log file. They are specified in the LV_config.xml configuration file of the Diagnostics Agent. To check the configuration open “Diagnostics Agent Administration” -> “Application Configuration” -> “com.sap.smd.agent.application.logfilecollector” application. Select the correct Diagnostics Agent and download the LV_config.xml file

Inspect the LV_config.xml file content. Find the configuration sections for WebSphere “WebSphere_FileSet” (to parse WebSphere logs).

The regular expressions specified by the parameter “Regex” and the used time stamps “TimestampFormat” must be match WebSphere logs.

For example, to parse WebSphere Server log shown below

[7/12/05 14:46:00:264 EDT] 0000001a ApplicationMg E WSVR0221I: Application failed: adminconsole

[14.04.09 13:40:57:958 CEST] 00000024 exception     E com.ibm.ws.wim.ProfileManager loginImpl CWWIM4537E Für den Namen des Principals 'root' wurde kein Principal gefunden.

The pattern for the regular expression in the WebSphere_FileSet must be

 [timestamp] (optional [location]) [severity] Message

Depending on the user preferences (language, time and date format), the applicable timestamp pattern are:

Format=" M/dd/yy hh:mm:ss:SSS z" Country="US"

Format=" dd.MM.yy hh:mm:ss:SSS z" Country="DE"

Format=" dd/MM/yy hh:mm:ss:SSS z"mso-fareast-language: ZH-CN">en" Country="US"

Configuration for E2E Workload Analysis

E2E Workload Analysis for IBM WebSphere server uses performance data in Wily Introscope from two nodes:

  • Wily Java Agent node -  the data reported by the Wily Java Agent
  • Wily Host Adapter node – the data is reported by the Diagnostics Agent

The Wily Java Agent node has to match following structure

-<Host Name>

                - WebSphere

                                - <CELL _NAME><NODE_NAME><APP_SERVER_NAME>


 
The Wily Host Agent node has to match following structure

-<Host Name>

                - SAP HostAgent Process

                                - SAP HostAgent <SMD Agent Instance>

The Wily Host Agent node must contain the “SAP GC” sub node with an item for the WebSphere server beneath it.

 
If no Host Agent node is available of if “SAP GC” node is missing, please verify that

  1. SAP Host Agent is installed and running properly.
  2. The “Introscope Host Adapter” activity in the “Managed System Configuration” has been successfully performed.
  3. The configuration file SapAgentConfig.xml for the Host Agent application contains correct entries for the WebSphere system.
  4. JVM GC log file is configured on the WebSphere server and its patch is available in the LMDB for the WebSphere system

Configuration of the Host Agent Application

The Wily Host Agent is a Diagnostics Agent application that analyzes and makes JVM GC performance data in Wily Introscope. Its configuration is stored in the SapAgentConfig.xml file.  To check the configuration open “Diagnostics Agent Administration” -> “Application Configuration” -> “com.sap.smd.agent.application.wilyhost” application. Select the correct Diagnostics Agent and download the SapAgentConfig.xml file

 

There should be “destination” and “action” elements for the WebSphere Server and Manager.

<destination>

  <property value="C:\IBM\WAS6.1ND\profiles\Dmgr01/logs/dmgr/native_stderr.log" />

</destination>

<destination>

  <property value="C:\IBM\WAS6.1ND\profiles\AppSrv01/logs/server1/native_stderr.log" />

</destination>

 

<action prefix="SAP GC|WDFD00220692ACell03_WDFD00220692ACellManager03_dmgr" destination="WDFD00220692ACell03_WDFD00220692ACellManager03_dmgr" template="SapGC" />

<action prefix="SAP GC|WDFD00220692ACell03_WDFD00220692ANode03_server1" destination="WDFD00220692ACell03_WDFD00220692ANode03_server1" template="SapGC" />

Additional information

URL

Title

http://wiki.sdn.sap.com/wiki/display/SMSETUP 

SAP Solution Manager Setup Wiki

http://wiki.sdn.sap.com/wiki/display/TechOps/RCA_Home

Root Cause Analysis Wiki

https://service.sap.com/instguides > SAP Components > SAP Solution Manager > Release 7.1 

Solution Manager Installation Guides

SAP Note 1482727

SAP SLD Data Supplier for IBM WebSphere Application Server

SAP Note 1418638 

Wily Introscope Agent for IBM WebSphere Application Server

Appendix

Solution Manager Diagnostics components

Solution Manager Diagnostics Agent

The Solution Manager Diagnostics Agent (Diagnostics Agent) is the remote component of the E2E Root Cause Analysis. It allows to perform a connection between SAP Solution Manager and the satellite system(s) (WebSphere) and then to gather information from the satellite systems and reports them to the Solution Manager system.

SAP Host Agent

SAP Host Agent can be considered as the component responsible for the monitoring of the host/OS. It is installed on the satellite system (WebSphere hosts). Depending on the SMD agent version, SAP Host Agent must be installed separately or the ‘built-in’ SMD agent instance is used.

Wily Introscope Enterprise Manager

Wily Introscope is an application management solution created to manage Java Application performance. Introscope has three main components: the Enterprise Manager, the Workstation, and agents.

Wily Introscope Java Agent

The Java Agent is the component of Introscope that collects performance data from your applications running on Java Virtual Machines (JVMs), and sends it to the Introscope Enterprise Manager.

SAP Solution Landscape Directory (SLD)

A system landscape consists of a number of hardware and software components that depend on each other with regard to installation, software updates, upgrades, and demands on interfaces. The SAP System Landscape Directory (SLD) is a central repository of system landscape information.

SLD Data Supplier for IBM WebSphere

The SLD Data Supplier for IBM WebSphere is the software component that runs on IBM WebSphere Application Server and periodically reports landscape information to the SAP SLD.

Landscape Management (LMDB)

The Landscape Management Database is the repository of system landscape information in SAP Solution Manager where 

 

  • No labels