CA - Introscope
CA - Introscope
7
Installation Guide
For SAP
October 2015
Contents
Contents .................................................................................................................................................2
1 Installation Overview......................................................................................................................3
Introscope Overview ...................................................................................................................3
Reviewing the Installation and Configuration Process ...............................................................3
Obtain the Latest File Versions...................................................................................................5
2 Upgrading from Previous Versions to Introscope 9.7 ....................................................................7
Version Compatibility and Upgrade Sequence ...........................................................................7
Enterprise Manager Upgrade ......................................................................................................7
Agent Upgrade ............................................................................................................................7
3 Installing the Introscope Enterprise Manager .................................................................................9
Installation User ..........................................................................................................................9
Choose the Enterprise Manager Installer File.............................................................................9
Platform Independent Introscope Installer ................................................................................10
Enterprise Manager Installation ................................................................................................10
Check that Introscope is Running Properly ..............................................................................15
4 Introscope-Enabling SAP J2EE Systems......................................................................................16
5 Workstation Installation................................................................................................................27
6 Additional Installation Options.....................................................................................................29
Change the Agent Port ..............................................................................................................29
Uninstalling Introscope .............................................................................................................29
Setting up Introscope Domains .................................................................................................30
User Management .....................................................................................................................31
Enable Single Sign On from Solution Manager .......................................................................33
Enterprise Manager Cluster Setup ............................................................................................34
Page
2
1 Installation Overview
This document covers the installation and configuration of Introscope in the context of SAP
products in the following chapters:
Installation Overview
Upgrading previous versions to Introscope 9.7
Installing Introscope Enterprise Manager
Introscope-enabling SAP J2EE Systems (Agent Installation)
Optional: Installing Introscope Workstation
Optional Additional Installation Options
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.
This guide focuses on the SAP-specific aspects of Introscope. For a full overview on
Introscope please check the official product documentation provided by CA:
https://wiki.ca.com/display/APMDEVOPS97/CA+Application+Performance+Management .
Note, however, that not that not all features described in the CA documentation will
be available to SAP customers as part of the RTV delivery.
The Right to View (RTV) version of CA Introscope is a restricted, read-only form of the full
product and is bundled w ith SAP Solution Manager. With the RTV version, support is limited
to products that are licensed and supported by SAP. The instrumentation, dashboa rds,
Probe Builder Directives (PBDs), management modules, and Smartstor data contained
within the RTV version of CA 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 from SAP.
Please see SAP Note 1280961.
Page
3
Page
4
Introscope Access
After installation, you can use the following default credentials to access Introscope:
User
Password
Access Rights
Admin
Admin89
read, run_tracer
Guest
guest12
read
Note that the credentials are case-sensitive. Furthermore, you can add
live_agent_control and historical_agent_control permissions to the Admin user if
you want. Please refer to the user management section in Chapter 6 for details.
Page
5
eula.txt
Save the files in the same directory as the Introscope installer executable. The installer will
then automatically locate this file during the installation process.
Page
6
This chapter explains the options to upgrade an Introscope installation to Introscope 9.7. If
you are performing a fresh installation, please proceed to the next chapter.
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 res tart the
managed systems after any configuration change.
Page
7
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.
Note: Introscope Java Agents 9.x only support Java5 and newer.
Page
8
To install the Introscope Enterprise Manager you will run the installer file and add some
SAP customization (management modules, scripts, etc.).
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. For Solution
Manager 7.1 please review the installation master guide: A Diagnostics Agent must be
installed on the host of the Enterprise Manager and it must have write access to the EM
installation.
Operating System
Installer Filename
AIX 32bit
AIX 64bit
introscope9.7.1.16aixSAP.bin
introscope9.7.1.16aix64SAP.bin
introscope9.7.1.16linuxSAP.bin
introscope9.7.1.16linuxAMD64SAP.bin
introscope9.7.1.16solarisSAP.bin
Windows IA32
introscope9.7.1.16windowsSAP.exe
introscope9.7.1.16windowsAMD64SAP.exe
Page
9
Operating System
http://www.ibm.com/developerworks/java/jdk/linux/do
wnload.html, select 64-bit IBM POWER in column
J2SE 7.0
http://www.ibm.com/developerworks/java/jdk/linux/do
wnload.html, select 64-bit System z in column
J2SE 7.0
http://www.oracle.com/technetwork/java/javase/down
loads/index.html, click on JDK Download in section
Java SE 7 Update <xx>, select Solaris x64
Platform
Page
10
Note: The Installation Directory must not contain blanks in the path.
Alternative 1: Set the Installation Directory via Command Line Option
1.
Open a command prompt and go to the directory where the installer file and the file
installer.properties are located.
introscope9.7.1.16windowsSAP.exe
DUSER_INSTALL_DIR=d:\\usr\\sap\\ccms\apmintroscope\\
Note: The instructions in this guide will use examples relative to the default
installation directory.
eula.txt
Page
11
introscope9.7.1.16windowsSAP.exe
For any other platform-dependent installer, use the command in the following
example. You may have to set the right permission before you can launch the
installation:
./introscope9.7.1.16linuxAMD64SAP.bin Djava.awt.headless=true
Page
12
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\apmintroscope (Windows)
/usr/sap/ccms/apmintroscope (Unix)
OR the location you specified.
2. Open the file,
/usr/sap/ccms/apmintroscope/install/Introscope_<version>_InstallLog.log
3. Verify that the following lines appear in the file:
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.
Increase the heap size (Xmx) of the Enterprise Manager if you have more than
~10 agents.
Enter the absolute path to a Java 7 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:
Page
13
Solaris on SPARC
Enter the path of a separately installed Java 6 VM for platforms where you
used the platform independent installer.
More details:
http://wiki.scn.sap.com/wiki/display/TechOps/Introscope+Troubleshooting#Intro
scopeTroubleshooting-RecommendedJavaVMparametersforEnterpriseManager.
Page
14
./EMCtrl.sh start
The shell script launches the Enterprise Manager in background mode (via nohup) . It is not
necessary to explicitly use nohup for EMCtrl.sh.
Consider launching the Enterprise Manager automatically at system startup. Typically, you
will have to hook it into one of the operating system specific init scripts.
<EM_Home>/logs/IntroscopeEnterpriseManager.log.
2. Check that the Enterprise Manager has started. Look for the following line in the
logfile:
Page
15
After you have installed the Enterprise Manager, you are ready to install and configure the
Introscope agent and Introscope-enable your Java applications.
Note:
Page
16
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 Configure Introscope Agent Setup .
This will open the setup dialog as shown below. The agent version is pre-selected and
you can choose the profile.
8. Next, check the desired instrumentation with clicking on button Autoprobe Directives.
Solution Manager flags the instrumentation files according to the available software on
the managed system.
NOTE: What you see here is NOT the current effective instrumentation but the
proposed instrumentation that is applied with the setup run.
9. Finally, hit Apply to perform the necessary changes in the agent configuration. Agent
config files will be adapted and the Java VM parameters will be set as required for the
managed system.
Page
17
Page
18
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. Introscope-enable the application code by setting Java VM parameters
Page
19
File Name
Applications Covered
IntroscopeAgent.profile
IntroscopeAgent_tomcat.profile
IntroscopeAgent_websphere.profile
IntroscopeAgent_weblogic.profile
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\core\config\IntroscopeAgent.profile.
2. Locate the property,
introscope.agent.enterprisemanager.transport.tcp.host.DEFAULT .
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.
4. Save changes to the agent profile.
Page
20
sap_typical.jar
sap_sapvm.jar
sap_bo_enterprise.jar
sap_boe_webapp.jar
sap_ep.jar
sap_ep_iviews.jar
sap_ep_iviews_rolename.jar
sap_duet.jar
sap_hybris.jar
Sap_smp.jar
sap_xi_typical.jar
sap_xi_adapters
sap_xi_full.jar
sap_smd.jar
sap_mdm.jar
sap_compliance.jar
sap_epm.jar
sap_retail.jar
sap_srm_crm.jar
Page
21
sap_websphere_full.jar
sap_weblogic_typical.jar
sap_cem_integration.jar
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:
<AgentName>=SID_Instance_Nodename
Page
22
Placeholder
Explanation
Examples
SID
SystemID
Instance
Nodename
server0, server1,
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.
Value
com.wily.introscope.agent.agentName
com.wily.introscope.agentProfile
${SYSTEM_NAME}_${INSTANCE_NAME}_$[elem/Name]
<drive>:/usr/sap/ccms/wily/core/config/
IntroscopeAgent.profile
Page
23
Note that for NetWeaver on Windows, the slashes for these java parameters must go
forwards.
Unix example:
Instance/VM Parameters/System:
Name
com.wily.introscope.agent.agentName
com.wily.introscope.agentProfile
Value
${SYSTEM_NAME}_${INSTANCE_NAME}_$[elem/Name]
/usr/sap/ccms/wily/core/config/
IntroscopeAgent.profile
Instance/VM Parameters/Additional:
Name
-javaagent:/usr/sap/ccms/wily/ Agent.jar
Page
24
Page
25
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.
Page
26
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 32bit
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 from file WILYWORK*.zip.
2. Copy the two files that you downloaded from CAs FTP server t o the directory which
contains the installer (see Chapter 1, Download Third-Pa rty Exte rna l Component
Package from CA). 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:
i.
ii.
3. Launch the installer. If you keep the file installer.properties in the directory where
you launch the installer, the installation will proceed silently.
Alternatively, remove the file installer.properties. Then you will be guided
through the installation by a wizard.
a. (Silent installation) By default, the installation will be placed in the folder
c:\usr\sap\ccms\apmintroscope. If desired, pass a different target directory as a
command line parameter:
introscopeWorkstation9.7.1.16windowsSAP.exe
DUSER_INSTALL_DIR=d:/usr/sap/some/dir
b. (installation with wizard) Select a target installation directory of your choice. Keep
No for Conf igure VM Settings and enter the host name of the Enterprise Manager in
the field Workstation Default Host . Finally, click Install to launch the installation.
4. Launch the Workstation:
Page
27
Page
28
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
1. Remove the Java VM options for Introscope from the J2EE nodes that you instrumented
before. The following options should be removed:
a. -javaagent:<some path>/wily/Agent.jar
b. -Dcom.wily.introscope.agentProfile=<some
path>/wily/core/config/IntroscopeAgent.profile
c. -Dcom.wily.introscope.agent.agentName=<AgentName>
2. Restart the affected J2EE instances for the changes to become effec tive.
3. Delete the directory <some path>/wily (or wherever you put the agent files).
Page
29
Page
30
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 tools/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="57cec4137b614c87c b4e24a3d03a3e0 " />
3.
Add permissions for the user to the Superdomain in the domains.xml file:
<grant
<grant
<grant
<grant
user="X"
user="X"
user="X"
user="X"
permission="read" />
permission="run_tracer" />
permission="historical_a gent_control" />
permission="live_age nt_control" />
Note:
If there are any syntax or other errors in the domains.xml file, the Enterprise
Manager does not start
Available Permissions
read
Users or groups can view all agents and business logic in the domain.
This permission includes tasks such as:
Viewing Investigator tree (which shows agents in the domain user has access to)
Viewing metric and element data in the Investigator Preview pane, including default
Top N Filtered Views for certain resources in the Investigator tree
Page
31
Refreshing historical data in a historical Data Viewer, and zoom in and out
Note: Users or groups with read permission are able to see all commands in the
Workstation. However, the commands that they do not have acce ss to are disabled.
write
A user or group with write permission can do everything permitted by read permission can,
and can also:
create and edit dashboards (Please see SAP Note 1280961 about SED.)
edit all monitoring logic in a domain (Please see SAP Note 1280961 about SED.)
run_tracer
Users or groups can start a Transaction Trace session for an agent.
Note: This permission also requires the assignment of read permission.
historical_agent_control
Users or groups can mount and unmount agent/s.
Note: This permission also requires the assignment of read permission.
live_agent_control
Users or groups can shut off reporting for metrics, resources, and agents within a domain
Note: This permission also requires the assignment of read permission.
dynamic_instrumentation
User or group can perform dynamic instrumentation.
Page
32
thread_dump
User or group can see and use the Thread Dumps tab.
For information about using and configuring thread dumps, see the Introscope Workstation
Guide and the Introscope Java Agent Guide.
Note: This permission must include an underscore "_" between "thread" and "dump".
full
Users or groups have all possible permissions for the domain.
Note: If you do not have a f ull license for Introscope, you cannot use permission=full or
write here! Please see SAP Note 1280961 about SED.
Page
33
MOM:
CDV:
Enterprise Manager runs as a Cross-Cluster Data Viewer (not
supported by Solution Manager)
Cluster Tuning
After setting up the cluster tuning should be done according to
http://wiki.scn.sap.com/wiki/display/TechOps/Performance+Tuning+for+EM+cluster.
Page
34