Wily Intro Scope 8 Installation Guide
Wily Intro Scope 8 Installation Guide
Installation Guide
For SAP
March 2010
Introscope Installation for SAP
Contents
Contents ........................................................................................................................................... 2
1 Installation Overview ............................................................................................................... 3
2 Upgrading from Previous Versions to Introscope 8 ................................................................... 7
3 Installing the Introscope Enterprise Manager .......................................................................... 10
4 Introscope-Enabling SAP J2EE Systems ................................................................................ 19
5 Workstation Installation ......................................................................................................... 32
6 Environment Performance Agent (De)Installation .................................................................. 34
7 Additional Installation Options ............................................................................................... 35
1 Installation Overview
This document covers the installation and configuration of Introscope in the following
chapters:
• Installation Overview
• Upgrading previous versions to Introscope 8
• Installing Introscope Enterprise Manager
• Introscope-enabling SAP J2EE Systems (Agent Installation)
• Optional: Installing Introscope Workstation
• Environment Performance Agent (De)installation
• Optional Configuration Steps
Introscope Overview
Introscope is an application management solution created to manage Java Application
performance. Unlike development tools, Introscope is designed to scale with minimal
performance impact. This allows you to monitor and manage your application performance
in live production environments.
The Right to View (RTV) version of CA-Wily Introscope is a restricted, read-only form of the
full product and is bundled with SAP Solution Manager. With the RTV version, support is
limited to products that are licensed and supported by SAP. The instrumentation,
dashboards, Probe Builder Directives (PBD’s), management modules, and Smartstor data
contained within the RTV version of CA-Wily Introscope as provided by SAP is the
intellectual property of SAP. Use of these functions is restricted by SAP and may only be
used in an unrestricted manner by licensing SAP Extended Diagnostics by CA-Wily from
SAP.
Introscope Access
After installation, you can use the following default credentials to access Introscope:
1. Check SAP Note 797147 for latest updates to the installation procedure and to this
document. A list of frequently asked questions for troubleshooting the installation is
also attached to this note.
2. Download installation files from SAP Service Marketplace.
3. Install the Introscope Enterprise Manager on the central monitoring system and add
the management modules.
4. Install the Introscope Java Agents and Host Agents on managed systems.
5. Optional: Install the Introscope Workstation.
Installation Tools
Details on the used installation tools (sapcar and SDM) can be found in the “Support
Package Stack Guide”: http://service.sap.com/instguidesNW04 -> Operations
• Move the remaining files from the old installation to a different location, e.g. from
/usr/sap/ccms/wilyintroscope to /usr/sap/ccms/wilyintroscope.old
• Perform the new installation to the same directory
(/usr/sap/ccms/wilyintroscope) again using the procedure described in the
next section. Make sure you also extract the new management modules files
(SAPISMM*.SAR) as described in the next section.
• Shut down the newly installed Enterprise Manager in case it was launched after the
installation.
• Remove the subdirectories /data and /traces from the new installation if they
exist. They will only be created if the Enterprise Manager is started.
• Copy or move the old subdirectories /data and /traces to the new location. Be
aware that the traces database will be migrated to a new format when the
Enterprise Manager is launched. As an alternative, you may also decide to drop the
/traces directory completely instead of migrating it.
• Manually transfer any custom management modules (located in
/config/modules) from the old to the new location. But do not overwrite newly
installed standard SAP modules with older versions.
• Manually transfer any customization (Java VM parameter in file Introscope
Enterprise Manager.lax or EMService.conf or runem.nohup.sh, other
properties in file config/IntroscopeEnterpriseManager.properties). Do
not replace the new configuration files with the old copies since you may then loose
any newly introduced properties. Instead, copy and paste any customization from
your old files.
Agent Upgrade
All agent installations and upgrades can (and should) be done centrally by the
administration tools of Solution Manager. The only manual steps are to restart the
managed systems after any configuration change and to undeploy the JmxService J2EE
application (com.wilytech.jmxservice), which is no longer needed.
In case you want to do a manual upgrade, to get rid of any obsolete files we recommend
performing a fresh installation, e.g. by moving the old agent installation to a different
directory. Since some agent files are locked while the monitored system is running, the
monitored system must be down for the agent upgrade.
Also for the manual upgrade, the JmxService J2EE application is no longer needed starting
with release 7.1p9 of the Introscope agent. Please undeploy the old version with SDM.
WebView Upgrade
Starting with Introscope 7.1 the Enterprise Manager already contains an embedded
WebView that is run as part of the Enterprise Manager Java process. It is no longer
necessary to deploy it on NetWeaver, and support for deploying WebView on Netweaver is
stopped as of Introscope release 7.2. You should undeploy the old version of WebView on
NetWeaver (com.wilytech.webview). WebView running in the Enterprise Manager is by
Installation User
You should run the installer with the same user account that will be used later on for
running the Enterprise Manager. In particular, on Unix operating systems do not use the
root account to launch the installer. A common best practice is to use the sidadm user of
the Solution Manager installation to install and run the Enterprise Manager.
IBM i introscope8.2.2.0os400SAP.jar
* For Solaris SPARC and HPUX on PA RISC only 32-bit installers are available. If you want
to run the Enterprise Manager on a 64 Java VM, you can exchange the Java VM after the
installation. See below for details. Note, however, that you will not see any benefit from
switching to a 64-bit VM unless you have to extend the Java heap (-Xmx) to a value that is
not possible with a 32-bit VM – just the opposite: When switching to a 64 bit VM the same
EM configuration will have less capacity than before due to the 64-bit intrinsic overhead.
If you want to change this directory, e.g., because your SAP installation is located on a
different Windows drive, use one of the following alternatives.
Note: Use slash (/) as path separator for all platforms, including Windows!
introscope8.2.2.0windows.SAP.exe
–DUSER_INSTALL_DIR=d:/usr/sap/ccms/wilyintroscope.
Note: The instructions in this guide will use examples relative to the default
installation directory.
the JAVA_HOME directories and the according IBM I product options that need to be
installed:
IBM i 6.1: /QOpenSys/QIBM/ProdData/JavaVM/jdk50/64bit/jre (5761JV1 Opt. 9)
i5/OS V5R4: /QOpenSys/QIBM/ProdData/JavaVM/jdk50/32bit/jre (5722JV1 Opt.
8)
i5/OS V5R3: /QIBM/ProdData/Java400/jdk15 (5722JV1 Opt. 7)
Then, run the following command in QSH:
<JAVA_HOME>/bin/java –Djava.version=1.5 –classpath
introscope8.2.2.0os400SAP.jar install
• For the platform independent installer that does not contain a bundled Java VM use
the following command. /some/path/java refers to the Java 5 VM that you
installed as described above:
/some/path/java –classpath introscope8.2.2.0otherUnixSAP.jar install
Verifying Installation
The installer does not give confirmation of successful installation on the console. To
confirm installation was successful:
1. Verify that the Introscope directory exists at:
• <drive>:\usr\sap\ccms\wilyintroscope (Windows)
• /usr/sap/ccms/wilyintroscope (Unix, IBM i)
Summary
-------
Installation: Successful.
384 Successes
0 Warnings
0 NonFatalErrors
0 FatalErrors
Note: The number of successes may be different than what is shown in this example.
Enter the absolute path to a Java 5 VM if you want to use a Java VM that is not
bundled with the installer. In particular, you have to do this in two cases:
o Enter the path of a separately installed 64 bit Java 5 VM for platforms on
which by default only a 32 bit VM is provided:
Solaris on SPARC
HPUX on PA RISC
o Enter the path of a separately installed Java 5 VM for platforms where you
used the platform independent installer.
Set the Java VM parameter –Djava.awt.headless=true for all platforms.
Otherwise, the Enterprise Manager will need an X server, i.e., the DISPLAY
environment variable must point to a valid X Windows server.
Set the Java VM parameter –Dswing.volatileImageBufferEnabled=false for all
platforms based on the Sun VM in case you see display problems with WebView.
On IBM i, set the Java heap size properties based on the JVM
o IT4J (J9): -Xms512m -Xmx512m
o IBM Classic: -Xms64m -Xmx2048m
Example:
cd /usr/sap/ccms/wilyintroscope
SAPCAR –xvf SAPISMM*.SAR
As a result you will find one or more .jar files in the subdirectory config/modules,
some .js files in the subdirectory scripts, and some other files distributed over the
Enterprise Manager installation.
The newly installed management modules only become active after the Enterprise
Manager is (re-)started. For Windows installations the Enterprise Manager is typically
automatically launched as Windows Service. This means you will have to restart the
Windows Service for the Enterprise Manager.
To set this up, you have to run a set of commands. This should be done ideally as the user
that the Wily Introscope Enterprise Manager will run under. If this user is not authorized for
some commands, do run the commands as user that is authorized (e.g. QSECOFR) and
change the ownership of the created objects afterwards.
If you can not run the commands as the Wily EM user, you have to change
ownerships by executing the following commands:
CHGOBJOWN OBJ(WILYEM) OBJTYPE(*LIB) NEWOWN(<Your User>)
CHGOBJOWN OBJ(WILYEM/WILYJOBQ) OBJTYPE(*JOBQ) NEWOWN(<Your User>)
CHGOBJOWN OBJ(WILYEM/WILYJOBD) OBJTYPE(*JOBD) NEWOWN(<Your User>)
CHGOBJOWN OBJ(WILYEM/WILYCLS) OBJTYPE(*CLS) NEWOWN(<Your User>)
CHGOBJOWN OBJ(WILYEM/WILYSBS) OBJTYPE(*SBSD) NEWOWN(<Your User>)
<Your User> can be any user, for example the <SID>ADM of your Solution Manager
system. This user needs to have access to the files in /usr/sap/ccms/wilyintroscope.
You can ensure this by running
chown –R <Your User> /usr/sap/ccms/wilyintroscope
in QSHELL or QP2TERM.
To activate the Wily Enterprise Manager at system startup, you need to add the start of
subsystem WILYEM/WILYSBS to your startup program (QSTRUP).
For controlling (starting/stopping) the Wily Enterprise Manager you can use the EMCtrl.sh
script as in Unix. However, be aware that the Wily Enterprise Manager job will run in your
current subsystem if you start it from a shell with “EMCtrl.sh start”.
3. Check the TCP port that Introscope Enterprise Manager is using for agent connections.
Look for lines similar to the following in the logfile:
In this case, the Enterprise Manager agent port is 6001 (default value).
5. Check the Enterprise Manager Settings at the top of the screen. These are the
connection parameters that will be used by the agent to connect to the Enterprise
Manager.
6. In the pane Introscope Agent Setttings, select the system that you want to instrument
with the agent. Check “select all” and click “Retrieve Current Settings”. This will display
the current status of the agent setup.
7. To initially setup or update the agents, click Setup Introscope Agent …. This will open
the setup dialog as shown below. Select the desired agent version (by default only one
available) and choose the profile. Next, check the desired instrumentation areas, and,
in the case of AIX, review the AIX settings to match your environment (J9 or classic
mode).
8. Finally, hit Apply to perform the necessary changes in the agent configuration. Agent
config files will be adapted, an Autoprobe connector will be created if necessary, and
the Java VM parameters will be set as required for the managed system.
9. For Netweaver 7.1: You may see a dialog asking to manually set the JVM parameters
via the ConfigTool. Use the Configtool to set the parameters as described. For
Netweaver 7.11, this dialog should not show up.
10. If the setup was successful, restart the managed system at your convenience, e.g. in
the next maintenance window. After the restart, the agent will be active and should
show up in the Introscope UIs.
section, could not be applied. The following instructions are valid for SAP J2EE versions
6.20, 6.40, 7.00, and 7.10 and higher.
The instructions in the following section work on both Windows and Unix systems, but the
examples show Windows convention (backslashes in the paths).
Note: Always use forward slashes (/) as path separators for Introscope config files and for
JVM parameters on all platforms including Windows. This avoids the need to escape
the Windows path separator backslash (\) by doubling it.
The following steps are required to install and configure the Introscope Agent to report
information to the Enterprise Manager:
1. Extract the Introscope Agent files
2. Create the Introscope Agent autoprobe connector (not for IBM i Classic VM and Java
5)
3. Introscope-enable the application code by setting Java VM parameters
1. Extract the agent installer file into the NetWeaver CCMS directory, usually:
<drive>:\usr\sap\ccms.
SAPCAR –xvf ISAGENTSTD*.SAR
2. Confirm the Agent was installed correctly by checking for the existence of the /wily
directory in the <drive>:\usr\sap\ccms directory.
SAP provides two agent profiles for different use cases. For all applications running on the
SAP J2EE Engine use IntroscopeAgent.profile. The second profile
IntroscopeAgent_ipc.profile is intended for SAP IPC 4.0. All profiles adhere to the
name pattern IntroscopeAgent*.profile. Note that the profile names have changed
starting with the 7.2.2.0 (72_02) release:
Note: For Introscope-enabling SAP IPC, please also check SAP Note 886600.
You will need to configure the host name or IP address and port of the machine where the
Enterprise Manager resides.
To configure the Introscope Agent:
1. Open the agent profile, e.g. file
<drive>:\usr\sap\ccms\wily\IntroscopeAgent.profile.
Enter either the host name or IP address of the machine where Enterprise Manager
resides.
3. Locate the property,
introscope.agent.enterprisemanager.transport.tcp.port.DEFAULT.
The value should be the port on which the Enterprise Manager listens for Agent
connections.
Default setting is 6001.
The instrumentation is split into several JAR packages. You can customize the list of
packages by modifying the property introscope.autoprobe.directivesFile. By default,
the following packages are active:
introscope.autoprobe.directivesFile=sap_typical.jar,sap_ep.jar,sap_xi_typic
al.jar,sap_ep_iviews.jar
This instrumentation covers standard SAP J2EE (e.g. Servlets, database/JDBC, JCO/RFC,
web services, user management, etc.), Portal, and XI functionality. There are additional
instrumentation sections which are not active by default. You can add entries to the
property, separated by comma:
By default, the Introscope agents write log files to the subdirectory logs of the agent
installation (e.g. /usr/sap/ccms/wily/logs). On Unix systems, make sure that the
monitored systems (user sidadm) have read and write access to this directory (write
permission for group sapsys). As an alternative, you can change the properties
introscope.autoprobe.logfile and log4j.appender.logfile.File to some other
directories where the monitored systems have write access.
2. Run the Create AutoProbe Connector tool using the following command:
• Make sure to specify exactly the JVM that is used for launching the J2EE node by
passing the JVM directory <java_home> on the command line:
Example:
Agent Name
You should assign a unique name to each SAP J2EE node that is Introscope-enabled. This
so-called agent name is assigned by an additional Java VM option (referred to as
<AgentName> below). SAP suggests the following naming convention for the agent name.
This is also generated by the automated setup via Solution Manager Diagnostics starting
with SP14:
<AgentName>=SID_Instance_Nodename
Where the placeholder mean the following:
Note: It is not necessary to integrate the host name into the agent name, since the host
name is assigned automatically to the agent.
Using a unique naming convention for all agent installations helps to group agents that
belong to the same installation together.
The procedure to add JVM options depends on the startup method for the J2EE nodes.
Check SAP Note 697062 for instructions to set JVM options for your specific startup
method. The following procedure is an example in case you use SAP J2EE startup
framework for J2EE 6.20:
1. Open the file:
<drive>:\usr\sap\<J2EE_ENGINE_ID>\j2ee\j2ee_<INSTANCE>\configtool\servi
ce.ini
-Xbootclasspath/p:<drive>:/usr/sap/ccms/wily/connectors/connector.jar;<
drive>:/usr/sap/ccms/wily/Agent.jar
-Dcom.wily.introscope.agentProfile=<drive>:/usr/sap/ccms/wily/Introscop
eAgent.profile
-Dcom.wily.introscope.agent.agentName=<AgentName>
Unix example:
-Xbootclasspath/p:/usr/sap/ccms/wily/connectors/connector.jar:/usr/sap/
ccms/wily/Agent.jar
-Dcom.wily.introscope.agentProfile=/usr/sap/ccms/wily/IntroscopeAgent.p
rofile
-Dcom.wily.introscope.agent.agentName=<AgentName>
3. In the Java Parameters field, add the following new java parameters (Windows
example):
-Xbootclasspath/p:<drive>:/usr/sap/ccms/wily/connectors/connector.jar;<
drive>:/usr/sap/ccms/wily/Agent.jar
-Dcom.wily.introscope.agentProfile=<drive>:/usr/sap/ccms/wily/Introscop
eAgent.profile
-Dcom.wily.introscope.agent.agentName=<AgentName>
Note: Note that for NetWeaver 6.40 on Windows, the slashes for these java
parameters must go forwards.
Unix example:
-Xbootclasspath/p:/usr/sap/ccms/wily/connectors/connector.jar:
/usr/sap/ccms/wily/Agent.jar
-Dcom.wily.introscope.agentProfile=/usr/sap/ccms/wily/IntroscopeAgent.p
rofile
-Dcom.wily.introscope.agent.agentName=<AgentName>
-Xbootclasspath/p:/QIBM/ProdData/Java400/jdk14/lib/instrumentation.jar:
/usr/sap/ccms/wily/Agent.jar
-agentlib:QJVAIAGENT=/usr/sap/ccms/wily/Agent.jar
-Dos400.jvmti.force.jitc
-Dcom.wily.introscope.agentProfile=/usr/sap/ccms/wily/IntroscopeAgent.p
rofile
-Dcom.wily.introscope.agent.agentName=<AgentName>
<drive>:\usr\sap\<SID>\<instance>\j2ee\cluster\instance.properties
For Netweaver 7.1 and up there are no node-specific Java VM parameters. For this reason,
the nodename part of the agent name must be calculated dynamically by using the variable
$[elem/Name]. At run time, this will be filled in with the node name. In the example below,
variables are also used for the SID and the instance name. They will be replaced
automatically if you use the string exactly as written below.
Name Value
com.wily.introscope.agent.agentName ${SYSTEM_NAME}_${INSTANCE_NAME}_$[elem/Name]
com.wily.introscope.agentProfile <drive>:/usr/sap/ccms/wily
/IntroscopeAgent.profile
Note that for NetWeaver on Windows, the slashes for these java parameters must go
forwards.
Unix example:
Instance/VM Parameters/System:
Name Value
com.wily.introscope.agent.agentName ${SYSTEM_NAME}_${INSTANCE_NAME}_$[elem/Name]
com.wily.introscope.agentProfile /usr/sap/ccms/wily/IntroscopeAgent.profile
Instance/VM Parameters/Additional:
Name
-javaagent:/usr/sap/ccms/wily/Agent.jar
<drive>:\usr\sap\<SID>\<instance>\j2ee\cluster\instance.properties
The procedure to add JVM options for the IPC to enable Introscope is described in SAP Note
886600. Note that Introscope does not support IPC running in the VM container (VMC) as
it is delivered for SAP CRM 5.0.
The procedure to add JVM options for IBM WebSphere Application Server to enable
Introscope is described in SAP Note 1418638.
The procedure to add JVM options for Tomcat Server to enable Introscope is described in
SAP Note 1438005.
EXAMPLE
The last few lines of the agent log file should similar to the following:
12/06/06 01:41:46 PM PST [INFO] [IntroscopeAgent.IsengardServerConnectionManager]
Connected Agent to the Introscope Enterprise Manager at
localhost:6001,com.wily.isengard.postofficehub.link.net.DefaultSocketFactory. Host =
"emhost", Process = "SAP Netweaver", Agent Name = "xxx_server0".
You should get a login prompt as shown below. Use login credentials from the table in
Chapter 1 to authenticate. As an alternative, you can also launch a Workstation that
you explicitly installed or WebView (http://emhost:8081/webview).
Open the Investigator (Workstation menu New Investigator) to display a tree of all
connected hosts and agents. Click the plus signs to open subtrees. For each connected
agent, you should find a subtree host SAP Netweaver AgentName in the
Investigator that looks similar to the screenshot below. Depending on the type of the
managed system, some tree nodes may be missing.
Please check the following:
If your managed system is running SAP J2EE, you should at least have SAP
J2EE.
CPU is only available on some Windows, Solaris, and Linux platforms, so this
may indeed be missing.
Some nodes will only appear after first use. For example, Servlets will only
appear after the first servlet has been executed.
5 Workstation Installation
If you decide to explicitly install the Introscope Workstation on Client PCs, proceed as
described in this section. Note that the workstation can always be downloaded on demand
from the Enterprise Manager using Java WebStart, as described in Chapter 1.
Installers are available for the following platforms:
Windows 32bit
Windows x86_64
Linux IA32
Linux x86_64
The installation is described here for Windows. If you want to install it on Linux, remember
to set the DISPLAY before launching the installer.
1. Extract the downloaded Workstation installer:
sapcar –xvf SAPISWS*.SAR
2. Copy the two files that you downloaded from CA Wily’s FTP server to the directory
which contains the installer (see Chapter 1, Download Third-Party External Component
Package from CA Wily). These are the same files that were used for the Enterprise
Manager installation. The following files should be copied:
a. eula.txt
b. The osgiPackages archive appropriate for your system:
b. (installation with wizard) Select a target installation directory of your choice. Keep
No for Configure VM Settings and enter the host name of the Enterprise Manager in
the field Workstation Default Host. Finally, click Install to launch the installation.
6 Environment Performance
Agent (De)Installation
Note: Starting with SP13 of Solution Manager Diagnostics (LMSERVICE13_0), the
Introscope HostAgent takes over the role of the former EPAgent. The HostAgent is part of
the SMDAgent process and centrally administered via the SMD. Please remove any existing
manual EPAgent installations from the monitored systems.
2. Unix only: Search for the Java process hosting the EPAgent and kill the process.
3. Remove the complete installation directory of the EPAgent.
7 Additional Installation
Options
This chapter covers additional customizing steps of the Introscope Installation:
• Changing the Agent port from 6001 to other values
• Uninstalling Introscope
• Setting up domains
• User Management
• Enable Single Sign On from Solution Manager
• Enterprise Manager Cluster Setup
Uninstalling Introscope
Uninstalling Introscope Agents
5. Remove the Java VM options for Introscope from the J2EE nodes that you instrumented
before. The following options should be removed:
a. -Xbootclasspath/p: <some path>/wily/connectors/connector.jar: <some
path>/wily/Agent.jar (Java 1.3, 1.4 only)
b. -Dcom.wily.introscope.agentProfile=<some
path>/wily/IntroscopeAgent.profile
c. -Dcom.wily.introscope.agent.agentName=<AgentName>
d. -javaagent:<some path>/wily/Agent.jar (Java 5 only)
6. Use SDM to undeploy the JmxService helper application (com.wilytech.jmxservice)
in case it is still present from previous Introscope versions.
7. Restart the affected J2EE instances for the changes to become effective.
8. Delete the directory <some path>/wily (or wherever you put the agent files).
Note that the SuperDomain must always be the last entry in the domains file.
Note that currently the Introscope Host Agent and the Netweaver agent for some system
must always be in the same domain. If the Host Agent remains in the SuperDomain and
Netweaver agents are moved to some custom domain, the SAP GC metrics will be missing
in the Netweaver agent.
User Management
User accounts must be maintained in the file users.xml, located in the subdirectory
config/ of the Enterprise Manager. Permissions are controlled by the file domains.xml in
the same directory. To create a new user X with password Y, proceed as follows:
1. Generate the MD5-encoded password by the script MD5Encoder:
MD5Encoder Y
Y:57cec4137b614c87cb4e24a3d03a3e0
2. Add a new line to users.xml before the final </users> line, using the generated
password string (the part after :) as password:
<user name="X" password="57cec4137b614c87cb4e24a3d03a3e0" />
3. Add permissions for the user to the Superdomain in the domains.xml file:
<grant user="X" permission="read" />
<grant user="X" permission="run_tracer" />
<grant user="X" permission="historical_agent_control" />
<grant user="X" permission="live_agent_control" />
Note: If you do not have a full license for Introscope, you cannot use permission=”full” or
“write“ here!
additional EM acts as “Manager of Managers” (MoM). Only the MoM accepts Workstation
and Solution Manager connections, whereas the other EMs in the cluster act as “Collectors”.
Only collectors accept agent connections. To configure an EM cluster, proceed as follows:
1. Make sure the prerequisites are met:
a. Strict clock synchronization between all involved hosts (e.g. via NTP).
b. Fast LAN connection between all EMs
2. Configure the collector EMs. In config/IntroscopeEnterpriseManager.properties, set
introscope.enterprisemanager.clustering.collector.enable=true