rca setup guide for apache tomcat 20140701

39
8/11/2019 RCA Setup Guide for Apache Tomcat 20140701 http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 1/39 End-To-End Setup Guide for Apache Tomcat Setup Guide CUSTOMER Document Version 7.10.20-2014-07-01

Upload: alessandro-conforti

Post on 02-Jun-2018

220 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 1/39

End-To-End Setup Guide for Apache Tomcat

Setup Guide

CUSTOMER

Document Version 7.10.20-2014-07-01

Page 2: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 2/39

This page is left blank for documents that are printed on bothsides.

Page 3: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 3/39

END-TO-END SETUP GUIDE FOR APACHE TOMCAT

TABLE OF CONTENTSINTRODUCTION ........................................................................................................................................... 6

Supported Apache Tomcat Server versions ................................................................................................. 6

DIAGNOSTICS ARCHITECTURAL OVERVIEW ................................................................................................. 7

SETUP FOR E2E ROOT CAUSE ANALYSIS AND SYSTEM MONITORING .......................................................... 9

1. Install Diagnostics Agent ......................................................................................................................... 9

2. Install Introscope Java Agent................................................................................................................... 9

3. Install SLD Data Supplier and register Apache Tomcat Server in SLD......................................................10

4. Configure Tomcat for E2E .......................................................................................................................11

4.1 Enable JMX ...........................................................................................................................................11

JMX remote connection configuration ........................................................................................................11

4.2 JVM GC log file configuration ................................................................................................................17

4.3 Tomcat logging configuration ................................................................................................................18

5. Run Managed System Configuration ......................................................................................................20

5.1 Assign Product ......................................................................................................................................20

5.2 Check Prerequisites ...............................................................................................................................22

5.3 Assign Diagnostics Agent .......................................................................................................................22

5.4 Enter System Parameters ......................................................................................................................22

5.5 Enter Landscape Parameters .................................................................................................................23

5.6 Finalize configuration ............................................................................................................................24

6. Technical Monitoring Setup ...................................................................................................................25

MANUAL SETUP STEPS AND TROUBLESHOOTING ......................................................................................26

Diagnostics Template .................................................................................................................................26

E2E Exception Analysis ...............................................................................................................................27

Page 4: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 4/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

4

E2E Exception Analysis configuration ..........................................................................................................27

Log Viewer .................................................................................................................................................28

Log View configuration LV_confix.xml .........................................................................................................29

Example: Tomcat service log in Log Viewer .................................................................................................32

E2E Workload Analysis ...............................................................................................................................32

Intorscope Java Agent .................................................................................................................................32

Host Agent ..................................................................................................................................................33

Host Agent Adapter....................................................................................................................................34

GC log file path for Tomcat in Landscape Browser .......................................................................................35

E2E Extractor Framework ...........................................................................................................................36

Relevant SAP notes ....................................................................................................................................38

ADDITIONAL INFORMATION ......................................................................................................................38

Page 5: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 5/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

5

This page is left blank for documents that are printed on bothsides.

Page 6: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 6/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

6

Introduction SAP Solution Manager 7.1 supports Apache Tomcat Server products with End-to-End Root Cause Analysisand System Monitoring. The guide documents how to setup E2E RCA and System Monitoring in SAPSolution Manager 7.1 SP12 for Apache Tomcat Server.

This guide is part of a global installation and configuration documentation. You may find more informationin the SAP Service Marketplace

Root Cause Analysis Installation and Upgrade Guide with SOLMAN_SETUPhttps://service.sap.com/diagnostics Installation and ConfigurationSolution Manager Installation Guides

https://service.sap.com/instguides SAP Components SAP Solution Manager Release7.1

An up-to-date version of this document is attached to the SAP note 1633036 .

Supported Apache Tomcat Server versions

Following Apache Tomcat Server releases are supported:

SAP Solution Manager 7.1 SP2

o Apache Tomcat 5.5o Apache Tomcat 6.0

SAP Solution Manager 7.1 SP8o Apache Tomcat 7.0

The screenshots and the navigation in this document apply to the SAP Solution Manager 7.1 SP12. The

document is also valid for the older SPs, however.

Page 7: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 7/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

7

Diagnostics architectural overview The goal of the section is to provide a ‘ten thousand foot view’ over the architecture of SAP SolutionManager 7.1 and to introduce main components.

E2E RCA for Apache Tomcat Server in SAP Solution Manager 7.1 is based on following components:

SAP Host AgentSolution Manager Diagnostics Agent

SAP Solution Landscape Directory (SLD)

SLD Data Supplier for Apache Tomcat

Landscape Management Database (LMDB)CA Introscope Enterprise Manager

CA Introscope Java Agent

The figure below depicts the key components in the SAP Solution Manager landscape.

Solution Manager Diagnostics Agent The SAP Solution Manager Diagnostics Agent is the remote component of the E2E Root Cause Analysis. Itenables SAP Solution Manager to connect to the satellite system (Apache Tomcat) to gather required data

from the satellite systems and to report it to the SAP Solution Manager system.

Page 8: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 8/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

8

SAP Host Agent SAP Host Agent can be considered as the component responsible for the monitoring of the host/OS. It isinstalled on the satellite system (the Tomcat host). With the latest Diagnostics Agent versions the SAP Host

Agent is installed automatically with the Diagnostics Agent. The SAP Host Agent can also be installedseparately.

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

CA Introscope Java Agent The Java Agent is the component of Introscope that collects performance data from your applicationsrunning 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 eachother with regard to installation, software updates, upgrades, and demands on interfaces. The SAP SystemLandscape Directory (SLD) is a central repository of system landscape information.

SLD Data Supplier for Apache Tomcat The SLD Data Supplier for Apache Tomcat is the software component that runs on the Tomcat andperiodically reports landscape information to the SAP SLD.

Landscape Management (LMDB)

The Landscape Management Database is the repository of system landscape information in SAP SolutionManager.

Page 9: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 9/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

9

Setup for E2E Root Cause Analysis and System Monitoring The following table lists the steps required to set up E2E Root Cause Analysis for an Apache Tomcat Serversystem.

1. Install Diagnostics Agent Please refer to SAP note 1365123 Installation of Diagnostics Agents.

Diagnostics Agent 7.3 installs automatically SAP Host Agent. Please make sure, however, that SAP HostAgent corresponds to the version in the SAP note 1448655 . In addition, please refer to SAP Note 1031096

“Installing Package SAPHOSTAGENT” for details on how to install the SAP Host Agent package.

2. Install Introscope Java Agent Please refer to SAP note 13438005 “Wily Introscope Agent for Apache Tomcat Server” for details.

Install Diagnostics AgentStep 1

Run Technical Monitoring SetupStep 6

Install CA Introscope BC AgentStep 2

Install SLD Data Supplier and register ApacheTomcat

system in SAP SLD/SAP Solution Manager

Step 3

Configure Apache Tomcat for monitoringStep 4

Run Managed System SetupStep 5

Page 10: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 10/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

10

3. Install SLD Data Supplier and register Apache Tomcat Server in SLD Landscape information is the basis for all processes in SAP Solution Manager 7.1. SAP Solution Managerstores the landscape information in the Landscape Management Database (LMDB).

SAP Solution Manager collects and stores detailed data about the system landscape such as:

Landscape data of the Apache Tomcat Server systems (hosts/servers) and their properties (paths,ports).Installed software (software and product components versions).

Database information.

Solution Manager uses one or multiple SAP Software Landscape Directory (SLD) systems to query for thelandscape information. For that purpose SAP Solution Manager 7.1 provides content synchronization

mechanism between SLD and LMDB.

More Information

For more information, see Landscape Data Management Overview and Maintenance of Product in theSystem Landscape in the SAP Community Network.

SAP provides SLD Data Supplier for Apache Tomcat. The SLD-DS automatically reports landscape data of the Apache Tomcat server to the SAP SLD. The SAP note 1508421 “SAP SLD Data Supplier for ApacheTomcat” describes how to install and configure the SLD-DS for Apache Tomcat. Please refer to the SAP note1508421 for details.

NOTE:

Consider to assign an appropriate System ID to the Tomcat system. Use the SYSTEM_ID configurationproperty of the SLD-DS for that. For example,

SYSTEM_ID = ATC_SYSTEM

If you don’t specify the system ID identifier explicitly, it will be automatically assigned in the SAP SolutionManager.

Page 11: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 11/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

11

4. Configure Tomcat for E2E A default Apache Tomcat installation lacks some configuration settings by the SAP Solution Managerrequired for E2E RCA and System Monitoring. For example, Tomcat is typically installed without any loggingconfiguration and without Java GC logging and with no JMX enabled.

Apply following configuration changes and restart the Tomcat:

1. Enable JMX.2. Configure Java GC logging.3. Configure Apache Tomcat logging.

4.1 Enable JMX

The E2E Workload Analysis and System Monitoring use the performance data reported by the Tomcatthrough JMX. JMX is not enabled in Tomcat by default. To enable JMX data, add the following JVM systemproperty to the Tomcat’s JVM configuration:

- Dcom. sun. management . j mxr emot e

With the Thread Dump Analyzer application in SAP Solution Manager 7.1 you can trigger and analyzethread dumps from the Tomcat. To trigger thread dumps with the TDA you must additionally setup a JMXremote connection.

JMX remote connection configuration To monitor the Tomcat via JXM and to trigger and analyze thread dumps in the SAP Solution Manager youcan additionally configure a JMX remote connection.

Set following JVM system properties in the Tomcat’s JVM startup configuration:

com. sun. management . j mxr emot e. por t = <j mx_ por t >

Tomcat expects that the remote connection is protected by user/password authentication. You shouldeither disable authentication explicitly or provide valid credentials with JMX remote access and passwordfiles.

To disable authentication of JMX remote connection, set the following JVM system property:

com. sun. management . j mxr emot e. aut hent i cat e=f al se

To protect Tomcat from unauthorized access through JMX remote connection you can secure the accesswith user and password. For that add following JVM parameters:

com. sun. management . j mxr emot e. s sl =f al secom. sun. management . j mxr emot e. aut hent i cat e=t r ue

Page 12: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 12/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

12

com. sun. management . j mxr emot e. passwor d. f i l e=<pat h j mxr emot e. passwor d>com. sun. management . j mxr emot e. access. f i l e=<pat h j mxr emot e. access>

Example: Tomcat JVM parameters for JMX (Windows) -Dcom.sun.management.jmxremote.port=9004-Dcom.sun.management.jmxremote.ssl=false-Dcom.sun.management.jmxremote.authenticate=true-Dcom.sun.management.jmxremote.password.file=C:/APACHE/Tomcat6.0.33/conf/jmxremote.password-Dcom.sun.management.jmxremote.access.file=C:/APACHE/Tomcat6.0.33/conf/jmxremote.access

There<pat h j mxr emot e. passwor d>

and<pat h j mxr emot e. access>

are the paths to thepassword and access control files. The password file $CATALINA_BASE/conf/jmxremote.access definesavailable user roles (user names) and their permissions. The password control file$CATALINA_BASE/conf/jmxremote.password defines the passwords for each role.

NOTE: SSL is currently not supported.

Edit the jmxremote.access file. In the jmxremote.access file, add an appropriate role with the readwrite access, for example a

smdAgentRole role:

smdAgent Rol e r eadwr i t e

Edit the jmxremote.password file. In the jmxremote.password file specify the password for the role you defined in the jmxremote.access file:

smdAgent Rol e abcd1234

Page 13: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 13/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

13

Note

The JMX remote connection role/password needs to be specified in the Managed System Setup for the

Apache Tomcat Server system in the “Enter System Parameters” step.

Access t o t he password f i le Make sure that only the Tomcat’s user account has the permission (read and write) to access the

jmxremote.password file. For security reasons, because the file contains unencrypted passwords, Tomcatchecks on the file access at stat up and, if Tomcat does not have exclusive access to the file, aborts thestartup.

The check causes problems particularly on Windows, if Tomcat runs as a Windows service under the local

user account.

The access configuration to the password and access files is platform depended. On Windows it alsodepends whether Tomcat runs as the built-in system account or as a “named” user.

Page 14: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 14/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

14

Tomcat Service running as Local System account Tomcat Service running as “user” account

On Windows for (local) system account

Perform following steps to restrict the access to the jmxremote.password file for a built-in system account

1. Right click password file and open Properties .2. On the Security tab, go to “Advanced” dialog.3. In the “Advanced Security Settings” clear the “Include inheritable permissions from this object’s

parent” checkbox. Remove all inherited permissions and apply the changes.

before After

4. On the Security tab, edit the permissions. Remove the permissions for all groups/user namesexcept the SYSTEM account.

Page 15: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 15/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

15

before after

5. Set the file owner to the “SYSTEM” account.

before after

On Windows for user account

Perform the following steps described to restrict the access to the jmxremote.password file for a “named”user account.

Page 16: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 16/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

16

Right click password file and open Properties .

1. On the Security tab, go to “Advanced” dialog.

2. In the “Advanced Security Settings” clear the “Include inheritable permissions from this object’sparent” checkbox. Remove all inherited permissions and apply the changes.

3. On the Security tab, edit the permissions. Remove the permissions for all groups/user namesexcept the user account that Tomcat runs on.

On Linux:

Logon as the Tomcat user and apply the chmod 600 command.

Further Refer ences Please consult Apache Tomcat documentation for more details. E.g. Apache Tomcat 6.0 -> Monitoring andManaging Tomcat -> Enable JMX Remote under following link http://tomcat.apache.org/tomcat-6.0-doc/monitoring.html#Enabling_JMX_Remote

Please refer also to Java documentation for JMX, e.g. the “ Monitoring and Management Using JMX ”chapter in Java 1.5 documentation onhttp://download.oracle.com/javase/1.5.0/docs/guide/management/agent.html.

The chapter “ How to Secure a Password File on Microsoft Windows Systems ” onhttp://download.oracle.com/javase/6/docs/technotes/guides/management/security-windows.html

Page 17: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 17/39

Page 18: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 18/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

18

4.3 Tomcat logging configuration

Make sure, the logging is properly configured. Check whether the JVM system properties“java.util.logging.manager” and “java.util.logging.config.file” are set. For example,

-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager-Djava.util.logging.config.file=C:\APACHE\Tomcat\Tomcat6.0.33\conf\logging.properties

All logs have to be written in English (e.g. the time format and the severity). To change the language set theJVM’ user language parameter to EN:

-Duser.language=en-Duser.region=US

Page 19: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 19/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

19

To collect non-English logs update the Solution Manager’s log parser configuration (LV_config.xmlconfiguration file) correspondingly.

Example: Sample Tomcat JVM parameters (Windows) -Dcatalina.home=C:\APACHE\Tomcat6.0.33-Dcatalina.base=C:\APACHE\Tomcat6.0.33-Djava.endorsed.dirs=C:\APACHE\Tomcat6.0.33\endorsed-Djava.io.tmpdir=C:\APACHE\Tomcat6.0.33\temp

-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager-Djava.util.logging.config.file=C:\APACHE\Tomcat6.0.33\conf\logging.properties-javaagent:C:/usr/sap/CCMS/wily/Agent.jar-Dcom.wily.introscope.agentProfile=c:/usr/sap/CCMS/wily/core/config/IntroscopeAgent_tomcat.profile-Dcom.wily.introscope.agent.agentName=wdfd00291023a_8005-Dcom.sun.management.jmxremote.port=9004-Dcom.sun.management.jmxremote.ssl=false-Dcom.sun.management.jmxremote.authenticate=true-Dcom.sun.management.jmxremote.password.file=C:/APACHE/Tomcat6.0.33/conf/jmxremote.password-Dcom.sun.management.jmxremote.access.file=C:/APACHE/Tomcat6.0.33/conf/jmxremote.access-Xloggc:C:/APACHE/Tomcat6.0.33/gcTomcat.gc

-XX:+PrintGCDetails-XX:+PrintGCTimeStamps-Duser.language=en-Duser.region=US

Page 20: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 20/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

20

5. Run Managed System Configuration Managed System Configuration makes the Apache Tomcat Server system “known” in the SAP SolutionManager. The Managed System Configuration activity is performed in the SAP Solution Manager

Configuration Work Center.

In the SAP Solution Manager Configuration (transaction SOLMAN_SETUP ), choose Managed SystemsConfiguration Technical Systems , select the Apache Tomcat Server system and choose ConfigureSystem .

NOTE:

The “Technical Systems” lists all technical systems known by the Landscape Management (LMDB) in theSolution Manager. If the Apache Tomcat Server system cannot be found in the l ist, please check whetherthe SLD Data Supplier is installed and runs properly.

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

1. Select the Apache Tomcat product as “Diagnostics Relevant”.2. Assign the Diagnostics Agent to the Apache Tomcat Server system.3. Enter System Parameters like Tomcat’s HTTP port or the Introscope Enterprise Manager to be used.4. Specify the Landscape Parameters like Tomcat’s installation path5. Finish Configuration with automatic configuration steps like the “Introscope Host Adapter” and the

“E2E Extractor setup.

5.1 Assign Product

On the “Select Product” page you need to select diagnostics – relevant products installed on the Tomcatserver.

Page 21: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 21/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

21

The “TOMCAT BY APACHE” (of particular version) is the installed product for the Apache Tomcat software.The “SBOP BI PLATFORM” is the example of another product that can be reported as installed on theTomcat server (e.g. for BOE XI application).

In this step, please select the Diagnostics Relevant checkbox.

NOTE:

In the Managed System Configuration you can only mark all the installed Software Products as DiagnosticsRelevant. If you want to differentiate between them (to say, for example, SBOP BI PLATFORM is not Diagnostics Relevant) you can mark single Products in the Technical System Editor. For that click on the“Edit Technical System Software” button and set the “Diagnostics Relevant” check boxes accordingly.

Page 22: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 22/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

22

5.2 Check Prerequisites

There are no prerequisites. Continue with the next step “ Assign Diagnostic Agent” .

5.3 Assign Diagnostics Agent Connect the Diagnostics Agent to the Solution Manager and assign it to the Apache Tomcat Server system.

5.4 Enter System Parameters Specify following system parameters for the Tomcat.

Common parameters “Introscope EM” - the Introscope Enterprise Manager’s host and port to which Introscope JavaAgent on the Tomcat reports to.“Tomcat Host” – the host name there the Tomcat is installed on

“Tomcat Http Port” – the Tomcat’s Http port

“HTTPs” checkbox – whether HTTPS protocol should be used (typically not)

Page 23: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 23/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

23

Tomcat parameters

“Setup User” – the role name for the JMX remote connection’s authorization (the value from the jmxremote.password) or empty, if no authentication is used.

“Password” – the password for the JMX remote connection’s authorization (the value from the jmxremote.password) or empty, if no authentication is used.“JMX Port” – the port for the JMX remote connection.

See the chapter “JMX remote connection configuration” for more details.

5.5 Enter Landscape Parameters Check the landscape parameters for the Apache Tomcat Server system and, if necessary, provide thevalues.

Inspect the Landscape Objects in the hierarchy and check whether any user input is required.

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.

The SLD DS for Apache Tomcat automatically reports the installation path of the Tomcat.

The value should be set automatically from the LMDB and the parameter set to “default used”.

Page 24: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 24/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

24

5.6 Finalize configuration Perform the automatic configuration steps “Extractor Setup” and “Introscope Host Adapter”.

Page 25: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 25/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

25

6. Technical Monitoring Setup In the SAP Solution Manager Configuration (transaction SOLMAN_SETUP), choose Technical Monitoring

System Monitoring Define Scope Technical Systems. S elect the Apache Tomcat Server system

and process with the next stem Setup Monitoring .

To setup the monitoring assign the “Apache Tomcat” monitoring template to the Apache Tomcat Serversystem, assign an appropriate monitoring template to the host and apply the monitoring setup with “Apply and Active”.

Page 26: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 26/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

26

Manual Setup Steps and Troubleshooting Typically, no manual configuration in the SAP Solution Manager is required for Apache Tomcat Server. Theconfiguration activities in Managed System- resp. System Monitoring Setup steps should automaticallyenable E2E RCA/System Monitoring for Apache Tomcat Server system. However, in some cases it might benecessary to manually update the configuration in the SAP Solution Manager. This chapter provides thebackground information and the implementation details for troubleshooting/manual configuration inproblem cases.

Diagnostics Template For a product the Diagnostics Template specifies its landscape parameters, the configuration and log stores.

Open “SAP Solution Manager Administration” workcenter -> “Content” -> “Root Cause Analysis” -> Tab“Stores”

Following notes contain for the latest updates on the Diagnostics Template configuration files for Apache

Tomcat:

Page 27: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 27/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

27

1783885 - RCA template for Solution Manager 7.10 SP061783886 - RCA template for Solution Manager 7.10 SP07

1811700 - RCA template for Solution Manager 7.10 SP08

1882778 - RCA template for Solution Manager 7.10 SP09

1940337 - RCA template for Solution Manager 7.10 SP101989380 - RCA template for Solution Manager 7.10 SP11

E2E Exception Analysis Solution Manager 7.1 displays Tomcat’s log files in the Log Viewer application and collects and analyzes

errors the E2E Exception Analysis application.

Logging in Tomcat can be setup in very different ways, however. It can utilize different framework (Log4J,Java logging etc.) and can be configured very differently. Logging depends also on the OS settings/userpreferences.

Both the Log Viewer/E2E EA for Tomcat functionality depends on correct configuration that corresponds tothe log settings of the particular Apache Tomcat Server system.

E2E Exception Analysis configuration Open “SAP Solution Manager Administration” workcenter -> “Framework” -> “Root Cause Analysis” -> Tab“Views”

Page 28: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 28/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

28

Click on the “Display configuration” and inspect the E2E EA configuration for Apache Tomcat in theconfiguration file config.xml.

Following Tomcat log files are configured for E2E Exception Analysis for Apache Tomcat

stderr*.logstdout*.logcatalina*.log

manager*.loghost-manager*.loglocalhost*.logadmin*.log

jakarta_service*.logcommon-demon*.log

The files are collected from the Tomcat default log folder %CATALINA_HOME%/logs. Please make sure,Tomcat logging is configured properly.

Log Viewer The log files for Apache Tomcat are specified in the Diagnostics Template “APACHE TOMCAT 5.5”.

Page 29: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 29/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

29

Following Tomcat log files are configured for LogViewer application for Apache Tomcat

stderr*.logstdout*.logcatalina*.logmanager*.loghost-manager*.loglocalhost*.logadmin*.log

jakarta_service*.log

Log View configuration LV_confix.xml To display Tomcat’s log files SAP Solution Manager describes the log format in the LV_confix.xmlconfiguration file. The LV_config.xml configuration file is a resource file on the Diagnostics Agent.

To review the configuration open “Diagnostics Agent Administration” -> “Application Configuration” ->“com.sap.smd.agent.application.logfilecollector” application. Select the correct Diagnostics Agent anddownload the LV_config.xml file

Page 30: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 30/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

30

Inspect the LV_config.xml file content. Find the configuration sections for Tomcat “Tomcat_FileSet” (toparse Tomcat logs) and “Tomcat_Jakarta_FileSet” (to parse Tomcat service log on Windows).

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

Page 31: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 31/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

31

For example, to parse Tomcat Windows Service log Jakarta_service.log shown below

[2011-07-08 13:27:06] [info] Commons Daemon procrun (1.0.5.0 32-bit) started

[2011-07-08 13:27:06] [info] Running 'Tomcat6' Service...

[2011-07-08 13:27:06] [info] Starting service...

[2011-07-08 13:27:07] [info] Service started in 1249 ms.

[2011-07-08 13:27:22] [info] Stopping service...

[2011-07-08 13:27:23] [info] Service stopped.

[2011-07-08 13:27:23] [info] Run service finished.

[2011-07-08 13:27:23] [info] Commons Daemon procrun finished

The pattern for the regular expression in the Tomcat_Jakarta_FileSet must be

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

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

For mat =" MMMM dd, yyyy hh: mm: ss a" Language="en" Count r y=" US"

Page 32: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 32/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

32

For mat =" dd. MM. yyyy hh: mm: ss a" Language=" de" Count r y="DE"

For mat =" dd- MMM- yyyy hh: mm: ss" Language="de" Count r y=" DE"

For mat =" dd- MMM- yyyy hh: mm: ss" Language="en" Count r y=" US"

For mat =" yyyy- MM- dd HH: mm: ss" Language=" en" Count r y="US"

Example: Tomcat service log in Log Viewer The Windows Service log Jakarta_service will be displayed in the LogViewer application:

E2E Workload Analysis E2E Workload Analysis for Apache Tomcat server uses performance data in the Introscope EM from twonodes:

Introscope Java Agent node - the data reported by the Introscope Java Agent from the Tomcatserver process.

Host Agent node – the data is reported by the Wily Host Adapter application in the DiagnosticsAgent.

Intorscope Java Agent The Introscope Java Agent should apply following naming conventions

Host name: the host name in lower case

Process name: Tomcat

Agent name: <host name>_<Tomcat’s shutdown port>

Page 33: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 33/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

33

Host Agent The Host Agent node has to match following structure

Host name: the host name in lower case

Process name: SAP HostAgent ProcessAgent name: SAP HostAgent <SMD Agent Instance>

The Host Agent node must contain the “SAP GC” sub node with a sub-node for the Apache Tomcat serverbeneath.

Page 34: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 34/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

34

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 Tomcat system.4. JVM GC log file is configured on the Tomcat server and its patch is available in the LMDB for the

Tomcat system

Host Agent Adapter The Wily Host Agent Adapter application is a Diagnostics Agent application that publishes severalperformance metrics from SAP Host Agent to Introscope. For Apache Tomcat it also analyzes and reportsthe JVM GC data to the Introscope EM.

The Host Agent Adapter configuration is stored in the SapAgentConfig.xml file. To check the configurationopen Diagnostics Agent Administration -> Application Configuration ->com.sap.smd.agent.application.wilyhost application. Select the Diagnostics Agent and download theSapAgentConfig.xml file

Page 35: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 35/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

35

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

<dest i nat i oncl ass=" com. sap. smd. wi l y. host agent . dest i nat i on. Fi l eDest i nat i on"name=" wdf d00291023a_8005">

<pr oper t y name="pat h" val ue=" C: / APACHE/ Tomcat / Tomcat 6. 0. 33/ gcTomcat . gc"/ >

</ dest i nat i on>

<act i on pr ef i x="SAP GC| wdf d00291023a_8005"

name=" SAP GC| wdf d00291023a_8005" dest i nat i on="wdf d00291023a_8005"

t empl at e=" SapGC" / >

GC log file path for Tomcat in Landscape Browser The path to the JVM GC log file is reported automatically for Tomcat by the SLD Data Supplier. To checkthat the value is available in the LMDB, open the Landscape Browser and inspect the properties of JVMobject.

Page 36: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 36/39

Page 37: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 37/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

37

There should be two following extractors available for every supported Apache Tomcat Server version

com.sap.sup.admin.bwextract.E2eEAExtractor - for E2E Exception Analysis data

com.sap.sup.admin.bwextract.E2eWAIntroscopeExtractor – for E2E Workload Analysis data

You can manually enable additional extractor templates for Apache Tomcat:

1. Download the attached to the SAP note 1633036 E2E_ExtrTemplate_ApacheTomcat_all.csv file.The file contains extractor template definitions for all supported Apache Tomcat versions (withSolution Manager SP12).

2. Enter the Expert Mode and upload the csv file via “Data Exchange for Extractor template”.3. Verify that the E2E extractor definitions for Apache Tomcat 7.0 are available in the extractor

template table.4. Open the Managed System Setup for the Apache Tomcat Server system and re-execute the

Extractor Setup step on the Finalize Configuration Steps

More information

For more information see the Technical Operation page on the SDN EFWK_OVERVIEW .

Page 38: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 38/39

END-TO-END RCA SETUP GUIDE FOR APACHE TOMCAT

38

Relevant SAP notes Refer to the following SsAP notes for more details on the particular installation steps:

SAP Note 1448655 - Inst. 7.30 - Diagnostics Agent installationSAP Note 1508421 - SAP SLD Data Supplier for Apache Tomcat

SAP Note 1438005 - Wily Introscope Agent for Apache Tomcat server

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 ComponentsSAP Solution Manager Release 7.1

Solution Manager Installation Guides

Page 39: RCA Setup Guide for Apache Tomcat 20140701

8/11/2019 RCA Setup Guide for Apache Tomcat 20140701

http://slidepdf.com/reader/full/rca-setup-guide-for-apache-tomcat-20140701 39/39

www.sap.com

© 2012 SAP AG. All rights reserved.

SAP, R/3, S AP NetWeaver, Duet, PartnerEdge, ByDesign, SAPBusinessObjects Explorer, StreamWork, SAP HANA, and other SAP productsand services mentioned herein as well as their respective logos aretrademarks or registered trademarks of SAP AG in Germany and othercountries.

Business Objects and the Business Objects logo, BusinessObjects, CrystalReports, Crystal Decisions, Web Intelligence, Xcelsius, and other B usinessObjects products and services mentioned herein as well as the ir respectivelogos are trademarks or registered trademarks of Business Objects SoftwareLtd. Business Objects is an SAP c ompany.

Sybase and Adaptive Server, iAnywhere, Sybase 365, SQL Anywhere, andother Sybase products and services mentioned herein as w ell as their

respective logos are trademarks or registered trademarks of Sybase Inc.Sybase is an SAP company.

Crossgate, m@gic EDDY, B2B 360°, and B2B 360° Services are registeredtrademarks of Crossgate AG in Germany and other countries. Crossgate is anSAP company.

All other product and service names mentioned are the trademarks of theirrespective companies. Data contained in this document serves informationalpurposes only. National product specifications may vary.

These materials are subject to change without notice. These materials areprovided by SAP AG and its affiliated companies ("SAP Group") forinformational purposes only, without representation or warranty of anykind, and SAP Group shall not b e liable for errors or o missions with respectto the materials. The only warranties for S AP Group products and servicesare those that are set forth in the express warranty statementsaccompanying such products and services, if any. Nothing herein should beconstrued as constituting an additional warranty.