ibm performance management (saas): beta documentation · chapter 1. product overview ibm®...

136
IBM Performance Management (SaaS) BETA Documentation

Upload: others

Post on 07-Jan-2020

11 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

IBM Performance Management (SaaS)

BETA Documentation

���

Page 2: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance
Page 3: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

IBM Performance Management (SaaS)

BETA Documentation

���

Page 4: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

NoteBefore using this information and the product it supports, read the information in “Notices” on page 125.

This edition applies to version 1, release 1 of IBM Performance Management (SaaS) (product number 5725-M99) andto all subsequent releases and modifications until otherwise indicated in new editions.

© Copyright IBM Corporation 2014.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Page 5: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Contents

Chapter 1. Product overview . . . . . . 1What's new . . . . . . . . . . . . . . . 4

Chapter 2. Installing and configuring . . 7System requirements. . . . . . . . . . . . 7Dependencies . . . . . . . . . . . . . . 7Installing monitoring agents on AIX systems . . . 9Installing monitoring agents on Linux systems . . 10Installing monitoring agents on Windows systems 14Configuring your monitoring agents . . . . . . 16

Configuring the Linux KVM agent . . . . . 16Configuring the Microsoft .NET agent . . . . 23Configuring the MongoDB agent . . . . . . 29Configuring the MySQL agent . . . . . . . 30Configuring the Node.js agent . . . . . . . 31Configuring the PHP agent . . . . . . . . 34Configuring the PostgreSQL agent . . . . . . 35Configuring the Python agent . . . . . . . 37Configuring the Response Time Monitoring agent 39Configuring the Ruby agent . . . . . . . . 42Configuring the Tomcat agent . . . . . . . 45Configuring the WebSphere Applications agent 47

Configuring agents to communicate through aforward proxy . . . . . . . . . . . . . 78Integrating with other products. . . . . . . . 79

Configuring integration with IBM SmartCloudControl Desk . . . . . . . . . . . . . 79Installing the Integration Agent forNetcool/OMNIbus . . . . . . . . . . . 80

Upgrading monitoring agents . . . . . . . . 84WebSphere Applications agent: Migrating thedata collector . . . . . . . . . . . . . 85

Uninstalling monitoring agents . . . . . . . . 90WebSphere Applications agent: Unconfiguringthe data collector . . . . . . . . . . . 91Node.js agent: Removing the monitoring plug-in 95Microsoft .NET agent: Removing the .NET datacollector . . . . . . . . . . . . . . 96

Chapter 3. Administering . . . . . . . 97Starting the Performance Management console . . 97Data sources . . . . . . . . . . . . . . 97Managing applications. . . . . . . . . . . 98Entering agent commands . . . . . . . . . 100

Enabling diagnostics and method trace data forWebSphere servers . . . . . . . . . . . 102Enabling diagnostics data for Ruby on Railsapplications . . . . . . . . . . . . . . 103Enabling Transaction Tracking . . . . . . . . 104Advanced Configuration . . . . . . . . . 104

Chapter 4. Agent reference . . . . . 107

Chapter 5. Troubleshooting . . . . . 109Installation troubleshooting. . . . . . . . . 109

Agent installation fails . . . . . . . . . 109Uninstallation of monitoring agents fail. . . . 110

Agent troubleshooting . . . . . . . . . . 110Linux KVM agent: Errors with the agent content 110Linux KVM agent: Errors with the KVMHypervisor installation on UNIX . . . . . . 111Linux KVM agent: Errors with negative values 113Linux KVM agent: An oVirt API error in theRHEVM environment. . . . . . . . . . 113PHP agent: Dashboard widget data does notupdate. . . . . . . . . . . . . . . 113Ruby agent: Instance not discovered . . . . . 114WebSphere Applications agent: WebSphereLiberty server does not start after it isconfigured with the data collector . . . . . 114Tomcat agent: Tomcat server not monitored . . 114Microsoft .NET agent: Dashboards do notupdate or display data . . . . . . . . . 115

Getting Started links blocked in Chrome . . . . 116Dashboards show no data, partial data, or incorrectdata from the monitoring agent . . . . . . . 117Dashboard shows no events or event status . . . 118Threshold events have unknown severity afteragent recycle . . . . . . . . . . . . . 118Thresholds are not applied to the monitoring agent 118Changed language but some text is still in English 119Locale support . . . . . . . . . . . . . 119Collecting monitoring agent logs for IBM Support 120

Accessibility . . . . . . . . . . . . 123

Notices . . . . . . . . . . . . . . 125

© Copyright IBM Corp. 2014 iii

Page 6: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

iv IBM Performance Management (SaaS): BETA Documentation

Page 7: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Chapter 1. Product overview

IBM® Performance Management (SaaS) is a comprehensive solution that helpsmanage the performance and availability for complex applications that might berunning in a data center, public cloud, or hybrid combination. This solutionprovides you with visibility of your applications, ensuring optimal performanceand efficient use of resources. The required infrastructure is installed and managedby IBM, reducing your time-to-value and providing you with low-maintenanceownership. You select and install the agents for the applications you want tomonitor, and then you view dashboards and create thresholds to proactivelymanage the health of your environment.

Installation of your agents is done in minutes, and you can immediately log on tothe Performance Management console to see the Application PerformanceDashboard for a status check of your managed systems. The ApplicationDashboard navigator is hierarchical, giving a status overview of your applicationsand the health of their components and the experience of their end users. For moredetails about your monitored resource, you can click a navigator item or a link inthe Status Overview tab.

Consider, for example, that your application has slow response time. The issue isrevealed in the dashboard. Starting from your dashboard, you can follow theproblem to the source by clicking links to discover the cause: high CPU utilizationon a system due to an out-of-control process.

There are three service subscription levels available with IBM PerformanceManagement (SaaS):

IBM Application Performance Management (SaaS)This service subscription provides the following agents:v Monitoring Agent for Linux OSv Monitoring Agent for Linux KVMv Monitoring Agent for MongoDBv Monitoring Agent for MySQLv Monitoring Agent for Microsoft .NETv Monitoring Agent for Node.jsv Monitoring Agent for PHPv Monitoring Agent for PostgreSQLv Monitoring Agent for Pythonv Monitoring Agent for Rubyv Monitoring Agent for Tomcatv Monitoring Agent for WebSphere® Applicationsv Monitoring Agent for Windows OSv Response Time Monitoring Agent

IBM Monitoring (SaaS)This service subscription provides the following agents:v Monitoring Agent for Linux OSv Monitoring Agent for Linux KVMv Monitoring Agent for MongoDB

© Copyright IBM Corp. 2014 1

Page 8: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

v Monitoring Agent for MySQLv Monitoring Agent for Node.jsv Monitoring Agent for PHPv Monitoring Agent for PostgreSQLv Monitoring Agent for Pythonv Monitoring Agent for Rubyv Monitoring Agent for Tomcatv Monitoring Agent for WebSphere Applicationsv Monitoring Agent for Windows OSv Response Time Monitoring Agent

IBM Application Diagnostics (SaaS)This service subscription provides the following agents:v Monitoring Agent for Linux OSv Monitoring Agent for Microsoft .NETv Monitoring Agent for Rubyv Monitoring Agent for WebSphere Applicationsv Monitoring Agent for Windows OS

The following table provides an overview of the capabilities provided in eachagent in each service subscription level:

Table 1. Agent capability provided in each service subscription level.Agent capability provided in each service subscription level, where italics indicate the agent does not provide thecapability, and a check mark indicates the agent does supply the capability.

Capabilities Monitoring (SaaS) ApplicationPerformanceManagement (SaaS)

ApplicationDiagnostics (SaaS)

Resource monitoringLinux OS

Linux KVM

MongoDB

MySQL

Node.js

PHP

PostgreSQL

Python

Ruby

Tomcat

WebSphere Applications

Windows OS

Response TimeMonitoring

Linux OS

Linux KVM

MongoDB

MySQL

Microsoft .NET

Node.js

PHP

PostgreSQL

Python

Ruby

Tomcat

WebSphere Applications

Windows OS

Response TimeMonitoring

Linux OS

Microsoft .NET

Ruby

WebSphere Applications

Windows OS

2 IBM Performance Management (SaaS): BETA Documentation

Page 9: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Table 1. Agent capability provided in each service subscription level (continued).Agent capability provided in each service subscription level, where italics indicate the agent does not provide thecapability, and a check mark indicates the agent does supply the capability.

Capabilities Monitoring (SaaS) ApplicationPerformanceManagement (SaaS)

ApplicationDiagnostics (SaaS)

Transaction Tracking Linux OS

Linux KVM

MongoDB

MySQL

Node.js

PHP

PostgreSQL

Python

Ruby

Tomcat

WebSphere Applications

Windows OS

Response Time Monitoring

Linux OS

Linux KVM

MongoDB

MySQL

Microsoft .NET

Node.js

PHP

PostgreSQL

Python

Ruby

Tomcat

WebSphere Applications

Windows OS

Response TimeMonitoring

Linux OS

Microsoft .NET

Ruby

WebSphere Applications

Windows OS

Diagnostics Linux OS

Linux KVM

MongoDB

MySQL

Node.js

PHP

PostgreSQL

Python

Ruby

Tomcat

WebSphere Applications

Windows OS

Response Time Monitoring

Linux OS

Linux KVM

MongoDB

MySQL

Microsoft .NET

Node.js

PHP

PostgreSQL

Python

Ruby

Tomcat

WebSphere Applications

Windows OS

Response Time Monitoring

Linux OS

Microsoft .NET

Ruby

WebSphere Applications

Windows OS

In addition to the monitoring agents available in each service subscription, you canalso install the following agents:v Monitoring Agent for UNIX OS for AIX monitoringv Monitoring Agent for Windows OS for 32-bit Windows Server monitoring

The following additional package is available from IBM Service Engage(http://ibmserviceengage.com):

IBM Performance Management (SaaS) IntegrationYou can forward your events from Performance Management (SaaS) intoyour on-premises Netcool/OMNIbus event manager. For more information,see “Installing the Integration Agent for Netcool/OMNIbus” on page 80.

Chapter 1. Product overview 3

Page 10: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Visit IBM Service Management Connect to get usage tips and insightfulinformation from subject matter experts, ask questions on the forum, and see videodemonstrations: IBM Service Management Connect > Application PerformanceManagement (https://www.ibm.com/developerworks/servicemanagement/apm).

What's newThe following new features, capability, offerings, and coverage are available:

Coverage of new agentsThe following agents are now available:v Monitoring Agent for Linux KVMv Monitoring Agent for Microsoft .NETv Monitoring Agent for Node.jsv Monitoring Agent for Tomcatv Monitoring Agent for UNIX OS

Your service subscription level determines which monitoring agents areavailable for installation. For a list of the agents included in each servicesubscription level, see Chapter 1, “Product overview,” on page 1.

Deep-dive diagnostics of Ruby on Rails applicationsDeep-dive diagnostics is only available in the IBM Application Diagnostics(SaaS) service subscription.

Updated End User Transaction capability

You can now identify the poorest performing transactions in anapplication, including AJAX requests. Also view the actual response timesexperienced by the end user, and total times from the client and server

Figure 1. Performance Management (SaaS) concept diagram. In this conceptual diagram, the flexibility of PerformanceManagement (SaaS) is illustrated for your reference.

4 IBM Performance Management (SaaS): BETA Documentation

Page 11: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

perspective by using the new JavaScript Injection monitoring methodavailable in this release. Drill down to transaction instances and topologies.

Inclusion of transaction instances and topologies

You can now isolate bottlenecks in web front ends, WebSphere ApplicationServers and .NET applications by drilling down to a transaction instanceand its topology. If you have IBM Application Diagnostics (SaaS) servicesubscription, for WebSphere Application Servers and .NET applicationsyou can link from the topology to diagnostics dashboards in order topinpoint problems using a method and stack trace.

Integration with IBM Netcool/OMNIbusYou can forward your events from Performance Management (SaaS) intoyour on-premises Netcool/OMNIbus event manager. For more information,see “Installing the Integration Agent for Netcool/OMNIbus” on page 80.

Integration with IBM SmartCloud Control DeskYou can configure your events from Performance Management (SaaS) toautomatically open tickets in IBM SmartCloud Control Desk. For moreinformation, see “Configuring integration with IBM SmartCloud ControlDesk” on page 79.

Chapter 1. Product overview 5

Page 12: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

6 IBM Performance Management (SaaS): BETA Documentation

Page 13: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Chapter 2. Installing and configuring

The IBM Performance Management (SaaS) infrastructure is installed and managedby IBM. To monitor your applications, you select and install the monitoring agentsfor the applications you want to monitor.

System requirementsFor the IBM Performance Management (SaaS) agents, various operating systemsare supported and each agent has specific requirements.

Obtain information about the hardware and software requirements for each agentthat you plan to install.

For information about the requirements for IBM Performance Management (SaaS)agents, see the System requirements section in the IBM Performance Management(SaaS) wiki.

You can also use the Software product compatibility reports website to generate avariety of types of reports related to product requirements. Search for the “Agentcomponent for IBM Performance Management” product name.

Browser support

For up-to-date information about supported browsers, review the FAQ section inthe IBM Performance Management (SaaS) wiki.

DependenciesReview the dependencies to ensure a successful installation.

Time zone

Use NTP (Network Time Protocol) on managed systems to ensure that the time isaccurate. The time zone must be set correctly for the time zone that the system isin, such as UTC-03:00 for Brasilia and UTC +06:30 for Yangon.

Linux dependencies

RPM dependenciesThe monitoring agents use Red Hat Package Manager (RPM) files to installthe software. Without the required libraries and other software, theprerequisite scanner fails and displays a failure explanation, such as:Expected Property Result Foundregex(libstdc++.so.6 os.lib.libstdc++_32 FAIL Unavailable

A Red Hat Enterprise Linux client that is correctly configured to use theyum (Yellowdog Updater, Modified) package manager can resolve andinstall any missing dependencies that are required by the RPMs. For moreinformation on yum commands, see What is yum? How do I use it?(https://access.redhat.com/site/solutions/9934).

Tips for resolving unmet dependenciesWhen the prerequisite scanner returns errors because of failed

© Copyright IBM Corp. 2014 7

Page 14: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

dependencies, you can run the yum provides feature_name command tolearn what is required, and the yum install feature_name command toinstall the missing dependency.

For example:

Error The prerequisite scanner shows the following failure message:error: Failed dependencies:libstdc++.so.6 is needed by...

Command “yum provides”Enter the following command:yum provides libstdc++.so.6

The following report is displayed:libstdc++-4.4.7-3.el6.i686 : GNU Standard C++ LibraryRepo : installedMatched from:Other : Provides-match: libstdc++.so.6

Command “yum install”Enter the following command to satisfy the missing feature:yum install libstdc++-4.4.7-3.el6.i686

Table 2. Sample error messages for failed dependencies on Linux and the possibleresolution RPM

Error message Possible resolution

error: Failed dependencies:libstdc++.so.6 is needed by...

rpm -Uhv libstdc++-4.4.6-4.el6.i686.rpm

error: Failed dependencies:libgcc_s.so.1 is needed by

libstdc++-4.4.6-4.el6.i686libgcc_s.so.1(GCC_3.0) is

needed by libstdc++-4.4.6-4.el6.i686libgcc_s.so.1(GCC_3.3) is

needed by libstdc++-4.4.6-4.el6.i686libgcc_s.so.1(GCC_4.2.0) is

needed by libstdc++-4.4.6-4.el6.i686libgcc_s.so.1(GLIBC_2.0) is

needed by libstdc++-4.4.6-4.el6.i686

rpm -Uhv libgcc-4.4.6-4.el6.i686.rpm

error: Failed dependencies:compat-libstdc++-33(i686) is neededby...

rpm -Uhv compat-libstdc++-33-3.2-69.el6.i686.rpm

Installation RPMs for reference

The following RPMs are automatically installed during agent installationon Linux operating systems. You might see the RPM name displayed in thecommand line interface during installation. The following table is providedfor your reference.

Note: The RPM file names might change slightly as new updates becomeavailable.

8 IBM Performance Management (SaaS): BETA Documentation

Page 15: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Table 3. RPMs that are automatically installed during agent installation on Linux operatingsystems

RPM Description

smai-framework-jre-07.06.00.00-1.el6.x86_64.rpm

Java™ runtime environment requires KSHand is required by the monitoring agentframework

smai-framework-core-06.35.03.00-1.el6.x86_64.rpm

Monitoring agent framework

smai-linux_kvm-07.21.00.00-1.el6.noarch.rpm

Monitoring Agent for Linux KVM

smai-os-06.30.02.25-1.el6.x86_64.rpm Monitoring Agent for Linux OS

smai-mongodb-01.00.03.00-1.el6.noarch.rpm

Monitoring Agent for MongoDB

smai-mysql-01.00.03.00-1.el6.noarch.rpm Monitoring Agent for MySQL

smai-nodejs-01.00.03.00-1.el6.noarch.rpm Monitoring Agent for Node.js

smai-php-01.00.02.00-1.el6.noarch.rpm Monitoring Agent for PHP

smai-postgresql-01.00.02.00-1.el6.noarch.rpm

Monitoring Agent for PostgreSQL

smai-python-01.00.02.00-1.el6.noarch.rpm Monitoring Agent for Python

smai-ruby-01.00.03.00-1.el6.noarch.rpm Monitoring Agent for Ruby

smai-tomcat-06.40.00.09-1.el6.noarch.rpm Monitoring Agent for Tomcat

smai-apd-was-07.30.03.00-1.el6.x86_64.rpm

Monitoring Agent for WebSphereApplications

smai-response_time-07.40.00.10-1.el6.x86_64.rpm

Response Time Monitoring Agent

smai-omnibus-01.00.00.00-1.el6.x86_64.rpm

Integration Agent for Netcool/OMNIbus

Installing monitoring agents on AIX systemsTo install a monitoring agent, you must download an archive file from the IBMService Engage website, extract the agent installation files, and then start theinstallation script.

You can install the following monitoring agents that run on AIX operating systems:v Monitoring Agent for UNIX OS

Before you begin

All monitoring agent communication requires outbound communication over httpsusing port 443. You do not need special firewall ports to use your service. If youragents do not have direct access to the internet, you can use forward proxies. Formore information, see “Configuring agents to communicate through a forwardproxy” on page 78.

Restriction: The UNIX OS agent cannot be installed in a directory where otheragents that use Java are also installed.

Chapter 2. Installing and configuring 9

Page 16: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

About this task

Complete these steps to install the monitoring agent on LPARs and systems whereAIX is installed.

Procedure1. To download the installation archive file, log in to My Services

(http://my.ibmserviceengage.com) from the IBM Service Engage website.Click Downloads to display the available packages for download. ClickDownload Agent under the AIX package. Save the file to a staging directory ofyour choosing.The agents must be installed on the system where the application is installed. Ifneeded, transfer the installation archive file to the system to be monitored. Thearchive file contains the agents and installation script.

2. Open a terminal shell session on the AIX system.3. Navigate to the directory where the archive file is located.4. Extract the installation files with the following command:

v For IBM Performance Management (SaaS) Agents for AIX Servers:tar -xf ./IPMaaS_Agents_AIX_version.tar

Where version is the specific version of your archive file.The installation script is extracted to a directory named for the archive file andversion. For example: IPMaaS_Agent_Install_1.2.3. Agent binary andconfiguration-related files are extracted into subdirectories within that directory.

5. Run the installation script with root user privileges from the directory namedfor the archive file and version:./installAPMaaSAgents.sh

You are prompted to install the agent.A prerequisite scan of your environment starts and takes a few moments tocomplete. If any requirements are missing, a message directs you to a log filewith the reason for the failure. A prerequisite, such as a missing library orinsufficient disk space, stops the installation. You must address the failure, andstart the installation again. For more information, see “Dependencies” on page7.The monitoring agent is installed in the /opt/ibm/ccm/agent directory.The UNIX OS agent is configured and started automatically.

What to do nextv If you are using a forward proxy, you must edit the agent environment

configuration file. For instructions, see “Configuring agents to communicatethrough a forward proxy” on page 78.

v If you are not logged in to the Performance Management console, follow theinstructions in “Starting the Performance Management console” on page 97.

Installing monitoring agents on Linux systemsTo install a monitoring agent, you must download an archive file from the IBMService Engage website, extract the agent installation files, and then start theinstallation script.

10 IBM Performance Management (SaaS): BETA Documentation

Page 17: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Your service subscription level determines which monitoring agents are availablefor installation. For a list of the agents included in each service subscription level,see Chapter 1, “Product overview,” on page 1.

You can install the following monitoring agents that run on Linux operatingsystems:v Monitoring Agent for Linux OSv Monitoring Agent for Linux KVMv Monitoring Agent for MongoDBv Monitoring Agent for MySQLv Monitoring Agent for Node.jsv Monitoring Agent for PHPv Monitoring Agent for PostgreSQLv Monitoring Agent for Pythonv Monitoring Agent for Rubyv Monitoring Agent for Tomcatv Monitoring Agent for WebSphere Applicationsv Response Time Monitoring Agent

Before you begin

You can install any combination of monitoring agents on a managed system. Forexample, if you install the Monitoring Agent for Ruby for monitoring Ruby OnRails applications, you might want to also install the Response Time MonitoringAgent to gather more response time information for your Ruby applications, andthe Monitoring Agent for Linux OS to monitor other aspects of the system, such asthe overall CPU, memory, and disk.

All monitoring agent communication requires outbound communication over httpsusing port 443. You do not need special firewall ports to use your service. If youragents do not have direct access to the internet, you can use forward proxies. Formore information, see “Configuring agents to communicate through a forwardproxy” on page 78.

The following monitoring agent prerequisites apply:v Monitoring Agent for Linux KVM

Install the required operating system prerequisite libvirt*.rpm.v Monitoring Agent for MySQL

To monitor a MySQL environment, the MySQL server and MySQL JDBC drivermust be installed before you install the Monitoring Agent for MySQL. Forexample, to install the JDBC driver on Red Hat Enterprise Linux, use thefollowing command:yum install mysql-connector-java

v Monitoring Agent for Node.jsYou must have Node.js V0.6.0 or higher installed before you install the agent.

v Monitoring Agent for PHP– You must have an Apache HTTPD server V2.2.15 or higher installed before

you install the agent.– PHP must be at V5.3.3 or higher.– You must have an existing WordPress-based application installed. The PHP

agent monitors WordPress V3.7.1 or higher.

Chapter 2. Installing and configuring 11

Page 18: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

– The agent evaluates only the performance of PHP requests in WordPressapplications. CSS and JS loading are not evaluated.

– The agent does not identify URLs via URL arguments.v Monitoring Agent for PostgreSQL

– You must have PostgreSQL V9.2 or higher installed.– You must modify the postgresql.conf configuration file to add

pg_stat_statements.1. Open the postgresql.conf file in a text editor and update the

shared_preload_libraries line as follows:shared_preload_libraries = ’pg_stat_statements’

If you want to monitor SQL functions, you must specify the following:shared_preload_libraries = ’pg_stat_statements’pg_stat_statements.track_utility = false

2. Restart the PostgreSQL server after you have added thepg_stat_statements.

3. Execute the following SQL command by using Psql:create extension pg_stat_statements;select pg_stat_statements_reset();

v Monitoring Agent for Python– You must have an Apache HTTPD server V2.2.15 or higher installed before

you install the agent.– The Apache server must include mod_wsgi V3.2 or higher.– Python must be at V2.6.6 or higher.– The Python agent monitors Django V1.4.10 or higher.– The agent evaluates only the performance of view requests in Django

applications.– The agent does not identify URLs via URL arguments.

About this task

Complete these steps to install monitoring agents on VMs and systems where RedHat Enterprise Linux or SUSE Linux Enterprise Server is installed.

Procedure1. To download the installation archive file, log in to My Services

(http://my.ibmserviceengage.com) from the IBM Service Engage website.Click Downloads to display the available packages for download. ClickDownload Agent under the Linux package for your service subscription. Savethe file to a staging directory of your choosing.The agents must be installed on the system where the application is installed. Ifneeded, transfer the installation archive file to the system to be monitored. Thearchive file contains the agents and installation script.

2. Open a terminal shell session on the Red Hat Enterprise Linux system.3. Navigate to the directory where the archive file is located.4. Extract the installation files by using one of the following commands

depending on your service subscription level:v For IBM Application Performance Management (SaaS):

tar -xf ./IAPMaaS_Agents_version.tar

v For IBM Monitoring (SaaS):

12 IBM Performance Management (SaaS): BETA Documentation

Page 19: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

tar -xf ./APMaaS_Agents_version.tar

v For IBM Application Diagnostics (SaaS):tar -xf ./APDaaS_Agents_version.tar

Where version is the specific version of your archive file.The installation script is extracted to a directory named for the archive file andversion. For example: offering_Agent_Install_1.2.3. Agent binary andconfiguration-related files are extracted into subdirectories within that directory.

5. Run the installation script with root user privileges from the directory namedfor the archive file and version:./installAPMaaSAgents.sh

You are prompted to install individual agents, a combination of the agents, orall of the agents.A prerequisite scan of your environment starts and takes a few moments tocomplete. If any requirements are missing, a message directs you to a log filewith the reason for the failure. A prerequisite, such as a missing library orinsufficient disk space, stops the installation. You must address the failure, andstart the installation again. For more information, see “Dependencies” on page7.The monitoring agent is installed in the /opt/ibm/ccm/agent directory.The Linux OS, Node.js, Response Time, and WebSphere Applications agents areconfigured with default configuration settings and started automatically.

6. If your monitoring agent requires configuration or you want to review thedefault settings, see “Configuring your monitoring agents” on page 16.v The data collector of the WebSphere Applications agent must be configured

before data is reported.v For the Node.js agent, you must add a monitoring plug-in to your Node.js

application before data is reported.v The Linux KVM, MongoDB, MySQL, PHP, PostgreSQL, Python, Tomcat, and

Ruby agents are multiple instance agents. You must create the first instanceand start the agent manually. A multiple instance agent means a singleinstallation of the agent instantiates a unique monitoring instance for eachunique application instance. These instances are visualized from thePerformance Management console as a result.

v For monitoring agents that require configuration, if you upgraded from aprevious version, be sure to reconfigure the monitoring agent before loggingin to the Performance Management console.

7. If the monitoring agent is not started or you want to confirm that it is started,enter one of the following commands:

Command Description

./name-agent.sh start Start the monitoring agent

./name-agent.sh status Verify that the monitoring agent is started

For more information about the monitoring agent commands, including thename to use, see “Entering agent commands” on page 100.

8. After installation is complete and the command line is available, you can repeatsteps 5 and 6 to install more monitoring agents on the managed system.

Chapter 2. Installing and configuring 13

Page 20: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

What to do nextv If you are using a forward proxy, you must edit the agent environment

configuration file. For instructions, see “Configuring agents to communicatethrough a forward proxy” on page 78.

v If you are not logged in, follow the instructions in “Starting the PerformanceManagement console” on page 97.

Installing monitoring agents on Windows systemsTo install a monitoring agent, you must download an archive file from the IBMService Engage website, extract the agent installation files, and then start theinstallation script.

Your service subscription level determines which monitoring agents are availablefor installation. For a list of the agents included in each service subscription level,see Chapter 1, “Product overview,” on page 1.

You can install the following monitoring agents that run on Windows operatingsystems:v Monitoring Agent for Windows OSv Monitoring Agent for MySQLv Monitoring Agent for Microsoft .NETv Monitoring Agent for WebSphere Applicationsv Response Time Monitoring Agent

For 32-bit Windows Servers, you can install the Monitoring Agent for WindowsOS.

Before you begin

You can install any combination of monitoring agents on a managed system. Forexample, if you install the Monitoring Agent for MySQL for monitoring MySQLservers, you might want to also install the Response Time Monitoring Agent togather more response time information, and the Monitoring Agent for WindowsOS to monitor other aspects of the system, such as the overall CPU, memory, anddisk usage.

All monitoring agent communication requires outbound communication over httpsusing port 443. You do not need special firewall ports to use your service. If youragents do not have direct access to the internet, you can use forward proxies. Formore information, see “Configuring agents to communicate through a forwardproxy” on page 78.

The following agent prerequisites apply:v Monitoring Agent for MySQL

For the Monitoring Agent for MySQL, you must have the MySQL server andMySQL JDBC driver installed before installing the MySQL agent on that system.To install the JDBC driver, see MySQL Connector/J JDBC driver(http://dev.mysql.com/downloads/connector/j).

v Response Time Monitoring AgentFor the Response Time Monitoring Agent, WinPcap 4.1.3 is required before youcan install the agent. You can download the driver from http://www.winpcap.org. For detailed instructions, see “Installing Windows packet

14 IBM Performance Management (SaaS): BETA Documentation

Page 21: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

capture library” (http://publib.boulder.ibm.com/infocenter/tivihelp/v63r1/topic/com.ibm.itcamt.doc_7.4.0.0/rt/Install_Guide/win_net_mon.html).

About this task

Complete these steps to install monitoring agents on VMs and systems where theWindows operating system is installed.

Procedure1. To download the installation archive file, log in to My Services

(http://my.ibmserviceengage.com) from the IBM Service Engage website.Click Downloads to display the available packages for download. ClickDownload Agent under the Windows package for your service subscription.Save the file to a staging directory of your choosing.The agents must be installed on the system where the application is installed. Ifneeded, transfer the installation archive file to the system to be monitored. Thearchive file contains the agents and installation script.The following file names apply depending on your service subscription level:v For IBM Application Performance Management (SaaS):

IAPMaaS_Agents_version.zip

v For IBM Monitoring (SaaS): APMaaS_Agents_version.zipv For IBM Application Diagnostics (SaaS): APDaaS_Agents_version.zipv For IBM Performance Management (SaaS) Agents for 32-Bit Windows Server:

IPMaaS_32Bit_Agents_version.zip

Where version is the specific version of your archive file.2. Extract the installation files.

The installation script is extracted to a directory named for the archive file andversion. For example: offering_Agent_Install_1.2.3. Agent binary andconfiguration-related files are extracted into subdirectories within that directory.

3. Run the installation script with Administrator privileges from the directorynamed for the archive file and version by using the command-line prompt:cd <offering>_Agent_Install_<version>installAPMaaSAgents.bat

You are prompted to install individual agents, a combination of the agents, orall of the agents.A prerequisite scan of your environment starts and takes a few moments tocomplete. If any requirements are missing, a message directs you to a log filewith the reason for the failure.The monitoring agent is installed in the C:\IBM\ITM\ directory.The Response Time, WebSphere Applications, and Windows OS agents areconfigured with default configuration settings and started automatically.

4. If your monitoring agent requires configuration or you want to review thedefault settings, see “Configuring your monitoring agents” on page 16.v The data collector of the WebSphere Applications agent must be configured

before data is reported.v The data collector of the Microsoft .NET agent must be configured before

data is reported.v The MySQL agent is a multiple instance agent. You must create the first

instance and start the agent manually. A multiple instance agent means asingle installation of the agent instantiates a unique monitoring instance for

Chapter 2. Installing and configuring 15

Page 22: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

each unique application instance. These instances are visualized from thePerformance Management console as a result.

v For monitoring agents that require configuration, if you upgraded from aprevious version, be sure to reconfigure the monitoring agent before loggingin to the Performance Management console.

5. If the monitoring agent is not started or you want to confirm that it is started,enter one of the following commands where name is os, mysql, was, dotnet, orrt:

Command Description

name-agent.bat start Start the monitoring agent

name-agent.bat status Verify that the monitoring agent is started

For more information about the monitoring agent commands, see “Enteringagent commands” on page 100.

6. After installation is complete and the command prompt is available, repeatsteps 3 on page 15 and 4 on page 15 to install and configure more monitoringagents.

What to do nextv If you are using a forward proxy, you must edit the agent environment

configuration file. For instructions, see “Configuring agents to communicatethrough a forward proxy” on page 78.

v If you are not logged in, follow the instructions in “Starting the PerformanceManagement console” on page 97.

Configuring your monitoring agentsIf your monitoring agent requires configuration or you want to review the defaultsettings for an agent, follow the steps provided for your agent.

Ensure agent prerequisites are met before configuring your monitoring agents.Review the prerequisites provided in the Before you begin sections of “Installingmonitoring agents on Linux systems” on page 10 and “Installing monitoring agentson Windows systems” on page 14.

Note: The Monitoring Agent for Linux OS and Monitoring Agent for Windows OSdo not require additional configuration.

Configuring the Linux KVM agentThe Monitoring Agent for Linux KVM supports connection to both the EnterpriseLinux based KVM hypervisor and Red Hat Enterprise Virtualization Manager(RHEVM) environments. You can use the same configuration script to configureinstances for these environments.

Before you begin

Before you run the configuration script, you must complete one of the followingprocedures:v For the RHEVM configuration, complete the following steps:

16 IBM Performance Management (SaaS): BETA Documentation

Page 23: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

1. Download the security certificate by browsing to the following location:https://<RHEVM-HOST>:<RHEVM-PORT>/ca.crt where RHEVM-HOST is the nameof the host and RHEVM-PORT is the name of the port that you use in yourRHEVM environment.

Note: The url contains the host and port from the RHEV-M environment.2. Import the certificate file to generate a local keystore by using the following

keytool command: keytool -import -alias <ALIAS> -file<CERTIFICATE_FILE> -keystore <KEYSTORE_FILE>

Note: The keytool utility is available with Java Runtime Environment (JRE).3. In the agent configuration steps, specify the path for this KEYSTORE_FILE for

the KEYSTORE_PATH parameter and include the file name in the path.4. Create a user account with read-only access to the REST API of the Red Hat

Enterprise Virtualization Manager (RHEV-M) to collect information aboutclusters, hosts, and virtual machines that RHEV-M manages. If there is notany user domain, such as an LDAP or an Active Directory configured, thenuse the default "admin" user and "internal" domain in the configurationsteps, to connect to RHEVM, or complete the following steps:a. Open the Red Hat Enterprise Virtualization Manager Web

Administration portal.b. Click Configure.c. In the Configuration window, select Roles.

1) To create a role, click New.2) In the New Role window, add the name of the role and select Admin

as the account type. Then, in the Check boxes to Allow Action pane,leave the check boxes clear. Click OK.

d. In the Configuration window, select System Permission.1) To grant a user permission, click Add.2) In the Add System Permission to User window, select the user to

whom you want to grant the permission.3) From the Assign role to user list, select the role that you created in

step 4 (c) and click OK.v For the Linux based KVM hypervisor configuration, complete the following

steps:1. For the Linux based KVM Hypervisor, the Linux KVM agent collects metrics

by connecting remotely to each hypervisor by using libvirt that managesyour QEMU-KVM virtual machines. The libvirt client on the agentenvironment uses several different remote transport protocols, as shown onthis Remote support page. Choose one of the following protocols formonitoring purposes:– SSH protocol– For the SSH agent, assume that you install the Linux KVM agent on Host

A and you want to monitor the hypervisor on Host B remotely. First, youmust configure the SSH agent so that the SSH agent makes a connectionfrom Host A to Host B without requesting a password.a. Log on to Host A with the same ID that runs the Linux KVM agent

process, for example, the root user ID.

Tip: Ensure that you know the ID on Host B that accepts the SSHconnection, and the root user ID on Host A.

Chapter 2. Installing and configuring 17

Page 24: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

b. Generate the id_rsa and id_rsa.pub keys on Host A by using thessh-keygen utility in Linux to genertae the keys.

Note: The keys are saved in~/.ssh: $ ssh-keygen -t rsa.c. Copy the authorized keys from Host B so that you can add the public

key for Host A to it: $ scp Id on Host B@name or IP address of HostB:~/.ssh/authorized_keys ~/.ssh/authorized_keys_from_B.

d. Append the public key for Host A to the end of the authorized keysfor Host B: cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys_from_B.

e. Copy the authorized keys back to Host B: $ scp ~/.ssh/authorized_keys_from_B Id on Host B@name or IP address of HostB:~/.ssh/authorized_keys

Note:If you are monitoring multiple hosts, repeat steps 3, 4, and 5 for eachhost.

f. Now, you can remove ~/.ssh/authorized_keys_from_B.g. Add the following command to the ~/.bash_ profile of the current ID

on Host A: $ eval `ssh-agent`.

Note: Ensure you use the single back quotation mark (`), locatedunder the tilde (~) on US keyboards, rather than the single quotationmark (').

h. Add the identity to Host A by using the $ ssh-add ~/.ssh/id_rsacommand and enter the password that you used when you created theID.If you receive the following message: Could not open a connection toyour authentication agent you must run the exec ssh-agent bashcommand.

Note: You can replace the bash with the shell that you are using andthen run the following ssh-add command again:$ ssh-add~/.ssh/id_rsa.

i. Test the SSH agent to ensure that it connects from Host A to Host Bwithout having to enter the SSH password.If you are monitoring multiple hosts, use the following command totest the connection for each host:$ ssh Id on Host B@name or IPaddress of Host B

– Post-configuration verificationa. Use the following virsh command to check your work:virsh -c

qemu+ssh://Id on Host B@name or IP address of Host B:port/system.b. If you have not changed the default SSH port, omit the :port section

of the command.

Note: If the virsh command succeeds, the Linux KVM agent connects.c. You must restart Host A before you restart the Linux KVM agent on

Host A. To restart, you must rerun the ssh-add command and supplythe password each time.

Note: You can use SSH keychains to avoid reentering the password.– TLS protocol

18 IBM Performance Management (SaaS): BETA Documentation

Page 25: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

a. Log in to Host B and confirm that you installed the gnutls andgnutls-utils packages.

b. Edit /etc/libvirt/libvirtd.conf to ensure that listen_tls is enabledand that the tls_port is specified with the default 16514 port number.

c. Open Remote support and follow the instructions to set up a certificateauthority between Host A and Host B.

Note: See the sections to Set up a certificate authority (CA), Issueserver certificates, and Issue client certificates.

d. To restart the libvirt daemon on Host B in listening mode, you eitherrun it with the --listen flag or edit /etc/sysconfig/libvirtd anduncomment LIBVIRTD_ARGS="--listen".

Post-configuration verificationTo check your configuration, use the virsh command and enter virsh -cqemu+tls://name or the IP address of the Host B:port/system. If you didnot change the default TLS port, you can omit the :port section of thecommand. If the virsh command succeeds, the Linux KVM agentconnects.

About this task

The Linux KVM agent is a multiple instance and multi-connection agent.Multi-instance means that each instance can make multiple connections to one ormore RHEV-M or KVM hypervisor environments. It is recommended to haveseparate instances for the KVM hypervisor and the RHEV-M environments. Afteryou install the agent software either on a physical host or VM, you configure theagent instance by using the configuration steps. You can create multiple instances.RHEV-H is the hypervisor from Red Hat that enables virtualization management,and it is not related to the agent directly. You could use the RHEV-H hypervisor toconfigure hypervisor hosts from the RHEV-M management console, for example,KVM hypervisors from Red Hat or Suse. In the silent configuration file, thesemultiple connections are distinguished by the unique connection ID that isappended to the configuration parameters. Depending on the type of configurationthat you choose, for example, the HOST parameter that is specified asRHEVM_HOST_ADDRESS.<RHEVM_ID>=<VALUE> orRHEVM_HOST_ADDRESS.<RHEVM_ID>=<VALUE>

Important: The RHEVM ID or the HYPERVISOR_ID is the unique ID thatdistinguishes connection A from connection B. These IDs are supplied duringconfiguration.

Procedurev Copy the linux_kvm_silent_config.txt file that is packaged with the agent to

create one of the following files:– linux_kvm_silent_config_RHEVM.txt– linux_kvm_silent_config_HYPERVISOR.txt

v Complete one of these steps to configure the agent with the default settings:– For RHEVM, to configure the agent, enter:

/opt/ibm/ccm/agent/bin/linux_kvm-agent.sh config instance_name/opt/ibm/ccm/agent/samples/linux_kvm_silent_config_RHEVM.txtWhere instance_name is the name you want to give to the instance.

– For Hypervisor, to configure the agent, enter:/opt/ibm/ccm/agent/bin/linux_kvm-agent.sh config instance_name

Chapter 2. Installing and configuring 19

Page 26: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

/opt/ibm/ccm/agent/samples/linux_kvm_silent_config_HYPERVISOR.txtWhere instance_name is the name you want to give to the instance.

v You can use one of the following types of configuration procedure to configurethe agent:– RHEVM: Running the script with no interaction

1. Open /opt/ibm/ccm/agent/samples/linux_kvm_silent_config_RHEVM.txtin a text editor.

2. For Maximum Number Of Data Provider Log Files, specify a default valueof (10) or a custom value.KV1_LOG_FILE_MAX_COUNT=<NUMERIC_VALUE>

Note: The agent acts as a data provider collecting data, for example,about memory or networking. The log files contain a certain LEVELinformation about the data collection process for the agent. The log filesare stored here: /opt/ibm/ccm/agent/logs.

3. For Maximum Size in KB of Each Data Provider Log, specify a defaultvalue of (5190) or a custom value.KV1_LOG_FILE_MAX_SIZE=<NUMERIC_VALUE>

4. For Level of Detail in Data Provider Log, specify a default value of(INFO) or any of the following values;OFF, SEVERE, WARNING, FINE, FINER, FINEST, ALLKV1_LOG_LEVEL=<LEVEL_VALUE>

5. For the data provider, specify [DATA_PROVIDER]

6. For the instance name, specify INSTANCE=<INSTANCE_NAME>

7. For RHEVM, specify [RHEVM]

8. For the host name of the RHEVM server, specifyRHEVM_HOST_ADDRESS.<RHEVM_ID>=<HOST_NAME>.

Note: You must define the <RHEVM-ID>.9. For the port number of the RHEVM server, specify

RHEVM_PORT.<RHEVM_ID>=<PORT>

10. For the user name to log in to RHEVM, specifyRHEVM_USERNAME.<RHEVM_ID>=<USER_NAME>

11. For the password, specifyRHEVM_PASSWORD.<RHEVM_ID>=<PASSWORD>

12. For the user domain, specifyRHEVM_DOMAIN.<RHEVM_ID>=<DOMAIN>

13. For the path to the keystore file, specifyRHEVM_KEYSTOREPATH.<RHEVM_ID>=<KEYSTORE_FILE_PATH>.

14. Save and close the linux_kvm_silent_config_RHEVM.txt file. Then enter:./linux_kvm-agent.sh config <RHEVM_INSTANCE_NAME>kv1_silent_config_RHEVM.txtWhere RHEVM_INSTANCE_NAME is the name that you want to give to theinstance.

15. To start the agent, enter:/opt/ibm/ccm/agent/bin/linux_kvm-agent.sh startRHEVM_INSTANCE_NAME.

– RHEVM: Running the script by responding to prompts1. Enter: ./linux_kvm-agent.sh config <RHEVM_INSTANCE_NAME> where

RHEVM_INSTANCE_NAME is the name that you want to give to the instance.

20 IBM Performance Management (SaaS): BETA Documentation

Page 27: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

2. When prompted to Edit Monitoring Agent for Linux_KVM settings,enter 1 to continue.

3. When prompted to Edit Data Provider settings, enter 1 to continue.4. When prompted for Maximum Number Of Data Provider Log Files, press

Enter to accept the default value (10) or to specify a numeric value.5. When prompted for Maximum Size in KB of Each Data Provider Log,

press Enter to accept the default value (5190) or to specify a numericvalue.

6. When prompted for Level of Detail in Data Provider Log, press Enterto accept the default value (4) or to specify one of the following numericoptions; [ 1=Off, 2=Severe, 3=Warning, 4=Info, 5=Fine, 6=Finer,7=Finest, 8=All ].

7. When prompted to Edit 'Hypervisor' settings, enter 2 to continue.8. When prompted to Edit 'Hypervisor' settings, enter 5(Next) to

continue, as you are not configuring a hypervisor connection.9. When prompted to Edit 'RHEVM Connection Details' settings, enter 1

(Yes) to continue.10. When prompted to Edit 'RHEVM Connection Details' settings, enter 1

(Add) to continue.11. When prompted for RHEVM ID, enter the ID value.12. When prompted for Host, specify the host name of the RHEVM server.13. When prompted for User, specify the user name to connect to the

RHEVM server.14. When prompted for Password, enter the password for the user.15. When prompted for re-typing password, enter the password value

again.16. When prompted for Port, specify the port number.17. When prompted for Domain, enter the user domain name.18. When prompted for KeyStorePath, specify the path of the local keystore

file that has the RHEVM server security certificate that is importedalready.

19. When prompted to Edit 'RHEVM Connection Details' settings, enter toselect default(5) to exit.

20. To start the agent, enter./linux_kvm-agent.sh start<RHEVM_INSTANCE_NAME>.

– Hypervisor: Running the script with no interaction1. Open /opt/ibm/ccm/agent/samples/

linux_kvm_silent_config_HYPERVISOR.txt in a text editor.2. For Maximum Number Of Data Provider Log Files, specify a default value

of (10) or a custom value.KV1_LOG_FILE_MAX_COUNT=<NUMERIC_VALUE>

3. For Maximum Size in KB of Each Data Provider Log, specify a defaultvalue of (5190) or a custom value.KV1_LOG_FILE_MAX_SIZE=<NUMERIC_VALUE>

4. For Level of Detail in Data Provider Log, specify a default value of(INFO) or any of the following values; OFF, SEVERE, WARNING, FINE,FINER, FINEST, ALL. KV1_LOG_LEVEL=<LEVEL_VALUE>

5. For the data provider, specify [DATA_PROVIDER]

6. For the instance name, specify INSTANCE=<INSTANCE_NAME>

Chapter 2. Installing and configuring 21

Page 28: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

7. For HYPERVISOR, specify [HYPERVISOR]

8. For the host name of the KVM host, specifyHOST_ADDRESS.<HYPERVISOR_ID>=<HOST_NAME>

9. For the port number of the KVM host, specifyPORT.<HYPERVISOR_ID>=<PORT>

Important: If you do not provide explicit values for the ports, the default(16514) port value is assigned for the TLS protocol. However, the default(22) port value is not assigned for the SSH protocol.

10. For the user name to connect to the hypervisor on the host, specifyUSERNAME.<HYPERVISOR_ID>=<USER_NAME>

Restriction: You specify this parameter to ensure that the user name hasenough privileges to connect to the hypervisor on the host. Thisparameter applies only to SSH transport.

11. For the protocol used by the agent to connect to remote hypervisors,specify PROTOCOL.<HYPERVISOR_ID>=<PROTOCOL>

Note: The protocol values include SSH or TLS.12. For the connection that uses privileged system driver or per-user

un-privileged session driver, specifyCONNECTION_MODE.<HYPERVISOR_ID>=<VALUE>

Note: The values include system and session. For more informationabout whether to use system or session, see Differences betweenqemu:///system and qemu:///session Then, for more informationabout the system and session drivers, see the KVM/QEMU hypervisordriver(http://libvirt.org/drvqemu.html#securitydriver).

13. To start the agent, enter:/opt/ibm/ccm/agent/bin/linux_kvm-agent.sh startHYPERVISOR_INSTANCE_NAME.

– Hypervisor: Running the script by responding to prompts1. Enter: ./linux_kvm-agent.sh config <HYPERVISOR_INSTANCE_NAME> where

HYPERVISOR_INSTANCE_NAME is the name you want to give to the instance.2. When prompted to Edit Monitoring Agent for Linux_KVM settings,

enter 1 to continue.3. When prompted to Edit Data Provider settings, enter 1 to continue.4. When prompted for Maximum Number Of Data Provider Log Files, press

Enter to accept the default value (10) or to specify a numeric value.5. When prompted for Maximum Size in KB of Each Data Provider Log,

press Enter to accept the default value (5190) or to specify a numericvalue.

6. When prompted for Level of Detail in Data Provider Log, press Enterto accept the default value (4) or to specify one of the following numericoptions; [ 1=Off, 2=Severe, 3=Warning, 4=Info, 5=Fine, 6=Finer,7=Finest, 8=All ].

7. When prompted to Edit 'Hypervisor' settings, enter 1 (Yes) tocontinue.

8. When prompted to Edit 'Hypervisor' settings, enter 1 (Add) tocontinue.

9. When prompted for Hypervisor ID, enter the ID value.10. When prompted for Host, specify the host name of the KVM host.

22 IBM Performance Management (SaaS): BETA Documentation

Page 29: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

11. When prompted for User, specify the user name.12. When prompted for Remote Transport, enter 1 for default value (SSH), or

select one of the following values; 2=TLS, 3-TCP (Unencrypted-- notrecommended for production use).

13. When prompted for Port, specify the port number for the SSH and TLSports for the transport protocol.

14. When prompted for Connection Instance Type, enter one of thefollowing values; 1 for default value system, or 2 for session.

Note: After you configure the hypervisor connection, you have theoption to add, edit, delete connections or to exit completely.

15. When prompted for Edit 'Hypervisor' settings, enter 5 to selectdefault option (5) to exit, or one of the following values; 1=Add, 2=Edit,3=Del, or 4=Next..

16. When prompted to Edit 'RHEVM Connection Details' settings, enter 2to exit.

17. To start the agent, enter:/opt/ibm/ccm/agent/bin/linux_kvm-agent.sh startHYPERVISOR_INSTANCE_NAME.

Configuring the Microsoft .NET agent

About this task

The Microsoft .NET agent consists of two components; the monitoring agent andthe data collector.

The data collector gathers transaction tracking and diagnostic data. Data that iscollected by the data collector is passed to the monitoring agent. The diagnosticdata is processed by the monitoring agent directly. The transaction tracking data isprocessed with a sub-component of the monitoring agent, the TransactionFramework Extension.

The data collector contains two modules, the profiler and the HTTP module. Bothmodules collect transaction tracking data. For diagnostic data, the profiler collectsmethod and stack trace data; the HTTP module collects request data.

To start collecting diagnostic and transaction tracking data, you must first registerthe data collector profiler:

Procedure1. To register the data collector profiler, enter: cd C:\IBM\ITM\qe\bin

configdc.exe registerdc

2. Restart the .NET application.

What to do next

For advanced configuration, complete the steps in “Microsoft .NET agent:Advanced configuration.”

Microsoft .NET agent: Advanced configurationYou can modify the configuration of the data collector using the configdccommand.

Chapter 2. Installing and configuring 23

Page 30: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Tip: If you want to view the configuration values of the data collector, navigate tothe C:\IBM\ITM\qe\config directory, and open the dotNetDcConfig.properties filein a text editor.

Registering and unregistering the data collector:

If you want to stop monitoring .NET applications, unregister the data collector.Register the data collector again to restart monitoring. You must also unregister thedata collector before you uninstall the agent.

Procedure

v To register the data collector, complete the following steps:1. Enter the following command as an administrator: cd C:\IBM\ITM\qe\bin

configdc registerdc [-f]Where -f overrides any existing .NET data collector profiler without furtherprompts. If a profiler exists, and the -f option is not specified, the profiler isnot updated.

2. Restart the .NET application.v To unregister the data collector, complete the following steps:

1. Enter the following command as an administrator: cd C:\IBM\ITM\qe\binconfigdc unregisterdc

2. Restart the .NET application.

Selecting ADO.NET interfaces for monitoring:

You can specify the ADO.NET client interfaces that you want to enable fortransaction tracking.

Before you begin

You might want to view the ADO.NET interfaces that are supported by .NET DataCollector. For information about supported ADO.NET interfaces, see Functions ofnamespaces supported by the data collector.

To view the configuration values of the .NET Data Collector, see thedotNetDcConfig.properties file in the C:\IBM\ITM\qe\config directory.

About this task

By default, all supported ADO.NET interfaces are enabled for transaction trackingduring the installation of the agent. To select the interfaces that must be monitoredby the data collector, enable or disable monitoring for specific interfaces.

If you disable monitoring of an interface, the settings of any associated applicationdomain filter remain in the data collector configuration file. The filter is retainedwhen the interface is enabled again.

For more information about using the configdc command, see “Using the configdccommand” on page 27.

Procedure

v To enable monitoring of an ADO.NET interface, complete these steps:1. From the C:\IBM\ITM\qe\bin directory, run the configdc enableMonitor

command:

24 IBM Performance Management (SaaS): BETA Documentation

Page 31: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

configdc enableMonitor all | adsi | db2 | ldap | odbc | oledb | oracle | sql| http | web[-appdomain appdomain filter list]

2. If your configuration changes are complete, activate the configurationchanges. See “Activating the configuration” on page 26 for more information.

v To disable monitoring of an ADO.NET interface, complete these steps:1. From the C:\IBM\ITM\qe\bin directory, run the configdc disableMonitor

command:configdc disableMonitor all | adsi | db2 | ldap | odbc | oledb | oracle | sql| http | web

2. If your configuration changes are complete, activate the configurationchanges. See “Activating the configuration” on page 26 for more information.

Configuring the collection of diagnostics data:

The collection of diagnostics data is enabled in the data collector configuration bydefault. You can limit the amount of diagnostic data that is collected by the datacollector using the configdc command.

Procedure

1. To set the level of trace data that is collected, enter:cd C:\IBM\ITM\qe\bin configdc deepdivedc -tracelevel trace_level

Where trace_level is the diagnostics trace level of the .NET Data Collector. Validvalues are 0, 1, 2, and 3, where:

0 The collection of diagnostics data is disabled.

1 The collection diagnostics data is enabled. The HTTP module collectsrequest summary and request instance data.

2 The collection diagnostics data is enabled. The HTTP module collectsrequest summary and request instance data. The profiler collectsmethod data.

3 The collection diagnostics data is enabled. The HTTP module collectsrequest summary and request instance data. The profiler collectsmethod and stack trace data.

When you configure the data collector initially, level 3 is set by default.2. If your configuration changes are complete, activate the configuration changes.

See “Activating the configuration” on page 26 for more information.

Configuring transaction tracking:

The interface to the Transaction Framework Extension is configured in the datacollector configuration by default. You can modify the interface settings using theconfigdc command.

About this task

Procedure

1. From the C:\IBM\ITM\qe\bin directory, run the following command to specifythe host name or IP address and port of the Transaction Framework Extension:configdc ttserver -name [host name/ip address] -port [port number]

Chapter 2. Installing and configuring 25

Page 32: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

If the Transactions Framework Extension is on the same host, use the local hostaddress (127.0.0.1). The default port is 5456.

2. Activate the configuration changes. See “Activating the configuration” for moreinformation.

What to do next

For information about enabling transaction tracking, see “Enabling and disablingTransaction Tracking.”

Enabling and disabling Transaction Tracking:

Transaction tracking is enabled in the data collector configuration by default. Youcan enable and disable Transaction Tracking using the command line.

Before you begin

The connection to the Transaction Framework Extension must be specified. It isconfigured in the default configuration. To modify the default configuration, see“Configuring transaction tracking” on page 25.

About this task

Transaction tracking data is visible in topology views if topology views areavailable on the Performance Management console.

Procedure

To enable Transaction Tracking for a .NET Data Collector:1. From the C:\IBM\ITM\qe\config directory, open the

dotNetDcConfig.properties.inactive file in a text editor and setTTDC.enabled=true.

2. Activate the change. Run the following command:C:\IBM\ITM\qe\bin\configdc.exe activateconfig

3. Restart the .NET application for the change to take effect.

What to do next

To disable Transaction Tracking for a .NET Data Collector, repeat the procedure,instead setting TTDC.enabled=false in the configuration file.

Activating the configuration:

Activate the updated configuration for the changes to take effect.

Procedure

1. Navigate to C:\IBM\ITM\qe\bin.2. Enter configdc activateconfig

What to do next

If the Internet Information Service (IIS) transactions are monitored and the datacollector configuration is updated, restart the IIS to activate the configuration.

26 IBM Performance Management (SaaS): BETA Documentation

Page 33: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

If ASMX or WCF web services are monitored and the data collector configurationis updated, complete one of the following steps:v Restart the process that hosts the web service.v Unregister the data collector by running the configdc unregisterdc command,

and then register it again by running the configdc registerdc command.

Configuring logging for the data collector:

Logging is separately configured for each component of data collector.

Performance of data collector might be affected when tracing is enabled. Disabletracing after the required trace logs are gathered.

For the .NET profiler component, configure logging by using the configdccommand. For more information about using the command, see “Using theconfigdc command.”

The settings for ASMX/WCF trace and operation logging are set in thedotNetDcConfig.properties file in the C:\IBM\ITM\qe\config directory.

Using the configdc command:

You can use the command-line configuration tool of .NET Data Collector toperform the configuration tasks, such as registering the data collector, validatingand storing the connectivity information, enabling and disabling trace logging, andso on.

Run all commands that are mentioned in Table 4 from the C:\IBM\ITM\qe\bindirectory.

Table 4. Data collector configuration commands

Command syntax Description

configdc registerdc [-f] Registers the .NET Data Collector.

-f overrides any .NET data collector profilerthat is already registered without anynotifications. If a profiler exists and the -foption is not specified, the profiler is notconfigured.

Run this command as an administrator.

configdc unregisterdc Stops the data collector from intercepting .NETtransactions. Run this command as anadministrator.

configdc ttserver -name name -portport

Validates and sets the connectivity informationof the Transaction Framework Extension towhich the agents sends the tracking data.

Chapter 2. Installing and configuring 27

Page 34: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Table 4. Data collector configuration commands (continued)

Command syntax Description

configdc logging [level ERROR | DEBUG| WARNING | INFO] [-size #] [-files#] [-tracing on|off]

Enables or disables trace logging for the .NETprofiler. Sets tracing attributes, for example, thelevel of trace detail, the maximum trace log filesize, and the maximum number of trace logfiles. For valid values, see thedotNetDcConfig.properties file in theC:\IBM\ITM\qe\config directory.

The settings for ASMX/WCF trace andoperation logging are specified in thedotNetDcConfig.properties file.

configdc enablemonitor [all | adsi |db2 | ldap | odbc | oledb | oracle |sql | http | web] [-appdomain appdomain list]

Enables transaction monitoring of an ADO.NETinterface. After installation, all interfaces areenabled for monitoring by default.

Use all to enable all the supported ADO.NETinterfaces for transaction tracking. Use http toenable interception of supporting APIs for httpmonitoring.

The -appdomain command restricts theADO.NET interface monitoring to one or more.NET application domain names.

If you specify more than one applicationdomain name, separate each name with asemicolon (;). Use an asterisk (*) to enable allapplication domains. All application domainsare enabled by default during the installation.

When an application domain list is assigned toan ADO.NET interface, the list remainsunchanged in the configuration unless it is setto another value. If an interface is enabled formonitoring without specifying an applicationdomain, the last application domain value thatyou specified or that was specified by defaultfor the interface is used.

configdc disablemonitor [all | adsi |db2 | ldap | odbc | oledb | oracle |sql | http | web]

Disables transaction monitoring of an ADO.NETinterface. Use all to disable all supportedADO.NET interfaces for transaction tracking.

Use http to intercept GetResponse (System.Net)and use web to disable the monitoring of httprequests.

configdc getconfig [-active] Displays the properties file where you can addor remove .NET API calls to be intercepted bythe data collector. When the changes arecomplete, activate the edited file by using theconfigdc activateconfig command.

configdc deepdivedc -traceleveltrace_level

Configures the level of diagnostics data to becollected by the data collector.

configdc activateconfig Activates the updated configuration. Forinformation about what to after you activate theconfiguration, see “Activating the configuration”on page 26.

28 IBM Performance Management (SaaS): BETA Documentation

Page 35: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Configuring the MongoDB agentThe Monitoring Agent for MongoDB requires an instance name. You must createthe first instance and start the agent manually.

About this task

The instance name that you specify is included in the managed system name,instance_name:host_name:pc, where pc is your two character product code. Theinstance name is limited to 28 characters, minus the length of your host name. Forexample, if you specify Mongo2 as your instance name, your managed system nameis Mongo2:hostname:KJ.

In a typical environment, where MongoDB is running as a cluster and there is asingle router on the system where you installed the agent, the only configurationinformation you need to provide is the new instance name. For a typicalenvironment, configure the agent with the default settings.

To change the type, port, or router IP address, configure the agent with customizedsettings.

Procedurev To configure the agent with the default settings not responding to prompts,

complete the following steps:1. Enter:

/opt/ibm/ccm/agent/bin/mongodb-agent.sh config instance_name/opt/ibm/ccm/agent/samples/mongodb_silent_config.txtWhere instance_name is the name you want to give to the unique applicationinstance.

2. To start the agent, enter:/opt/ibm/ccm/agent/bin/mongodb-agent.sh start instance_name

v To configure the agent by editing the silent response file and running the scriptwith no interaction, complete the following steps:1. Open /opt/ibm/ccm/agent/samples/mongodb_silent_config.txt in a text

editor.2. For TYPE, you can specify whether the systems are a cluster (1), a single

replication set (2), or a stand-alone instance (3). By default, the agentmonitors a cluster (1).

3. For PORT, to override the automatic discovery of a cluster or to monitor aspecific replication set, set the port number for the router of a MongoDBcluster or a mongod (primary daemon process) instance of a MongoDBreplication set being monitored. If this value is blank, the agent automaticallydiscovers the appropriate MongoDB process ports. Leaving the port valueempty provides more reliable monitoring if there is only one cluster orreplication set on the system.

4. For HOST, you can set the IP address for the MongoDB host system, or leavethis parameter blank to have the installer discover the default IP address.The host IP address is used to select a particular interface on a system whereMongoDB is bound to only one of several addresses.

5. Save and close the mongodb_silent_config.txt file, then enter:/opt/ibm/ccm/agent/bin/mongodb-agent.sh config instance_name/opt/ibm/ccm/agent/samples/mongodb_silent_config.txtWhere instance_name is the name that you want to give to the instance.

Chapter 2. Installing and configuring 29

Page 36: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

6. To start the agent, enter:/opt/ibm/ccm/agent/bin/mongodb-agent.sh start instance_name

v To configure the agent by running the script and responding to prompts,complete the following steps:1. Enter:

/opt/ibm/ccm/agent/bin/mongodb-agent.sh config instance_nameWhere instance_name is the name you want to give to the instance.

2. Respond to the prompts by using the description of the parameters that wereprovided earlier for reference.

3. To start the agent, enter:/opt/ibm/ccm/agent/bin/mongodb-agent.sh start instance_name

Configuring the MySQL agentThe Monitoring Agent for MySQL requires an instance name and the MySQLserver user credentials. You must create the first instance and start the agentmanually. Run the configuration script to create an instance and change anyconfiguration settings.

You can edit the MySQL silent response file before you run the script to bypass theprompting and responses that are otherwise required.

About this task

The instance name that you specify is included in the managed system name,instance_name:host_name:pc, where pc is your two character product code. Theinstance name that you specify is limited to 28 characters, minus the length of yourhost name. For example, if you specify MySQL2 as your instance name, yourmanaged system name is MySQL2:hostname:SE.

Procedurev To configure the agent by editing the silent response file and running the script

with no interaction, complete the following steps:1. To configure the agent, open the response file in a text editor:

/opt/ibm/ccm/agent/samples/mysql_silent_config.txt

C:\IBM\ITM\samples\mysql_silent_config.txt

2. For JDBC user name, leave it set to root or change to a user with privilegesto view the INFORMATION_SCHEMA tables.

3. For JDBC password, enter the JDBC user password.4. For JDBC home, leave it at the default, if this path is where Java is installed;

otherwise, enter the correct path. Default path:/opt/ibm/java-x86_64-70/jre

C:\IBM\ITM\java\java70_x64\jre

5. For JDBC Jar File, leave it at the default, if this is the path to the MySQLconnector for the Java jar file; otherwise, enter the correct path. Defaultpath:

/usr/share/java/mysql-connector-java.jar

C:\Program Files (x86)\MySQL\Connector J5.1.26\mysql-connector-java-5.1.26-bin.jar

6. For JDBC port number, leave it at the default 3306 or specify the portnumber if it is different.

30 IBM Performance Management (SaaS): BETA Documentation

Page 37: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

7. For Java trace level, leave it at the default level Error or change it to thelevel instructed by IBM Support.

8. Save the response file.9. To configure the agent, enter:

/opt/ibm/ccm/agent/bin/mysql-agent.sh config instance_name/opt/ibm/ccm/agent/samples/mysql_silent_config.txt

C:\IBM\ITM\BIN\mysql-agent.bat config instance_nameC:\IBM\ITM\samples\mysql_silent_config.txt

Where instance_name is the name that you want to give to the instance.Be sure to include the absolute path to the silent response file. Otherwise,no agent data is available in the dashboards.

10. To start the agent, enter:/opt/ibm/ccm/agent/bin/mysql-agent.sh start instance_name

C:\IBM\ITM\BIN\mysql-agent.bat start instance_name

v To configure the agent by running the script and responding to prompts,complete these steps:–

1. To configure the agent, enter:/opt/ibm/ccm/agent/bin/mysql-agent.sh config instance_nameWhere instance_name is the name you want to give to the instance.

2. Respond to the prompts by using the description of the parameters thatwere provided earlier for reference.

3. To start the agent, enter:/opt/ibm/ccm/agent/bin/mysql-agent.sh start instance_name

Configuring the Node.js agent

About this task

Node.js is a software platform that employs JavaScript for server-side solutions,these solutions are often used for receiving and responding to HTTP requests. TheNode.js agent can be used to measure and collect data about the performance ofNode.js applications. For example, throughput and response times for HTTPrequests, and other measurements that relate to resource usage, are monitored andstored for display and analysis. The Node.js agent is a single instance agent. Itregisters subnodes for each monitored Node.js application.Subnode name structure: NJ:hostname_port:NJA

Tip: If one Node.js application listens on multiple port numbers, then the lowestport number is used.

You must add a plug-in to your Node.js application and restart it before the agentcan begin monitoring your application. No actual agent configuration is required.The agent starts automatically after installation.

Procedure

To add the monitoring plug-in to your Node.js application:v Edit your Node.js application file to add the monitoring plug-in to the beginning

of the file.For example, if your Node.js application file is /home/app/acmeair/index.js, add

Chapter 2. Installing and configuring 31

Page 38: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

the following line to the beginning of the file:require(’/opt/ibm/ccm/agent/lx8266/nj/bin/plugin/knj_index’).

v Verify that the Node.js agent is running. This step is only needed the first timethat the agent is started as it creates a plug-in folder when it first starts.Normally the agent starts automatically 1 or 2 minutes after installation.

v Restart your Node.js application to enable the monitoring plug-in.

What to do nextv You can verify the Node.js agent data is displayed in the Performance

Management console.v You can change the runtime behavior of Node.js monitoring plug-ins. For more

information, see Node.js agent monitoring plug-in: Runtime configuration file

Node.js agent monitoring plug-in: Runtime configuration fileYou can change the behavior of each Node.js monitoring plug-in by changing itsruntime configuration in its configuration file.

Runtime configuration file

The Node.js monitoring plug-in code is in the plug-in folder at:/opt/ibm/ccm/agent/lx8266/nj/bin/plugin. There is a runtime configuration filefor each monitoring plug-in in the /opt/ibm/ccm/agent/lx8266/nj/bin/plugin/libfolder. The monitoring plug-in reads the configuration file every 2 minutes. Whenyou change the content of the configuration file, the behavior of the associatedplug-in changes.

Tip: The runtime configuration file is named as follows plugin_application portnumber_conf.json. If a Node.js application is listening on multiple port numbers,the lowest port number is used.

There are two types of information in the configuration file:v URL filtering rulesv Plug-in logging parameters

URL filtering rules

Regular expressions are used to map the URL path name to a user customizedpath name. Mapping the URL to a customized path name can be used to satisfythe following requirements:v When you want to ignore URL paths to static files.

For example, if a web page includes images that generate separate serverdownload requests, you might not be interested in seeing response times forthese types of requests.

v When you want to aggregate URLs with similar paths. For example, for similarURL paths as shown in the following example./demo/poll/1/demo/poll/2/demo/poll/3...

On the web server, requests for these paths are likely served by a commonroutine. In this case, you might aggregate the paths to a single URL type byusing a filter as shown in the following example.

32 IBM Performance Management (SaaS): BETA Documentation

Page 39: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

"filters":[{"pattern": "/demo/poll/.+","to": "/demo/poll/"}

This filter results in all requests to URL paths like "/demo/poll/xxx" beingmapped to a URL path type of "/demo/poll". The response times for all requeststo URL paths of this type are then averaged to a single value. Aggregating inthis way can help you make more efficient use of available resources.

In the configuration file, there is a JSON array named filters. This array containsthe URL filter rules, for example:"filters":[

{"pattern": ".+\\.png$","to": ""

},{

"pattern": ".+\\.jpg$","to": ""

},{

"pattern": "GET /js/.+\\.js$","to": ""

},{

"pattern": "GET /js/.+\\.css$","to": ""

}]

Each member in the array is a filtering rule. When an HTTP request is received bythe plug-in, the plug-in extracts the URL path name from the request andcompares it with each "pattern". If the path name matches a particular pattern,the "to" value for that pattern is used as a URL path name. When the "to" valueis empty, the plug-in ignores the request. If the path name does not match a"pattern", the original URL path name is kept and used for measurements.

Plug-in logging parameters

In the configuration file, there are two logging parametersv The trace log file namev The trace level

The entries in the log file are as follows:"traceFile": "/tmp/app.log","traceLevel": "error"

You can specify the log file name by changing the value of "traceFile". Thedefault value is "/tmp/app.log". You can set the log file trace level by changing thevalue of "traceLevel". The default value is "error". Two trace level values aresupported, "info" and "error". If you set the trace level to the value "info",messages are logged when the plug-in is running normally, the raw monitoringdata sent to the agent is also logged. If you set the trace level to the value "error",messages are only logged on an error condition.

Chapter 2. Installing and configuring 33

Page 40: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Configuring the PHP agent

Before you begin

Ensure that the Apache HTTPD server is started before you configure the agent.

If the Apache HTTPD server version is lower than V2.4, open the Apache HTTPServer httpd.conf configuration file and ensure that both the mod_status andExtendedStatus On options are enabled. For example:ExtendedStatus On<Location /server-status>

SetHandler server-statusOrder deny,allowAllow from allAllow from 127.0.0.1

</Location>

About this task

Note: The PHP agent and Python agent can coexist in a single Apacheenvironment.

The PHP agent is a multiple instance agent; you must create the first instance andstart the agent manually. The instance name that you specify is included in themanaged system name, instance_name:host_name:pc, where pc is your twocharacter product code. The instance name that you specify is limited to 28characters, minus the length of your host name. For example, if you specify PHP2as your instance name, your managed system name is PHP2:hostname:PJ.

Procedurev To configure the agent with the default settings, not responding to prompts,

complete the following steps:1. Enter:

/opt/ibm/ccm/agent/bin/php-agent.sh config instance_name/opt/ibm/ccm/agent/samples/php_silent_config.txtWhere instance_name is the name you want to give to the instance.

2. To start the agent, enter:/opt/ibm/ccm/agent/bin/php-agent.sh start instance_name

v To configure the agent by editing the silent response file and running the scriptwith no interaction, complete the following steps:1. Open /opt/ibm/ccm/agent/samples/php_silent_config.txt in a text editor.2. For Location of PHP execution binary, you can specify the directory where

the PHP execution is located. The default location is /usr/local/bin.3. For Location of PHP INI file, you can specify the directory where the

php.ini file is located. The default location is /etc.4. For Web server port, you can specify the port number of the web server that

is running WordPress. The default is 80.5. For Application DocumentRoot, you can specify the DocumentRoot of the

PHP WordPress application. Use a colon to separate multiple records. Toallow the agent to find all the records for you, use the default value of ALL.

6. Save and close the php_silent_config.txt file, then enter:/opt/ibm/ccm/agent/bin/php-agent.sh config instance_name/opt/ibm/ccm/agent/samples/php_silent_config.txtWhere instance_name is the name that you want to give to the instance.

34 IBM Performance Management (SaaS): BETA Documentation

Page 41: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

7. To start the agent, enter:/opt/ibm/ccm/agent/bin/php-agent.sh start instance_name

v To configure the agent by running the script and responding to prompts,complete the following steps:1. Enter:

/opt/ibm/ccm/agent/bin/php-agent.sh config instance_nameWhere instance_name is the name you want to give to the instance.

2. When prompted to Edit Monitoring Agent for PHP settings, enter 1 tocontinue.

3. When prompted for Location of PHP execution binary, press Enter toaccept the default location or specify your own location.

4. When prompted for Location of PHP INI file, press Enter to accept thedefault location or specify your own location.

5. When prompted for Web server port, press Enter to accept the default portor specify a different port number.

6. When prompted for Application DocumentRoot, press Enter to accept thedefault or specify the DocumentRoot of the PHP WordPress application. Youcan use a colon to separate multiple records.

7. To start the agent, enter:/opt/ibm/ccm/agent/bin/php-agent.sh start instance_name

What to do next

You can verify the PHP agent data is displayed in the Performance Managementconsole.

You must ensure that the WordPress plugin-in for the agent is activated. To ensureactivation, complete the following steps:1. In a web browser, enter the following URL http://hostname:port/wp-admin/.2. Access the administrative page by navigating to Plugins > Installed Plugins.3. Ensure that the PHP agent plug-in is activated. The PHP agent plug-in is listed

as WordPress Agent. Typically, the plug-in is already activated. If it is notalready activated, click on Activate.

4. Optionally, you can verify your Apache server-status module is available usingthe following command:/user/local/apache/bin/apachectl fullstatus

Configuring the PostgreSQL agent

Before you begin

If the authentications settings are not correct in the PostgreSQL databasepg_hba.conf file, the PostgreSQL agent cannot connect to the PostgreSQL database.If auth-method is set to ident, the PostgreSQL agent cannot connect. Ensure thatthe PostgreSQL pg_hba.conf authentication file has the correct auth-methodsettings. For example, you might set auth-method to md5, trust, or password.

About this task

The PostgreSQL agent is a multiple instance agent; you must create the firstinstance and start the agent manually. The instance name that you specify isincluded in the managed system name, instance_name:host_name:pc, where pc isyour two character product code. The instance name that you specify is limited to

Chapter 2. Installing and configuring 35

Page 42: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

28 characters, minus the length of your host name. For example, if you specifyPostgreSQL2 as your instance name, your managed system name isPostgreSQL2:hostname:PN.

Procedurev To configure the agent by editing the silent response file and running the script

with no interaction, complete the following steps:1. Open /opt/ibm/ccm/agent/samples/postgresql_silent_config.txt in a text

editor.2. For JDBC database name, leave it set to postgres or specify the database

name.3. For JDBC user name, leave it set to postgres or change to a different user

name.4. For JDBC password, enter the JDBC user password.5. For JDBC port number, leave it at the default 5432 or specify the port

number if it is different.6. For JDBC JAR file, leave the path to the PostgreSQL connector for the Java

JAR file at the default if it is correct; otherwise, enter the correct path.Default path: /opt/PostgreSQL/lib/postgresql-9.3-1100.jdbc4.jar.

7. For Java home, confirm that the default path exists; otherwise, enter thecorrect path. Default path: /opt/ibm/ccm/agent/JRE/lx8266/jre.

8. For Java trace level, leave it at the default level Error or change it to thelevel instructed by IBM Support.

9. Save and close the postgresql_silent_config.txt file, and enter:/opt/ibm/ccm/agent/bin/postgresql-agent.sh config instance_name/opt/ibm/ccm/agent/samples/postgresql_silent_config.txtWhere instance_name is the name that you want to give to the instance.

10. To start the agent, enter:/opt/ibm/ccm/agent/bin/postgresql-agent.sh start instance_name

v To configure the agent by running the script and responding to prompts,complete the following steps:1. Enter:

/opt/ibm/ccm/agent/bin/postgresql-agent.sh config instance_nameWhere instance_name is the name you want to give to the instance.

2. When prompted to Edit Monitoring Agent for PostgreSQL settings, enter1 to continue.

3. When prompted for JDBC database name, press Enter to accept the defaultor specify a database name.

4. When prompted for JDBC user name, press Enter to accept the default orspecify a user name.

5. When prompted for JDBC password, enter the JDBC user password.6. When prompted for JDBC port number, press Enter to accept the default or

specify a port number.7. When prompted for Java home, press Enter to accept the default or specify a

path.8. When prompted for JDBC JAR file, press Enter to accept the default or

specify the file.9. When prompted for Java trace level, enter 2 to accept the default or

specify the trace.

36 IBM Performance Management (SaaS): BETA Documentation

Page 43: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

10. To start the agent, enter:/opt/ibm/ccm/agent/bin/postgresql-agent.sh start instance_name

Configuring the Python agent

Before you begin

Ensure that the Apache HTTPD server is started before you configure the agent.

Open the Apache HTTPD server httpd.conf configuration files and ensure thatmod_status is loaded.

About this task

Note: The Python agent and PHP agent can coexist in a single Apacheenvironment.

The Python agent is a multiple instance agent; you must create the first instanceand start the agent manually. The instance name that you specify is included in themanaged system name, instance_name:host_name:pc, where pc is your twocharacter product code. The instance name that you specify is limited to 28characters, minus the length of your host name. For example, if you specifyPython2 as your instance name, your managed system name isPython2:hostname:PG.

Procedurev To configure the agent by editing the silent response file and running the script

with no interaction, complete the following steps:1. Open /opt/ibm/ccm/agent/samples/python_silent_config.txt in a text

editor.2. For HTTPD listening port, specify the port number to distinguish one group

of HTTPD processes from others. The default is 80.

Note:

– If your Apache server is listening on multiple ports, you can specify anyone of them for this parameter.

– If you have more than one Apache server running on the same system,you must specify a port from the server in which the Django applicationsare running.

3. For Django WSI entry points, specify the Django WSGI entry points. Use acolon to separate multiple entry points.For example, in an Apache configuration file, you might see the followingconfiguration line:WSGIScriptAlias / /var/www/html/mysite/mysite/wsgi.pyIn this example, /var/www/html/mysite/mysite/wsgi.py is provided as theentry point.To include all the entry points that are discovered in the Apacheconfiguration files, leave this parameter blank.

4. For Minimum recorded response time, set the average response time inmilliseconds. Requests that are faster or equal to this number are notrecorded. The default is 300.

5. For Slow request threshold, set the slow request threshold in milliseconds.The default is 500.

Chapter 2. Installing and configuring 37

Page 44: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

6. For Extreme slow request threshold, set the extreme slow request thresholdin milliseconds. The default value is 7000.

7. For Profiler report interval, set the interval in minutes, at which theagent generates the profiler report for slow requests. The minimum settingfor this value is 10, this ensures your applications are not slowed down toexcessive profiling. Typical users set this value greater than 10. The default is10.

8. Save and close the python_silent_config.txt file, then enter:/opt/ibm/ccm/agent/bin/python-agent.sh config instance_name/opt/ibm/ccm/agent/samples/python_silent_config.txtWhere instance_name is the name that you want to give to the instance.

9. To start the agent, enter:/opt/ibm/ccm/agent/bin/python-agent.sh start instance_name

v To configure the agent by running the script and responding to prompts,complete the following steps:1. Enter:

/opt/ibm/ccm/agent/bin/python-agent.sh config instance_nameWhere instance_name is the name you want to give to the instance.

2. When prompted to Edit Monitoring Agent for Python settings, enter 1 tocontinue.

3. When prompted for HTTP listening port, press Enter to accept the defaultor specify a port number.

4. When prompted for Django WSI entry points, leave this parameter blank orspecify the entry points.

5. When prompted for Minimum recorded response time, press Enter to acceptthe default or specify the time.

6. When prompted for Slow request threshold, press Enter to accept thedefault or specify a threshold.

7. When prompted for Extreme slow request threshold, press Enter to acceptthe default or specify a threshold.

8. When prompted for Profiler report interval, press Enter to accept thedefault of specify an interval.

9. To start the agent, enter:/opt/ibm/ccm/agent/bin/python-agent.sh start instance_name

What to do next

After you start the agent instance, an injection script to customize your monitoringmiddleware is generated and provided in a temporary directory.

Note: The Apache server must be started before you start the agent instance,otherwise the injection script is not created.To customize your middleware, complete the following steps:1. Execute the script using the following command:

cd /opt/ibm/ccm/agent/tmp/kpg./inject_numeric_string.sh

Where number_string is the numeric string identifying the Django application.If your temporary directory includes multiple injection scripts, execute eachscript.

2. Restart the Apache server to enable the monitoring middleware.

38 IBM Performance Management (SaaS): BETA Documentation

Page 45: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Note: Multiple injection scripts might include the enablement of the Apache statusmodule, however, when executing the scripts the module is only added once.

If you are reconfiguring the Python agent, you must execute the new injectionscripts that are generated and then restart the Apache server.

For your reference, you can use the following stop and restart commands for theApache server:v Stop: apache_bin_directory/httpd -k graceful-stop

v Restart: apache_bin_directory/httpd -k graceful

Configuring the Response Time Monitoring agentYou can customize the data displayed in the End User Transactions dashboards, byconfiguring the IP address, the type of transactions to monitor, and on which port,and by enabling and disabling Transaction Tracking. You can also enable collectionof data from browsers.

Customizing data collected by the Response Time MonitoringagentConfigure which IP address to monitor, the type of transactions to monitor, onwhich port, and whether Transaction Tracking should be enabled.

Before you begin

The following table shows the defaults used for the End User Transactionsdashboards.

ConfigurationName Setting Default Description

KT5HTTPPORTS HTTP ports tomonitor

80,9080 Ports monitored by Response Time.

KT5MONITORHTTPSAPP Monitor HTTPStransactions?

Yes Sets whether HTTPS transactions aremonitored or not.Restriction: If you enable monitoring forHTTPS transactions, ensure that you specifya keystore file and certificate. See EnablingAppliance Mode for HTTPS transactions, inthe ITCAM for Transactions documentationfor more information.

KT5KEYSTORE HTTPS keystore /opt/IBM/HTTPServer/keys/key.kdb

Contains the certificates for the remoteHTTPS websites that are being monitored.

KT5SERVERMAP HTTPS servercertificate map

tivm54,9.123.101.24,443 Maps HTTPS servers to their certificates.

KT5MONITORIP IP address of theNIC to bemonitored

9.123.101.24 If monitoring a NIC, specify its IP addresshere.

Chapter 2. Installing and configuring 39

Page 46: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

ConfigurationName Setting Default Description

KT5ENABLEINSTANCEDATAANALYTICS

Enable InstanceData Analytics?

Yes for IBM ApplicationPerformanceManagement (SaaS)

No for IBM Monitoring(SaaS)

Causes the Response Time agent to pushgranular transaction data to the monitoringservice which enables advanced analytics.

v Set to Yes to send tracking instance data tothe monitoring service. Use this optionafter you have upgraded from IBMMonitoring (SaaS) to IBM ApplicationPerformance Management (SaaS) to startsending tracking instance data to the MIN.This option enables Transaction Tracking.

v Set to No to stop sending trackinginstances to the monitoring service. Usethis option to stop sending trackinginstances for scale, network, orperformance reasons, or if you downgradeto IBM Monitoring (SaaS). This optiondisables Transaction Tracking.

About this task

These steps assume the default C:\IBM\ITM\ installation path.

Tip: If you want to deploy a customized configuration silently, a sample silentconfiguration file is installed to the following locations for you to copy andcustomize using a text editor:v On Linux systems, /opt/ibm/ccm/agent/samples/

rt_silent_config.txt

v On Windows systems, C:\IBM\ITM\samples\rt_silent_config.txt

Procedure

To customize your data settings:1. On the computer on which the Response Time agent is installed, stop the agent:

v On Linux systems, run /opt/ibm/ccm/agent/bin/rt-agent.sh stop

v On Windows systems, run C:\IBM\ITM\BIN\rt-agent.bat stop.2. Use either of the following methods to configure the agent, entering the values

you require, using the above table as a reference:Interactive configuration, where you configure the agent by running the scriptand responding to prompts:v On Linux systems, run /opt/ibm/ccm/agent/bin/rt-agent.sh

config

v On Windows systems, run C:\IBM\ITM\BIN\rt-agent.bat config.Silent configuration, where you first edit the response file and then run it withno further interaction required:v On Linux systems, run /opt/ibm/ccm/agent/bin/rt-agent.sh

config path-to-silent-installation-file

v On Windows systems, run C:\IBM\ITM\BIN\rt-agent.bat configpath-to-silent-installation-file

3. Restart the Response Time agent for the changes to take effect:

40 IBM Performance Management (SaaS): BETA Documentation

Page 47: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

v On Linux systems, run /opt/ibm/ccm/agent/bin/rt-agent.shstart

v On Windows systems, run C:\IBM\ITM\BIN\rt-agent.bat start.

Results

Data from the new source should be displayed in the End User Transactionsdashboards.

Enabling collection of data from the browserTo help you understand the performance of your web pages in a browser and anyerrors, Response Time needs to be able to collect timing data from the browser.With some simple configuration to the application you want to monitor,monitoring features can collect timing data.

About this task

Before you can monitor interactions within your web pages, you need to add theJavaScript monitoring component to your application. The JavaScript monitoringcomponent captures the state of web pages and their JavaScript interactions. Addthe JavaScript monitoring component to the application that you want to monitorso that the relevant content and actions are automatically captured and sent to themonitoring server for analysis and correlation. The results of this analysis aredisplayed in the End User Transactions dashboards.

Procedure

Complete the following steps to enable collection of real user monitoring data fromthe browser. These steps only need to be completed once, unless the applicationconfiguration changes.1. Add the JavaScript monitoring component to the application. The procedure

you use depends on the application type:a. For Java EE applications, extract install_dir/clienttime/ClientTime.war

from the installation package to a directory accessible to the server. Forexample, on Tomcat, add ClientTime.war to /var/lib/tomcat6/webapps/.

b. For non-Java EE applications, such as Ruby, .NET, Python, and Node.js,save install_dir/clienttime/tealeaf.js from the installation package to adirectory accessible to the server.

2. Associate the JavaScript monitoring component with the application.This can normally be done by modifying an application header script. Typically,only one header script needs to be modified for each component or applicationthat is to be monitored.Add the following JavaScript to the application header, before any otherJavaScript:<script language="JavaScript" src="path" type="text/JavaScript"></script>

where path is the path to the JavaScript monitoring component, which you setup in step 1.For example:<script language="JavaScript" src="/ClientTime/js/tealeaf.js"type="text/JavaScript"></script>

3. Configure the ports to be monitored in clienttime.xml. This is the port onwhich the web server is listening for incoming connections. The port field can

Chapter 2. Installing and configuring 41

Page 48: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

be found at the top of the xml file. For example, to configure the module tomonitor port 80, set the following information:<filter><port>80</port></filter>

The location of clienttime.xml depends on the system:v On Linux systems, /opt/ibm/ccm/agent/tmaitm6/wrm/linux/modules/

clienttime.xml

v On Windows systems, C:\IBM\ITM\TMAITM6_x64\wrm\Analyzer\modules\clienttime.xml

Results

Pages that are instrumented with the JavaScript monitoring component aremonitored, and data from these pages is analyzed and displayed in easy-to-useEnd User Transactions dashboards.

Configuring the Ruby agent

Before you begin

If you installed the Ruby on Rails application on a Linux system using a non-rootaccount, and you plan to collect diagnostics data, the non-root user must haveaccess to the diagnostics data collector home directory. Verify that the non-rootuser has read and write privileges on the directory /opt/ibm/ccm/agent/install-images/kkm. Provide read and write permissions using the chmod 777 command, ifrequired.

About this task

The Monitoring Agent for Ruby is a multiple instance agent; you must create thefirst instance and start the agent manually. The instance name that you specify isincluded in the managed system name, instance_name:host_name:pc, where pc isyour two character product code. The instance name that you specify is limited to28 characters, minus the length of your host name. For example, if you specifyRuby2 as your instance name, your managed system name is Ruby2:hostname:KM.

For a typical environment, in which you want to monitor all the Ruby on Railsapplications on the system automatically, you do not have to provide moreconfiguration information other than the new instance name. For a typicalenvironment, configure the agent with the default settings.

If you have multiple Ruby runtimes installed on the system, you must specify theruntime to use to gather data from your Ruby applications. The chosen Rubyruntime must be compatible with the version of Ruby on Rails that is used in theapplication. To specify the runtime to use, configure the agent with customizedsettings.

If you prefer to monitor a subset of your Ruby applications, edit each Rubyapplication that you want to monitor separately.

Procedurev Complete these steps to configure the agent with the default settings:

42 IBM Performance Management (SaaS): BETA Documentation

Page 49: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

1. To configure the agent, enter:/opt/ibm/ccm/agent/bin/ruby-agent.sh config instance_name/opt/ibm/ccm/agent/samples/ruby_silent_config.txtWhere instance_name is the name you want to give to the instance.

2. To start the agent, enter:/opt/ibm/ccm/agent/bin/ruby-agent.sh start instance_name

v Complete these steps to configure the agent with customized settings:1. To configure the agent, enter:

/opt/ibm/ccm/agent/bin/ruby-agent.sh config instance_nameWhere instance_name is the name you want to give to the instance.

2. When prompted to Edit Monitoring Agent for Ruby settings, enter 1 tocontinue.

3. When prompted for Ruby Runtime Bin Location, specify the binary directory.For example, /usr/local/rvm/rubies/ruby-2.0.0-p247/bin if you use RubyVersion Manager (RVM).

4. When prompted with Allow the Ruby agent to auto-detect all currentrunning Ruby on Rails applications, enter Y to continue.

5. When prompted for Rails Application Server, press Enter to accept thedefault of ruby or specify a name.

6. When prompted for Socket Data Source, press Enter to accept the default of0 to use the ephemeral port.

7. When prompted to Edit 'Ruby_Application' settings, enter 5 to exit.8. To start the agent, enter:

/opt/ibm/ccm/agent/bin/ruby-agent.sh start instance_name

v Complete these steps to edit each Ruby application that you want to monitorseparately:1. To configure the agent, enter:

/opt/ibm/ccm/agent/bin/ruby-agent.sh config instance_nameWhere instance_name is the name you want to give to the instance.

2. When prompted to Edit Monitoring Agent for Ruby settings, enter 1 tocontinue.

3. When prompted for Ruby Runtime Bin Location, press Enter to continue.4. When prompted with Allow the Ruby agent to auto-detect all current

running Ruby on Rails applications, enter N to continue.5. When prompted for Rails Application Server, press Enter to accept the

default of ruby or specify a name.6. When prompted for Socket Data Source, press Enter to accept the default

of 0 to use the ephemeral port.7. When prompted to Edit 'Ruby_Application' settings, enter 1 to specify

an application.8. When prompted, enter the Ruby application name.9. When prompted, enter the Ruby application home directory, for example:

/root/Ruby/myApp.10. For the last prompt, Advanced (select a section to override values),

you can enter q to exit.11. To start the agent, enter:

/opt/ibm/ccm/agent/bin/ruby-agent.sh start instance_name

Note: If you have multiple Ruby runtimes installed and you want to monitorspecific Ruby applications, you can set a runtime override on the Ruby

Chapter 2. Installing and configuring 43

Page 50: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

application or subnode. As an example, assume that you have two runtimesinstalled and four applications, three of which use one runtime and one ofwhich uses the other runtime. In this case, set the runtime most commonly usedat the agent level, and set the runtime override for the application that uses adifferent runtime.Also, see the note in step 5 of “Managing applications” onpage 98.

v Complete these steps to install the data collector and to configure support forthe collection of diagnostics data.1. Stop your Ruby on Rails application.2. Install the diagnostics data collector. Enter: gem install /opt/ibm/ccm/

agent/lx8266/km/bin/stacktracer-0.0.1.gem

Important: Install the data collector as the user you used to install and runthe Ruby on Rails application.

3. Navigate to the home directory of your application, open its Gemfile, andadd the following line to the end of the file: gem ’stacktracer’

4. In the home directory of your application, enter: bundle install

5. Restart your Ruby on Rails application.

You can enable and disable diagnostics data on the console from the AgentConfiguration page. For detailed instructions, see “Enabling diagnostics data forRuby on Rails applications” on page 103.For advanced configuration of the diagnostics data collector, complete the stepsin “Ruby agent: Advanced configuration.”

Ruby agent: Advanced configurationIf you have IBM Application Diagnostics (SaaS), you can configure the diagnosticsdata collector. Support for diagnostics data collection is enabled by default in thedata collector configuration file.

Configuring the diagnostics data collector:

You can set additional configuration options for the diagnostics data collector.

Before you begin

You must have installed the diagnostics data collector and configured support forthe collection of diagnostics data. For detailed steps, see “Configuring the Rubyagent” on page 42.

Procedure

v To modify the data collector settings of a specific application that is running:1. Navigate to the /opt/ibm/ccm/agent/install-images/kkm/dchome/

application_name/config directory and open the file instrumer_settings.rbin a text editor.

2. Modify the data collector settings:a. To enable support for the collection of diagnostics data, set the

:instrumentation_enabled property to true.b. To modify the sampling frequency of requests, set the :sample_frequency

property.The data collector collects diagnostic data only for sampled requests. Ifyou set :sample_frequency => 10, for example, data is collected for 1 inevery 10 requests.

44 IBM Performance Management (SaaS): BETA Documentation

Page 51: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

c. To limit the number of methods that are traced, set the:max_methods_to_instrument property.To disable the collection of method traces, set:max_methods_to_instrument => 0

d. To specify the methods to trace, add the class names of these methods tothe :include_subclasses_of_these_modules property.

e. To collect context data for methods, set the :include_sql_text => trueproperty to true.

f. To modify the number of traced requests to store in each file, set the:num_samples_per_file property.

g. When the value of the :num_samples_per_file property is reached, a newfile is created.

h. To increase the logging level of the diagnostics data collector, set thefollowing properties to true::verbose_request_instrumentation => false,:verbose_class_instrumentation => false,:verbose_method_instrumentation => false,

i. To disable support for diagnostics data collection, setinstrumentation_enabled =>

v To modify the data collector settings of all applications, complete these steps:1. Stop any Ruby on Rails applications that are currently running.2. Remove the instrumer_settings.rb from the /opt/ibm/ccm/agent/install-

images/kkm/dchome/application_name/config directory.3. Modify the data collector settings in Ruby_Home/gems/stacktracer-0.0.1/

config/instrumenter_settings_template.rb. For more information, see 2 onpage 44 in the procedure for modifying the data collector settings of aspecific application.

4. Restart any Ruby on Rails applications that are currently running.

Results

The configuration of the diagnostics data collector has changed for the runningapplication that you specified or for all applications.

Configuring the Tomcat agent

Before you begin

Enable JMX remote for the monitored Tomcat server. Set the port 8686. Forinstructions, see https://tomcat.apache.org/tomcat-6.0-doc/monitoring.html#Enabling_JMX_Remote.

About this task

The Tomcat agent is a multiple instance agent; you must create the first instanceand start the agent manually. The instance name that you specify is included in themanaged system name, instance_name:host_name:pc, where pc is your twocharacter product code. The instance name that you specify is limited to 28characters, minus the length of your host name. For example, if you specifyTOMCAT2 as your instance name, your managed system name isTOMCAT2:hostname:PJ.

Chapter 2. Installing and configuring 45

Page 52: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Procedurev To configure the agent with the default settings, not responding to prompts,

complete the following steps:1. Enter:

/opt/ibm/ccm/agent/bin/tomcat-agent.sh config instance_name/opt/ibm/ccm/agent/samples/tomcat_silent_config.txtWhere instance_name is the name you want to give to the instance.

2. To start the agent, enter:/opt/ibm/ccm/agent/bin/tomcat-agent.sh start instance_name

This configuration works if the Tomcat server is configured without JMXauthorization.

v To configure the agent by editing the silent response file and running the scriptwith no interaction, complete the following steps:1. Open /opt/ibm/ccm/agent/samples/tomcat_silent_config.txt in a text

editor.2. For Java home, you can specify the path where the Java virtual machine is

installed. The default location is /opt/ibm/ccm/agent/JRE/lx8266/jre.3. For JMX user ID, you can specify the ID of the user that you are using to

connect to the Tomcat MBean server. This setting is required if JMXauthorization is enabled in Tomcat.

4. For JMX password, you can specify the password of the JMX user. This settingis required if JMX authorization is enabled in Tomcat.

5. For JMX service URL, you can specify the service URL for connecting to theTomcat MBean server. The default URL is valid if the server is on the localhost and uses the port 8686. You can modify the host name and the port inthe URL, keeping the same format.

6. Save and close the tomcat_silent_config.txt file, then enter:/opt/ibm/ccm/agent/bin/tomcat-agent.sh config instance_name/opt/ibm/ccm/agent/samples/tomcat_silent_config.txtWhere instance_name is the name that you want to give to the instance.

7. To start the agent, enter:/opt/ibm/ccm/agent/bin/tomcat-agent.sh start instance_name

v To configure the agent by running the script and responding to prompts,complete the following steps:1. Enter:

/opt/ibm/ccm/agent/bin/tomcat-agent.sh config instance_nameWhere instance_name is the name you want to give to the instance.

2. When prompted to SERVER, press Enter to accept the default server name orspecify your own server name.

3. When prompted for Java home, press Enter to accept the default locationwhere the Java virtual machine is installed or specify your own location.

4. When prompted for JMX user ID, specify the ID of the user that you areusing to connect to the Tomcat MBean server. If JMX authorization is notenabled, press Enter.

5. When prompted for JMX password, specify the password of the JMX user andconfirm it. If JMX authorization is not enabled, press Enter.

6. When prompted for JMX service URL, press Enter to accept the URL orspecify another service URL for connecting to the Tomcat MBean server. Thedefault URL is valid if the server is on the local host and uses the port 8686.You can modify the host name and the port in the URL, keeping the sameformat.

46 IBM Performance Management (SaaS): BETA Documentation

Page 53: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

7. To start the agent, enter:/opt/ibm/ccm/agent/bin/tomcat-agent.sh start instance_name

What to do next

You can verify the Tomcat agent data is displayed in the Performance Managementconsole.

Configuring the WebSphere Applications agentTo monitor application server instances, you must configure the data collector, acomponent of the agent.

Before you beginv If you installed the WebSphere Application Server or Portal Server on a Linux

system using a non-root user account, verify that the non-root user has read andwrite privileges on the following agent directories:– /opt/ibm/ccm/agent/install-images/kyn/dchome/7.3.0.3.0/data

– /opt/ibm/ccm/agent/install-images/kyn/dchome/7.3.0.3.0/bin

– /opt/ibm/ccm/agent/install-images/kyn/dchome/7.3.0.3.0/runtime

– /opt/ibm/ccm/agent/install-images/kyn/dchome/7.3.0.3.0/logs

Provide read and write permissions using the chmod 777 command, if required.v If you plan to monitor application servers within a cluster, verify that the cluster

does not contain a white space.v If you are configuring WebSphere Application Server Liberty, make sure the

JAVA_HOME environment variable points to the version of the JRE that is used bythe application server.

About this task

To monitor WebSphere Portal Server instances, use the advanced configurationprocedure. For instructions, see “Configuring and reconfiguring the data collectorwith the advanced utilities” on page 50.

To monitor WebSphere Application Server instances, complete the simpleconfiguration procedure:

Procedure1. On Linux systems, log in as the user that was used to install the application

server.2. Change to the directory:

v On Windows systems, DC_home\bin. For example, C:\IBM\ITM\dchome\7.3.0.3.0\bin.

v On Linux systems, DC_home/bin. For example, /opt/ibm/ccm/agent/install-images/kyn/dchome/7.3.0.3.0/bin.

3. Run the command:v On Windows systems, simpleconfig.batv On Linux systems, ./simpleconfig.sh

4. When prompted, select the application server home directory or enter the fullpath to this directory.

Chapter 2. Installing and configuring 47

Page 54: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Important: To monitor WebSphere Application Server Liberty, you must enterthe full path to its home directory. The configuration utility can not detect thehome directory for WebSphere Application Server Liberty.

5. If prompted, select an application server profile to monitor. For WebSphereApplication Server Liberty, if prompted, select an application server instance tomonitor.

6. If prompted, enter the user name and password for a WebSphere ApplicationServer console user with administrator privileges.

7. If possible, restart the application server instance when the configuration utilityexits. Full monitoring capabilities become available.If you do not restart the application server instance, some metrics are displayedusing PMI resource monitoring. If the monitoring user interface shows noinformation for the application server instance, restart the monitoring agentcomponent of the Agent for WebSphere Applications by completing thefollowing steps:v On a Windows system:

cd C:\IBM\ITM\binwas-agent.bat stopwas-agent.bat start

v On a Linux system:cd /opt/ibm/ccm/agent/bin./was-agent.sh stop./was-agent.sh start

Results

The data collector is configured to monitor the application server instance. Thedata collector is configured within the server instances, providing maximumpossible monitoring.

Diagnostic data collection is enabled; however, to view diagnostic data, you needto have diagnostic dashboard support in your monitoring infrastructure.

Support for transaction tracking is enabled.

To view transaction tracking information, you need to have topology viewsavailable in the Performance Management console. Also, you must enabletransaction tracking in the agent configuration window.

Tip: This process configures the data collector to monitor all instances in a profile,or, for WebSphere Application Server Liberty, a single instance or multipleinstances in the same directory. To monitor more profiles or instances, repeat theconfiguration.

Important:

v If you want to configure the data collector only for resource monitoring or to setadditional options, use the advanced configuration procedure. For instructions,see “Configuring and reconfiguring the data collector with the advancedutilities” on page 50.

v If you want to change the name of the server in the monitoring user interface orif, after configuring the data collector, you have changed the administratorpassword for the application server console, reconfigure the data collector. Forinstructions, see “Configuring and reconfiguring the data collector with theadvanced utilities” on page 50.

48 IBM Performance Management (SaaS): BETA Documentation

Page 55: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Enabling transactions tracking data for WebSphere serversUse the Agent Configuration page to enable and disable transaction tracking.

Before you beginv You must install and configure the Monitoring Agent for WebSphere

Applications on the virtual machine.v You must enable support for transaction tracking in the agent. If you follow the

simple configuration procedure, the data collector is automatically configuredwith support for transaction tracking.

v Topology views must be available in the Performance Management console.

Tip: The Agent Configuration page show all the servers that are monitored by theagent. If any server is missing, it might not be correctly monitored. Check theagent log files on the monitored VM for error messages, for example, connectionerrors.

About this task

To display data in the topology dashboards, transaction tracking must be enabledfor each server you are monitoring.

Take these steps to enable or disable transaction tracking for each server.

Procedure1. From the navigation bar, select System Configuration > Agent

Configuration. The Agent Configuration page is displayed.2. Go to the WebSphere tab.3. To enable transaction tracking for one or several servers, complete these steps:

a. Select the check boxes of the servers on which you want to collecttransactions data.

b. From the Actions list, select Enable Transaction Tracking. The status in theCurrent Transaction Tracking column is updated to Yes for each selectedserver.

4. To disable transaction tracking for one or several servers, complete these steps:a. Select the check boxes of the servers on which you do not want to collect

transactions data.b. From the Actions list, select Disable Transaction Tracking. The status in

the Current Transaction Tracking column is updated to No for eachselected server.

Results

You configured transaction tracking for each selected server.

Important: If an application server restarts, you might need to enable TransactionTracking for it again.

WebSphere Applications agent: Advanced configurationThe Monitoring Agent for WebSphere Applications consists of two components, themonitoring agent and the data collector. You must configure the data collector tomonitor your application server instances.

Chapter 2. Installing and configuring 49

Page 56: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Configuring and reconfiguring the data collector with the advanced utilities:

To set additional configuration options, you can use the advanced configurationutilities (interactive or silent) to configure the data collector instead of the standardutility. You can also use advanced utilities to reconfigure the data collector when itis already configured. Also, you need to use the advanced configuration utility toconfigure monitoring WepSphere Portal Server instances.

You might need to use the advanced interactive or silent configuration utility ifyou want to use only resource monitoring or if you want to integrate the datacollector with other products.

Important: To integrate the data collector with ITCAM for SOA , you need toprovide the Tivoli® Monitoring infrastructure as well as the product on yourenvironment. The integration is not supported for WebSphere Application ServerLiberty.

When the data collector is already configured to monitor an application serverinstance, you can reconfigure it. You might need to reconfigure the data collector inthe following cases:v You want to change the name of the server in the monitoring user interface,

known as the server alias.v The administrator password for the application server console is changed.v You configured the data collector without enabling collection of diagnostic data,

and then acquired IBM Application Performance Diagnostics and want to viewdiagnostic data at server startup. (The simple configuration process does enablecollection of diagnostic data, so this situation arises if you used the interactive orsilent configuration utility).

Run the configuration and reconfiguration utilities from the bin subdirectory of thedata collector home directory:1. On Windows systems, C:\IBM\ITM\dchome\7.3.0.3.0\bin.2. On Linux systems, /opt/ibm/ccm/agent/install-images/kyn/dchome/

7.3.0.3.0/bin.

If the data collector is configured within the application server instance, use theinteractive reconfiguration script to reconfigure it. If the data collector is configuredfor resource monitoring, the reconfiguration script does not list the applicationserver instance; in this case, use the interactive configuration script.

For silent reconfiguration, always use the same procedure as for silentconfiguration.

If you installed the WebSphere application server or portal server on a Linuxsystem using a non-root user account, verify that the non-root user has read andwrite privileges to the following agent directories before you run the configurationor reconfiguration utility:v /opt/ibm/ccm/agent/install-images/kyn/dchome/7.3.0.3.0/data

v /opt/ibm/ccm/agent/install-images/kyn/dchome/7.3.0.3.0/bin

v /opt/ibm/ccm/agent/install-images/kyn/dchome/7.3.0.3.0/runtime

v /opt/ibm/ccm/agent/install-images/kyn/dchome/7.3.0.3.0/logs

Provide read and write permissions using the chmod 777 command, if required.Also, log in as the user that was used to install the application server.

50 IBM Performance Management (SaaS): BETA Documentation

Page 57: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

If you plan to monitoring application servers within a cluster, verify that thecluster does not contain a white space.

Configuring the data collector using the interactive utility:

You can use the interactive configuration utility to configure the data collector foreach application server instance that you want to monitor.

The Data Collector for WebSphere Configuration utility is a menu drivencommand-line utility for configuring the Data Collector for WebSphere.

Remember: If you have already configured the data collector within an applicationserver and you want to reconfigure it, start the Data Collector for WebSphereReconfiguration utility. However, to reconfigure a data collector configured forresource monitoring, use the Data Collector for WebSphere Configuration utility.

The utility provides a sequence of prompts to configure the data collector forintegration with several products.

To configure the data collector to monitor one or more server instances, completethe following procedure:1. If you are installing the monitoring agent where the Data Collector for

WebSphere Configuration utility is started automatically by the installer,proceed to step 4. Otherwise, from the command line, navigate to theDC_home\bin directory on Windows systems or the DC_home/bin directory onLinux systems.

2. Optionally, set the location of the Java home directory before you run theutility. For example:on Windows systems:set JAVA_HOME=C:\Progra~1\IBM\WebSphere\AppServer80\java

on Linux systems:export JAVA_HOME=/opt/IBM/AppServer80/java

Important: If you are configuring monitoring for WebSphere ApplicationServer Liberty, you must use same JVM version as the one used for theapplication server. Otherwise, the monitoring might fail.

3. Run the following command to start the configuration utility.On Windows systems:DC_home\bin\config.bat

On Linux systems:DC_home/bin/config.sh

4. The utility starts and displays the IP addresses of all network cards that arefound on the local computer system. The utility prompts you to specify theinterface to use for the data collector:List of TCP/IP interfaces discovered:

1. 9.111.98.108Enter a number [default is: 1]:

Enter the number that corresponds to the IP address to use.5. The utility searches for WebSphere Application Server home directories on the

computer system and prompts you to select a home directory:On Windows systems:

Chapter 2. Installing and configuring 51

Page 58: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

List of WebSphere Application Server home directories discovered:1. C:\Program Files\IBM\WebSphere\AppServer

Enter a number or enter the full path to a home directory[default is: 1]:

On Linux systems:List of WebSphere Application Server home directories discovered:

1. /opt/IBM/WebSphere/AppServerEnter a number or enter the full path to a home directory[default is: 1]:

Enter the number that corresponds to a WebSphere Application Server homedirectory or a full path to an application server home directory.

Important: The utility cannot find the directory for a WebSphere ApplicationServer Liberty installation automatically. In order to monitor WebSphereApplication Server Liberty, enter the full path to the WebSphere ApplicationServer Liberty home directory, for example /home/user/wlp .

6. The utility searches for all profiles under the specified home directory andprompts you to select a profile:List of WebSphere profiles discovered:

1. AppSrv01Enter a number [default is: 1]:

Enter the number that corresponds to the WebSphere Application Serverprofile that you want to configure.

7. The utility indicates whether WebSphere Global Security is enabled for theWebSphere Application profile that you specified:WebSphere Global Security is enabled.

If global security is not enabled, or if you are configuring the data collector fora WebSphere Application Server Liberty instance, skip to step 9

8. The utility prompts you to specify whether to retrieve security settings from aclient properties file:Do you want to retrieve security settings from a client properties file(soap.client.props or sas.client.props)?[1 - YES, 2 - NO] [default is: 2]:

The data collector communicates with the WebSphere Administrative Servicesusing the Remote Method Invocation (RMI) or the Simple Object AccessProtocol (SOAP) protocol. If global security is enabled for a profile, you mustspecify the user ID and password of a user who is authorized to log in to theIBM WebSphere Application Server administrative console for the profile.Alternatively, you can encrypt the user name and password and store them inclient properties files before configuring the data collector. You must use thesas.client.props file for an RMI connection, or the soap.client.props file foran SOAP connection.Enter 1 to allow the utility to retrieve the user name and password from theappropriate client properties file and skip to step 9. Otherwise, enter 2 to enterthe user name and password.Enter WebSphere admin user name:Enter WebSphere admin user password:

9. The utility searches for all application server instances under the specifiedprofile. The utility displays all servers that are not configured yet for datacollection and all servers that are configured to use the current version of theData Collector for WebSphere.

52 IBM Performance Management (SaaS): BETA Documentation

Page 59: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

The utility prompts you to select one or more application server instancesfrom the list:Choose one or more servers to configure for data collection:Application servers not yet configured:1. co098170Node01Cell.co098170Node01.server1(AppSrv01)Enter a number or numbers separated by commas, or enter * to select all:

Remember:

v For a stand-alone environment, application server instances must berunning during the configuration. (A WebSphere Application Server Libertyinstance does not need to be running).

v For a Network Deployment, WebSphere Virtual Enterprise, or WebSphereCompute Grid environment, the Node Agent and Deployment Managermust be running.

v Ensure that the application server instances that you select are the actualservers that host the applications or services that you want to monitor.

Enter the number that corresponds to the application server instance toconfigure for data collection or enter an asterisk (*) to configure all applicationserver instances for data collection. To specify a subset of servers, enter thenumbers, separated by commas, that represent the servers. For example:1,2,3.For a WebSphere Application Server Liberty server, skip to Step 11. Integrationwith ITCAM for SOA is not supported for WebSphere Application ServerLiberty.

10. In the Integration with ITCAM for SOA Agent section, the utility providesan option for integrating the data collector with the ITCAM for SOA agent.Do you want to integrate with an ITCAM for SOA Agent? [1 - YES, 2 - NO][default is: 2]:

You must provide the Tivoli Monitoring infrastructure, install and configurethe ITCAM for SOA Agent and its application support files, and optionallyconfigure topology support to complete the installation and configuration ofthe ITCAM for SOA agent. For more information about installing andconfiguring the ITCAM for SOA Agent, see IBM Tivoli Composite ApplicationManager for SOA Installation Guide.Enter 1 to integrate the data collector with the ITCAM for SOA Agent.Otherwise, enter 2.

11. In the Integration with ITCAM Agent for WebSphere Applications section,the utility provides an option for integrating the data collector with theMonitoring Agent for WebSphere Applications.

Important: You must select this integration option.Do you want to integrate with an ITCAM Agent for WebSphere Applications?[1 - YES, 2 - NO][default is: 2]:

Enter 1 to integrate the data collector with the Monitoring Agent forWebSphere Applications.

12. As you have selected integration with Monitoring Agent for WebSphereApplications, the selected server will be registered for resource (PMI)monitoring. This monitoring option provides limited metrics and works onlywith Monitoring Agent for WebSphere Applications, but does not requirerestarting the application server and can not affect performance.

Chapter 2. Installing and configuring 53

Page 60: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

The utility prompts you whether you want to configure the data collectorwithin the application server instance. The data collector is required for thefull range of operational monitoring in Application Insight and for completeoperational and diagnostic information in Application PerformanceDiagnostics. However, configuring the data collector within the applicationserver requires restarting the application server. Also, the data collector mightaffect server performance.Do you want to configure a data collector within the application server?[1 - YES, 2 - NO] [default is: 1]:

To configure the data collector within the application server, enter 1.Otherwise, enter 2 and skip to Step 16.

13. The utility prompts you whether to enable support for the collection ofdiagnostics data.Do you want to collect diagnostic data for ApplicationPerformance Diagnostics? [1 - YES, 2 - NO][default is: 2]:

If you have Application Performance Diagnostics, or might get it in the future,enter 1.

14. You are prompted to enter the host name of the monitoring agent componentof the Monitoring Agent for WebSphere Applications.Enter the host name or IP address of the ITCAM Agent forWebSphere Applications TEMA:[default is: 127.0.0.1]:

The monitoring agent is on the local host, so you do not have to change thedefault.

15. You are prompted for the port number of the monitoring agent.Enter the port number of the ITCAM Agent for WebSphere Application TEMA:[default is: 63335]:

Press Enter; do not change the default value.16. The utility prompts you for the server alias. The alias is the name of the node

in the monitoring user interface that contains the monitoring information forthis application server instance. The default is the node name combined withthe server name.Enter the server alias for server server1 in node node1 [default is: node1server1]:

Accept the default or enter another alias. If you are configuring severalapplication server instances, the utility prompts you for an alias for everyinstance.

Important: The alias can contain only the following characters: A-Z, a-z,underbar (_), dash (-), and period (.). Do not use other characters in the alias.

17. The utility prompts you for a TCP/IP port number for resource monitoring.The port is used for internal communication between components running onthe same host. The default port is 63355; if this port is in use, you can set adifferent number.Enter the internal port number for resource monitoring [default is: 63355]:

Enter a new number or press Enter to accept the default.For a WebSphere Application Server Liberty server, skip to Step 25 on page56. Integration with ITCAM for Application Diagnostics Managing Server isnot supported for WebSphere Application Server Liberty.

54 IBM Performance Management (SaaS): BETA Documentation

Page 61: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

18. In the Integration with ITCAM for Application Diagnostics ManagingServer section, the utility provides an option for integrating the data collectorwith the ITCAM for Application Diagnostics Managing Server, installed on aseparate Windows, Linux, or UNIX server, for deep-dive diagnostics. Forinformation about installing the managing server, see IBM Tivoli CompositeApplication Manager for Application Diagnostics Managing Server InstallationGuide.You are prompted to specify whether you want to integrate the data collectorwith a managing server.Do you want to integrate with an MS? [1 - YES, 2 - NO][default is: 2]:

Remember:

v To integrate the data collector with ITCAM for Application DiagnosticsManaging Server for deep-dive analysis, you must have ITCAM forApplication Diagnostics version 7.1.0.3 or later installed.

v If you decide not to configure the managing server at this time, you canstill configure the data collector to communicate with the managing serverlater.

Enter 1 to integrate with the managing server. Otherwise, enter 2 and skip tostep 21.

19. You are prompted to specify the host name of the managing server:Enter the host name or IP address of the MS[default is: 127.0.0.1]:

You are prompted to specify the port number of the managing server:Enter the code base port number of the MS[default is: 9122]:

The port number is codebase port on which the managing server is listening.The configuration tool attempts to connect to the managing server andretrieve the value for the managing server home directory. If successful, thetool displays a message similar to the following message:MS home directory is: C:\IBM\itcam\WebSphere\MS

Enter the fully qualified host name of the managing server.20. If the connection to the managing server is not successful, you are prompted

to enter the value of the managing server home directory:Enter ITCAM Managing Server install directory[default is C:\IBM\itcam\WebSphere\MS]:

If prompted, enter the value of the managing server home directory.21. The utility prompts you to specify whether you want to configure advanced

settings for the managing server.Do you want to configure advanced settings for the MS? [1 - Yes, 2 - No][default is: 2]:

Enter 1 to configure advanced settings. Otherwise, enter 2 and skip to step 25on page 56.

22. You are prompted to enter the range of RMI port numbers that the datacollector uses to accept incoming connections from the managing server:Enter the RMI port numbers [default is: 8200-8299]:

Tip: Make sure that the ports are not being blocked by a firewall or otherapplications.

Chapter 2. Installing and configuring 55

Page 62: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Enter the RMI port numbers.23. You are prompted to enter the range of Controller RMI port numbers:

Enter the range of Controller RMI port numbers[default is: 8300-8399]:

Enter the RMI Controller port numbers.24. You are prompted to enter the Remote File Sharing (RFS) port number of the

managing server:Enter the RFS port number of the MS: [default is: 9120]:

The RFS server in the managing server kernel listens to the RFS port to acceptincoming requests. Enter the RFS port number.

25. In the Support for transaction tracking section, the utility provides an optionfor enabling support for transaction tracking.Do you want to enable support for transaction tracking? [1 - YES, 2 - NO][default is: 2]:

Enter 1 to enable support for transaction tracking. Otherwise, enter 2 and skipto step 28.To view transaction tracking information, you need to have topology viewsavailable in the Performance Management console and to enable transactiontracking in the agent configuration window. For instructions about enablingtransaction tracking in the agent configuration window, see the MonitoringAgent for WebSphere Applications User's Guide.

26. You are prompted to specify the host name or IP address of the TransactionFramework Extension, which is the component of the Monitoring Agent forWebSphere Applications that gathers metrics from the data collector:Enter the host name or IP address for the Transaction Framework Extension:[default is: 127.0.0.1]:

Do not change the default value.27. You are prompted to specify the port number that the data collector uses to

connect to the Transaction Framework Extension:Enter the port number for the Transaction Framework Extension:[default is: 5457]:

Do not change the default value.For a WebSphere Application Server Liberty server, skip to Step 30 on page57. Integration with Tivoli Performance Viewer and with Applicationperformance Diagnostics Lite (in live connection mode) is not supported forWebSphere Application Server Liberty.

28. In the Integration with Tivoli Performance Viewer section, the utilityprovides an option for integrating the data collector with Tivoli PerformanceViewer (TPV).Do you want to integrate with Tivoli Performance Viewer? [1 - YES, 2 - NO][default is: 2]

ITCAM for WebSphere Application Server version 7.2 can be used to monitorthe performance of the WebSphere Application Server. Performancemonitoring infrastructure (PMI) metrics are gathered using the Data Collectorfor WebSphere and are displayed in the Tivoli Performance Viewer (TPV). TheTPV is accessible from the WebSphere Application Server administrativeconsole. ITCAM for WebSphere Application Server is installed separately fromthe WebSphere Application Server. For information about using ITCAM forWebSphere Application Server, see IBM Tivoli Composite Application Manager forWebSphere Application Server version 7.2 Support for WebSphere Application Serverversion 8.5 Installation and User Guide.

56 IBM Performance Management (SaaS): BETA Documentation

Page 63: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

ITCAM for WebSphere Application Server 7.2 support for WebSphereApplication Server 8.5 includes the Data Collector for WebSphere. Enter 1 tointegrate the Data Collector for WebSphere with the Tivoli PerformanceViewer. Otherwise, enter 2.

29. In the Integration with Application Performance Diagnostics Lite section, theutility provides an option for integrating the data collector with ApplicationPerformance Diagnostics Lite.Do you want to integrate with Application Performance Diagnostics Lite[1 - YES, 2 - NO][default is: 2]:

Application Performance Diagnostics Lite is a tool for diagnostic investigationof applications running on WebSphere Application Server and WebSpherePortal Server. Using this tool, you can analyze data in real time or you cansave diagnostic information to a file for later analysis. For more informationabout installing and using Application Performance Diagnostics Lite, see theApplication Performance Diagnostics Lite product documentation.Enter 1 to integrate the Data Collector for WebSphere with the ApplicationPerformance Diagnostics Lite. Otherwise, enter 2.

Important: If you have enabled collection of diagnostic data for ApplicationPerformance Diagnostics, the data collector is also configured to supportApplication Performance Diagnostics lite. In this case the configuration utilityskips this prompt.

30. In the Advanced Settings section, the utility provides options for performingadvanced configuration of the data collector. The utility prompts you tospecify whether to change the garbage collection log path:Do you want to specify a Garbage Collection log path? [1 - YES, 2 - NO][default is: 2]:

Enter 1 to select a garbage collection log path. Otherwise, enter 2 and skip tostep 32.

31. You are prompted to specify the garbage collection log path:Enter the GC log path:

Enter a file name with its full path. The data collector automatically modifiesthe log file name, adding the server instance information to it. For example, ifyou specify gc.log as the file name, the actual name is set toprofile_name.cell_name.node_name.server_name.gc.log for every configuredapplication server instance.

Important: In the garbage collection log path, you can use WebSpherevariables such as ${SERVER_LOG_ROOT}. However, do not use templates, such as%pid.For WebSphere Application Server Liberty, do not use variables in the path.

32. In the Data collector configuration summary section, the utility provides asummary of the data collector configuration that is to be applied to thespecified application server instances. After the summary, the utility displaysthe prompt:To modify a section, enter the number. To modify all sections, enter ’*’.To accept you configuration without modifying, enter ’a’.To quit the selection, enter ’q’:

The summary section provides options to reconfigure parts of the datacollector configuration before applying the changes and an option to exit theconfiguration utility without applying your changes. Enter the number that

Chapter 2. Installing and configuring 57

Page 64: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

represents the section you want to edit. Enter an asterisk (*) to reconfigure allsections. Enter a to accept your changes. Enter q to exit the utility withoutconfiguring the data collector.

33. When you enter a to accept your changes, you are prompted to specifywhether you want to create a backup of your current WebSphere ApplicationServer configuration:Do you want to backup current WebSphere configuration? [1 - YES, 2 - NO][default is: 2]:

Enter 1 to create a backup of the current configuration. Otherwise, enter 2.

Tip: If you are configuring PMI resource monitoring, this prompt is skipped.34. The utility applies the changes and presents a status message to indicate that

the configuration of the data collector for the profile is complete:Successfully executed config for Cell: co098170Node01CellNode: co098170Node01 Profile: AppSrv01.

35. After configuring the data collector to monitor application server instances, ifyou have enabled the data collector within the application server, you mustrestart the instances as directed by the utility. The data collector configurationtakes effect when the application server instances are restarted.If you have enabled PMI resource monitoring without enabling the datacollector within the application server, you might need to restart themonitoring agent component of the Monitoring Agent for WebSphereApplications to start the monitoring. If monitoring data is not availableimmediately, restart the monitoring agent by running the followingcommands:v On a Windows system:

cd C:\IBM\ITM\binwas-agent.bat stopwas-agent.bat start

v On a Linux system:cd /opt/ibm/ccm/agent/bin./was-agent.sh stop./was-agent.sh start

Data collection is configured for the specified application server instances.

Reconfiguring the data collector using the interactive utility:

If you configured the data collector to monitor one or more application serverinstances, you can reconfigure the data collector using the Data Collector forWebSphere Reconfiguration utility.

If PMI resource monitoring is used for an application server instance and the datacollector is not set up to integrate with any other product, reconfiguration is notavailable for the instance. Use the configuration utility to configure the datacollector for it.

Tip: In the prompts asking for agent configuration settings, the utility offers thecurrently configured values as defaults.

Important: Do not use the reconfiguration utility to change settings for aWebSphere Portal server. Instead, use the advanced configuration utility. Thisutility warns that the server is already configured, but still makes any requiredchanges.

58 IBM Performance Management (SaaS): BETA Documentation

Page 65: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

To reconfigure data collection for one or more monitored application serverinstances, complete the following procedure:1. From the command line, navigate to the DC_home\bin directory on Windows

systems or the DC_home/bin directory on Linux systems.2. Optionally, set the location of the Java home directory before you run the

utility. For example:on Windows systems:set JAVA_HOME=C:\Progra~1\IBM\WebSphere\AppServer80\java

on Linux systems:export JAVA_HOME=/opt/IBM/AppServer80/java

Important: If you are configuring monitoring for WebSphere ApplicationServer Liberty, you must use same JVM version as the one used for theapplication server. Otherwise, the monitoring might fail.

3. Run the following command to start the Data Collector for WebSphereReconfiguration utility.On Windows systems:DC_home\bin\reconfig.bat

On Linux systems:DC_home/bin/reconfig.sh

Tip: Running this utility has the same effect as running the config.bat scriptwith the -reconfig argument on Windows systems or the config.sh scriptwith the -reconfig argument on Linux systems.

4. The utility starts and displays the IP addresses of all network cards found onthe local computer system. The utility prompts you to specify the interface touse for the data collector:List of TCP/IP interfaces discovered:

1. 9.111.98.108Enter a number [default is: 1]:

5. Enter the number that corresponds to the IP address to use.6. The utility searches for all application server instances for which the data

collector is configured on this host, and prompts you to select one or moreapplication server instances from the list:Choose one or more servers to configure for data collection:Application Servers configured by the current version:1. co098170Node01Cell.co098170Node01.server1(AppSrv01)Enter a number or numbers separated by commas, or enter * to select all: 1

Remember:

v For a stand-alone environment, application server instances must berunning during the configuration.

v For a Network Deployment, WebSphere Virtual Enterprise, or WebSphereCompute Grid environment, the Node Agent and Deployment Managermust be running.

v Ensure that the application server instances that you select are the actualservers that host the applications or services that you want to monitor.

Enter the number that corresponds to the application server instance toreconfigure for data collection or enter an asterisk (*) to reconfigure allapplication server instances for data collection. To specify a subset of servers,enter the numbers, separated by commas, that represent the servers. Forexample: 1,2,3.

Chapter 2. Installing and configuring 59

Page 66: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

For a WebSphere Application Server Liberty server, skip to Step 8. Integrationwith ITCAM for SOA is not supported for WebSphere Application ServerLiberty.

7. In the Integration with ITCAM for SOA Agent section, the utility providesan option for integrating the data collector with the ITCAM for SOA agent.Do you want to integrate with an ITCAM for SOA Agent? [1 - YES, 2 - NO][default is: 2]: 1

You must provide the Tivoli Monitoring infrastructure, install and configurethe ITCAM for SOA agent and its application support files, and optionallyconfigure topology support to complete the installation and configuration ofthe ITCAM for SOA Agent. For more information about installing andconfiguring the ITCAM for SOA agent, see IBM Tivoli Composite ApplicationManager for SOA Installation Guide.Enter 1 to integrate the data collector with the ITCAM for SOA Agent.Otherwise, enter 2.

8. In the Integration with ITCAM Agent for WebSphere Applications section,the utility provides an option for integrating the data collector with the Agentfor WebSphere Applications.

Important: You must select this integration option.Do you want to integrate with an ITCAM Agent for WebSphere Applications?[1 - YES, 2 - NO] [default is: 2]: 1

Enter 1 to integrate the data collector with the Agent for WebSphereApplications.

9. As you have selected integration with ITCAM Agent for WebSphereApplications, the selected server will be registered for resource (PMI)monitoring. This monitoring option provides limited metrics and works onlywith Monitoring Agent for WebSphere Applications, but does not requirerestarting the application server and cannot affect performance.The utility prompts you whether you want to configure the data collectorwithin the application server instance. The data collector is required for thefull range of operational monitoring in Application Insight and for completeoperational and diagnostic information in Application performanceDiagnostics. However, configuring the data collector within the applicationserver requires restarting the application server. Also, the data collector mightaffect server performance.Do you want to configure a data collector within the application server?[1 - YES, 2 - NO] [default is: 1]:

To configure the data collector within the application server, enter 1.Otherwise, enter 2 and skip to Step 13 on page 61.

10. The utility prompts you whether to enable support for the collection ofdiagnostics data.Do you want to collect diagnostic data for ApplicationPerformance Diagnostics? [1 - YES, 2 - NO][default is: 2]:

If you have Application Performance Diagnostics, or might get it in the future,enter 1.

11. You are prompted to enter the host name of the monitoring agent componentof the Agent for WebSphere Applications.Enter the host name or IP address of the ITCAM Agent forWebSphere Applications TEMA:[default is: 127.0.0.1]:

60 IBM Performance Management (SaaS): BETA Documentation

Page 67: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

The monitoring agent is on the local host, so you do not have to change thedefault.

12. You are prompted for the port number of the monitoring agent.Enter the port number of the ITCAM Agent for WebSphere Application TEMA:[default is: 63335]:

Press Enter; do not change the default value.13. The utility prompts you for the server alias. The alias is the name of the node

in the monitoring user interface that contains the monitoring information forthis application server instance. The default is the node name combined withthe server name.Enter the server alias for server server1 in node node1 [default is: node1server1]:

Accept the default or enter another alias. If you are configuring severalapplication server instances, the utility prompts you for an alias for everyinstance.

Important: The alias can contain only the following characters: A-Z, a-z,underbar (_), dash (-), and period (.). Do not use other characters in the alias.

14. The utility prompts you for a TCP/IP port number for resource monitoring.The port is used for internal communication between components running onthe same host. The default port is 63355; if this port is in use, you can set adifferent number.Enter the internal port number for resource monitoring [default is: 63355]:

Enter a new number or press Enter to accept the default.For a WebSphere Application Server Liberty server, skip to Step 23 on page62. Iintegration with ITCAM for Application Diagnostics Managing Server isnot supported for WebSphere Application Server Liberty.

15. In the Integration with ITCAM for Application Diagnostics ManagingServer section, the utility provides an option for integrating the data collectorwith the ITCAM Application Diagnostics Managing Server, installed on aseparate Linux, UNIX, or Windows server, for deep-dive diagnostics. Forinformation about installing the managing server, see IBM Tivoli CompositeApplication Manager for Application Diagnostics Managing Server InstallationGuide.You are prompted to specify whether you want to integrate the data collectorwith a managing server.Do you want to integrate with an MS? [1 - YES, 2 - NO][default is: 2]: 1

Remember:

v To integrate with ITCAM for Application Diagnostics Managing Server fordeep-dive analysis, you must have ITCAM for Application Diagnosticsversion 7.1.0.3 or later installed.

v If you decide not to configure the managing server at this time, you canstill configure the data collector to communicate with the managing serverlater.

16. Enter 1 to integrate with the managing server. Otherwise, enter 2 and skip tostep 19 on page 62.You are prompted to specify the host name of the managing server:Enter the host name or IP address of the MS[default is: 127.0.0.1]: 127.0.0.1

17. Enter the fully qualified host name of the managing server.

Chapter 2. Installing and configuring 61

Page 68: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

You are prompted to specify the port number of the managing server:Enter the code base port number of the MS[default is: 9122]: 9122

The port number is the codebase port on which the managing server islistening.The configuration utility attempts to connect to the managing server andretrieve the value for the managing server home directory. If successful, theutility displays a message similar to the following message:MS home directory is: C:\IBM\itcam\WebSphere\MS

18. If the connection to the managing server is not successful, you are promptedto enter the value of the managing server home directory:Enter ITCAM Managing Server Install Directory[default is C:\IBM\itcam\WebSphere\MS]:

If prompted, enter the value of the managing server home directory.19. The utility prompts you to specify whether you want to configure advanced

settings for the managing server.Do you want to configure advanced settings for the MS? [1 - Yes, 2 - No][default is: 2]: 1

Enter 1 to configure advanced settings. Otherwise, enter 2 and skip to step 23.20. You are prompted to enter the range of RMI port numbers that the data

collector uses to accept incoming connections from the managing server:Enter the RMI port numbers[default is: 8200-8299] 8200-8299

Tip: Make sure that the ports are not being blocked by a firewall or otherapplications.Enter the RMI port numbers.

21. You are prompted to enter the range of Controller RMI port numbers:Enter the range of Controller RMI port numbers[default is: 8300-8399]: 8300-8399

Enter the RMI Controller port numbers.22. You are prompted to enter the Remote File Sharing (RFS) port number of the

managing server:Enter the RFS port number of the MS: [default is: 9120]:

The RFS server in the managing server kernel listens to the RFS port to acceptincoming requests. Enter the RFS port number.

23. In the Support for transaction tracking section, the utility provides an optionfor enabling support for transaction tracking.Do you want to enable support for transaction tracking? [1 - YES, 2 - NO][default is: 2]: 1

Enter 1 to enable support for transaction tracking. Otherwise, enter 2 and skipto step 26 on page 63To view transaction tracking information, you need to have topology viewsavailable in the Performance Management console and to enable transactiontracking in the agent configuration window. For instructions about enablingtransaction tracking in the agent configuration window, see the MonitoringAgent for WebSphere Applications User's Guide.

62 IBM Performance Management (SaaS): BETA Documentation

Page 69: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

24. You are prompted to specify the host name or IP address of the TransactionFramework Extension, which is the component of the Monitoring Agent forWebSphere Applications that gathers metrics from the data collector:Enter the host name or IP address for the Transaction Framework Extension:[default is: 127.0.0.1]:

Do not change the default value.25. You are prompted to specify the port number that the data collector uses to

connect to the Transaction Framework Extension:Enter the port number for the Transaction Framework Extension:[default is: 5457]:

Do not change the default value.For a WebSphere Application Server Liberty server, skip to Step 28 on page64. Integration with Tivoli Performance Viewer and with Applicationperformance Diagnostics Lite (in live connection mode) is not supported forWebSphere Application Server Liberty.

26. In the Integration with Tivoli Performance Viewer section, the utilityprovides an option for integrating the data collector with Tivoli PerformanceViewer (TPV).Do you want to integrate with Tivoli Performance Viewer? [1 - YES, 2 - NO][default is: 2]

ITCAM for WebSphere Application Server version 7.2 can be used to monitorthe performance of the WebSphere Application Server. Performancemonitoring infrastructure (PMI) metrics are gathered using the Data Collectorfor WebSphere and are displayed in the Tivoli Performance Viewer (TPV). TheTPV is accessible from the WebSphere Application Server administrativeconsole. ITCAM for WebSphere Application Server is installed separately fromthe WebSphere Application Server. For information about using ITCAM forWebSphere Application Server, see IBM Tivoli Composite Application Manager forWebSphere Application Server version 7.2 Support for WebSphere Application Serverversion 8.5 Installation and User Guide.ITCAM for WebSphere Application Server 7.2 support for WebSphereApplication Server version 8.5 includes the Data Collector for WebSphere.Enter 1 to integrate the Data Collector for WebSphere with the TivoliPerformance Viewer. Otherwise, enter 2 and skip to step 27.

27. In the Integration with Application Performance Diagnostics Lite section, theutility provides an option for integrating the data collector with ApplicationPerformance Diagnostics Lite.Do you want to integrate with Application Performance Diagnostics Lite[1 - YES, 2 - NO][default is: 2]:

Application Performance Diagnostics Lite is a tool for diagnostic investigationof applications running on WebSphere Application Server and WebSpherePortal Server. Using this tool, you can analyze data in real time or you cansave diagnostic information to a file for later analysis. For more informationabout installing and using Application Performance Diagnostics Lite, see theApplication Performance Diagnostics Lite product documentation.Enter 1 to integrate the Data Collector for WebSphere with the ApplicationPerformance Diagnostics Lite. Otherwise, enter 2 and skip to step 28 on page64.

Chapter 2. Installing and configuring 63

Page 70: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Important: If you have enabled collection of diagnostic data for ApplicationPerformance Diagnostics, the data collector is also configured to supportApplication Performance Diagnostics lite. In this case the configuration utilityskips this prompt.

28. In the Advanced Settings section, the utility provides options for performingadvanced configuration of the data collector. The utility prompts you tospecify whether to change the garbage collection log path:Do you want to specify a Garbage Collection log path? [1 - YES, 2 - NO][default is: 2]: 2

Enter 1 to select a garbage collection log path. Otherwise, enter 2 and skip tostep 30.

29. You are prompted to specify the garbage collection log path:Enter the GC log path:

Enter a file name with its full path. The data collector automatically modifiesthe log file name, adding the server instance information to it. For example, ifyou specify gc.log as the file name, the actual name is set toprofile_name.cell_name.node_name.server_name.gc.log for every configuredapplication server instance.

Important: In the garbage collection log path, you can use WebSpherevariables such as ${SERVER_LOG_ROOT}. However, do not use templates, such as%pid.

30. In the Data collector configuration summary section, the utility provides asummary of the data collector configuration that is to be applied to thespecified application server instances. After the summary, it displays theprompt:To modify a section, enter the number. To modify all sections, enter ’*’.To accept you configuration without modifying, enter ’a’.To quit the selection, enter ’q’:

The summary section provides options to change parts of the data collectorconfiguration before applying the changes and an option to exit theconfiguration tool without applying your changes. Enter the number thatrepresents the section that you want to edit. Enter an asterisk (*) toreconfigure all sections. Enter a to accept your changes. Enter q to exit theutility.

31. When you enter a to accept your changes, you are prompted to specifywhether you want to create a backup of your current WebSphere ApplicationServer configuration:Do you want to backup current WebSphere configuration? [1 - YES, 2 - NO][default is: 2]:

32. Enter 1 to create a backup of the current configuration. Otherwise, enter 2.33. The utility applies the changes and presents a status message to indicate that

the reconfiguration of the data collector for the profile is complete:Successfully executed Reconfiguring for Cell: v525400597750Node01CellNode: v525400597750Node01 Profile: AppSrv01

34. After reconfiguring the data collector to monitor application server instances,you must restart the instances as directed by the utility. The data collectorconfiguration takes effect when the application server instances are restarted.

Data collection is reconfigured for the specified application server instances.

64 IBM Performance Management (SaaS): BETA Documentation

Page 71: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Configuring or reconfiguring the data collector in silent mode:

If you want to configure or reconfigure many application server instances, it mightbe more convenient to configure the data collector in silent mode. Use the sameprocedure for configuration and reconfiguration.

When you configure the data collector in silent mode, you first specifyconfiguration options in a properties file. A sample properties file,sample_silent_config.txt, is packaged with the configuration utility. The file isavailable in the DC_home\bin directory. The DC_home variable is the location wherethe data collector is installed.

Complete the following steps to perform a silent configuration:1. Specify configuration options in the properties file. You can copy the sample

properties file and change the required options.2. Set the location of the Java home directory before you run the utility. For

example:on Windows systems:set JAVA_HOME=C:\Progra~1\IBM\WebSphere\AppServer80\java

on Linux systems:export JAVA_HOME=/opt/IBM/AppServer80/java

Important: If you are configuring monitoring for WebSphere ApplicationServer Liberty, you must use same JVM version as the one used for theapplication server. Otherwise, the monitoring might fail.

3. Go to the DC_home\bin directory on Windows systems or the DC_home/bindirectory on Linux systems.

4. Run the following command:On Windows systems:config.bat -silent [dir_path]\silent file

On Linux systems:config.sh -silent [dir_path]/silent file

5. After configuring the data collector to monitor application server instances, ifyou have enabled the data collector within the application server, you mustrestart the instances. The data collector configuration takes effect when theapplication server instances are restarted.If you have enabled PMI resource monitoring without enabling the datacollector within the application server, you might need to restart the monitoringagent component of the Agent for WebSphere Applications to start themonitoring. If monitoring data is not available immediately, restart themonitoring agent by running the following commands:v On a Windows system:

cd C:\IBM\ITM\binwas-agent.bat stopwas-agent.bat start

v On a Linux system:cd /opt/ibm/ccm/agent/bin./was-agent.sh stop./was-agent.sh start

Chapter 2. Installing and configuring 65

Page 72: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Properties file

When you create your properties file, keep in mind the following considerations:v A line in the file that starts with a number sign (#) is treated as a comment, and

is not processed. If the number sign is used elsewhere in the line, it is notconsidered to be the start of a comment.

v Each property is described on a separate line, in the following format: property =value.

propertyName of property. The list of valid properties that you can configure isshown in Table 5.

value Value of the property. Default values for some properties are alreadyprovided. You can delete default values to leave property values blankor empty. An empty value is treated as if the property is not specified, asopposed to using the default value. If you want to use default values,you can comment out the property in the file.

v Passwords are in plain text.v Properties and their values are case-sensitive.

Table 5 describes the properties that are available when configuring the datacollector in silent mode.

Important: If you are configuring the Data Collector for a WebSphere ApplicationServer Liberty instance, some of the properties are not used.

Table 5. Available properties for running the configuration utility in silent mode

Property Comment

default.hostip If the computer system uses multiple IP addresses, specify the IP address for thedata collector to use.

Integration of the data collector with the ITCAM for Application Diagnostics Managing ServerImportant: The Managing Server is only available if you have ITCAM for Application Diagnostics. For a WebSphere

Application Server Liberty instance, these properties are not used.

ms.connect Specifies whether the data collector is configured to connect to the managing serverin an ITCAM for Application Diagnostics environment. Valid values are True andFalse.

ms.kernel.host Specifies the fully qualified host name of the managing server.

ms.kernel.codebase.port Specifies the codebase port on which the managing server is listening.

ms.am.home Specifies the managing server home directory.

ms.am.socket.bindip Specifies the IP address or host name to be used by the data collector tocommunicate with the managing server. If more than one network interface or IPaddress is configured on data collector computer system, choose one of them.

ms.firewall.enabled Specifies whether a firewall is enabled on the data collector host or you have specialrequirements to change the RMI ports for the data collector. Valid values are Trueand False.

ms.probe.controller.rmi.port If the data collector is behind a firewall or you have special requirements to changethe Controller RMI port of data collector, set this port number range. Configure thisport number as permitted by the firewall for the data collector host. For example:ms.probe.controller.rmi.port=8300-8399 or ms.probe.controller.rmi.port=8300.

ms.probe.rmi.port If the data collector is behind a firewall, or you have special requirements to changethe RMI port of data collector, set this port number range. Configure this portnumber as permitted by the firewall for the data collector host. For example:ms.probe.rmi.port=8200-8299 or ms.probe.rmi.port=8200.

66 IBM Performance Management (SaaS): BETA Documentation

Page 73: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Table 5. Available properties for running the configuration utility in silent mode (continued)

Property Comment

Support for transaction tracking

To view transaction tracking information, you need to have topology views available in the PerformanceManagement console and to enable transaction tracking in the agent configuration window. For instructions about

enabling transaction tracking in the agent configuration window, see the Monitoring Agent for WebSphere ApplicationsUser's Guide.

ttapi.enable Specifies whether the data collector supports transaction tracking. Valid values areTrue and False.

ttapi.host Specifies the host of the Transaction Framework Extension, which is the componentof the Monitoring Agent for WebSphere Applications that gathers metrics from thedata collector. use the local host value, 127.0.0.1.

ttapi.port Specifies the port of the Transaction Framework Extension. Use 5457.

Integration of the data collector with ITCAM for SOAImportant: For a WebSphere Application Server Liberty instance, this property is not used.

soa.enable Specifies whether to integrate the data collector with ITCAM for SOA. The ITCAMfor SOA agent must be installed to complete the configuration.

Integration of the data collector with the Tivoli Performance MonitoringImportant: For a WebSphere Application Server Liberty instance, this property is not used.

tpv.enable Specifies whether to integrate the data collector with the Tivoli PerformanceMonitoring when the data collector is included as part of ITCAM for WebSphereApplication Server version 8.5. Tivoli Performance Monitoring is accessed with theWebSphere Application Server administrative console. Valid values are True andFalse.

Integration of the data collector with Application Performance Diagnostics LiteImportant: For a WebSphere Application Server Liberty instance, this property is not used.

de.enable Specifies whether to collect diagnostics data, required for Application PerformanceDiagnostics and Application Performance Diagnostics Lite. Enable this integration ifyou have Application Performance Diagnostics or might have it in the future. Validvalues are True and False.

Application Performance Diagnostics Lite is a tool for diagnostic investigation ofapplications running on WebSphere Application Server and WebSphere PortalServer. Using this tool, you can analyze data in real time or you can save diagnosticinformation to a file for later analysis.

PMI resource and data collector monitoring

The selected server is always configured for resource (PMI) monitoring, without any changes to the applicationserver. This monitoring option provides limited metrics and works only with ITCAM Agent for WebSphere

Applications, but does not require restarting the application server and can not affect performance.

tema.appserver Specifies whether you want to configure the data collector within the applicationserver instance. The data collector is required for the full range of metrics in ITCAMAgent for WebSphere Applications and for integration with any other products.However, configuring the data collector requires restarting the application server.Also, the data collector might affect server performance. Valid values are True andFalse. If this parameter is set to False, data collector configuration parameters forintegrating with products other than ITCAM Agent for WebSphere Applications aredisregarded.

jmx.admin.port TCP/IP port number for resource monitoring. The port is used for internalcommunication between components running on the same host. The default port is63355; if this port is in use, you can set a different number.

Integration of the data collector with the Monitoring Agent for WebSphere Applications monitoring agent andwith Application Performance Diagnostics Lite

Chapter 2. Installing and configuring 67

Page 74: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Table 5. Available properties for running the configuration utility in silent mode (continued)

Property Comment

temaconnect Specifies whether the data collector connects to the Agent for WebSphereApplications monitoring agent. Valid values are True and False.Important: You must use the True value to use the Agent for WebSphereApplications

tema.appserver Specifies whether you want to configure the data collector within the applicationserver instance. This configuration required for the full range of metrics in theAgent for WebSphere Applications and for integration with any other products.However, it requires restarting the application server. Also, the data collector mightaffect server performance. Valid values are True and False.

If this parameter is set to False, data collector configuration parameters forintegrating with products other than ITCAM Agent for WebSphere Applications aredisregarded, as well as the tema.host and tema.port parameters.

jmx.admin.port TCP/IP port number for resource monitoring. The port is used for internalcommunication between components running on the same host. The default port is63355; if this port is in use, you can set a different number.

tema.host Specifies the fully qualified host name or IP address of the ITCAM Agent forWebSphere Applications monitoring agent. Us ethe local host address (127.0.0.1).

tema.port Specifies the port number of the ITCAM Agent for WebSphere Applicationsmonitoring agent. Do not change the default value of 63335.

de.enable Specifies whether to collect diagnostics data, required for Application PerformanceDiagnostics and Application Performance Diagnostics Lite. Valid values are Trueand False.

Enable this integration if you have Application Performance Diagnostics or mighthave it in the future. In this case, collection of diagnostic data is enabled at serverstartup. Otherwise, it is disabled at startup; you can enable it using the AgentConfiguration page in the user interface, but if the server is restarted, collection ofdiagnostic data is disabled again.

This setting also enables integration with Application Performance Diagnostics Lite,a tool for diagnostic investigation of applications running on WebSphereApplication Server and WebSphere Portal Server. Using this tool, you can analyzedata in real time or you can save diagnostic information to a file for later analysis.

WebSphere Application Server backup

was.backup.configuration Specifies whether to back up the current configuration of the WebSphereApplication Server configuration before applying the new configuration. Validvalues are True and False.

was.backup.configuration.dir Specifies the location of the backup directory.

Advanced configuration settings

was.gc.custom.path Specifies whether to set a custom path for the Garbage Collection log.

was.gc.file Specifies the path to the custom Garbage Collection log. Set this value to a file namewith its full path. The data collector automatically modifies the log file name,adding the server instance information to it. For example, if you specify gc.log asthe file name, the actual name is set toprofile_name.cell_name.node_name.server_name.gc.log for every configuredapplication server instance.Important: In the Garbage Collection log path, you can use WebSphere variables,such as ${SERVER_LOG_ROOT}. However, do not use templates, such as %pid.

WebSphere Application Server connection settings

68 IBM Performance Management (SaaS): BETA Documentation

Page 75: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Table 5. Available properties for running the configuration utility in silent mode (continued)

Property Comment

was.wsadmin.connection.host Specifies the name of the host to which the wsadmin tool is connecting. In aNetwork Deployment environment, specify the wsadmin connection to theDeployment Manger. In a stand-alone environment, specify the wsadmin connectionto the server.

was.wsadmin.connection.type Specifies the connection protocol for the wsadmin tool to use.

was.wsadmin.connection.port Specifies the port that the wsadmin tool must use to connect to the WebSphereApplication Server.

WebSphere Application Server global security settings

was.wsadmin.username Specifies the user ID of a user who is authorized to log in to the IBM WebSphereApplication Server administrative console. This user must have the agent role onthe application server.

was.wsadmin.password Specifies the password that corresponds to the user specified in thewas.wsadmin.username property.

was.client.props Specifies whether to retrieve security settings from a client properties file. Possiblevalues are True and False.

WebSphere Application Server settings

was.appserver.profile.name Specifies the name of the application server profile that you want to configure. Notused for WebSphere Application Server Liberty.

was.appserver.home Specifies the WebSphere Application Server home directory.

was.appserver.cell.name Specifies the WebSphere Application Server cell name. Not used for WebSphereApplication Server Liberty.

was.appserver.node.name Specifies the WebSphere Application Server node name. Not used for WebSphereApplication Server Liberty.

WebSphere Application Server runtime instance settings

was.appserver.server.name Specifies the application server instance within the application server profile toconfigure.Tip: The silent response file can have multiple instances of this property.

tema.serveralias Specifies the name of the node in monitoring user interface that contains themonitoring information for this application server instance. The default is the nodename combined with the server name.Important: The alias can contain only the following characters: A-Z, a-z, underbar(_), dash (-), and period (.). Do not use other characters in the alias.Tip: The silent response file can have multiple instances of this property.

Additional data collector settings:

You can modify data collector configuration files to change additional monitoringsettings.

Properties files for the Data Collector:

Several properties files control data collector configuration and behavior.

The properties files, and other files that are used by the data collector, are locatedunder the data collector home directory (DC_home). The data collector homedirectory is:1. On Windows systems, C:\IBM\ITM\dchome\7.3.0.3.0.2. On Linux systems, /opt/ibm/ccm/agent/install-images/kyn/dchome/7.3.0.3.0.

Chapter 2. Installing and configuring 69

Page 76: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

For most common changes to this configuration, you must edit the data collectorproperties file and the toolkit properties file.

To change the configuration for collecting detailed diagnostic information, changethe gdc.properties file. For details about this file, see “Configuring collection ofdetailed diagnostic information” on page 76.

Important: After changing a configuration file, restart the monitored applicationserver instance. Then the changes will take effect.

The Data Collector properties file

Each application server instance that is monitored by the data collector has its ownproperties file. The data collector automatically creates the properties file. Thename of the file is DC_home/runtime/appserver_version.node_name.profile_name.server_name/datacollector.properties.

However, to facilitate future upgrades, do not change this file.

Instead, add the settings that you want to modify to the data collector customproperties file. This file is named DC_home/runtime/app_server_version.node_name.profile_name.server_name/custom/datacollector_custom.properties. Settings in the data collector custom propertiesfile override the values that are in the data collector properties file.

Important: If the DC_home/runtime/app_server_version.node_name.profile_name.server_name/custom/datacollector_custom.properties file does not exist, create it when you want tomake changes. You might also have to create the custom directory.

The toolkit properties file

The toolkit properties file is automatically created by the data collector at startup,using various input files. It is unique for every application server instancemonitored by the data collector. Its name is DC_home/runtime/appserver_version.node_name.profile_name.server_name/toolkit.properties.

Because this file is re-created at each data collector startup, do not make anychanges to this file; if you do, they will be overwritten.

Instead, add the settings that you want to modify to the toolkit custom propertiesfile. This file is named DC_home/runtime/app_server_version.node_name.profile_name.server_name/custom/toolkit_custom.properties. Settings in the toolkit custom properties file overridethe values in the toolkit properties file.

You can also set toolkit properties for all the application server instances that aremonitored by this installation of the data collector. To do this, add the settings tothe global toolkit custom properties file: DC_home/runtime/custom/toolkit_global_custom.properties. However, if a property is set in theinstance-specific toolkit_custom.properties file, it overrides the value in theglobal file for this instance.

Important: If the DC_home/runtime/app_server_version.node_name.profile_name.server_name/custom/

70 IBM Performance Management (SaaS): BETA Documentation

Page 77: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

toolkit_custom.properties or DC_home/runtime/custom/toolkit_custom.properties file does not exist, create it when you want to makechanges. You might also have to create the custom directory.

Other properties files

The following properties files are unique for every application server instancemonitored by the data collector:v DC_home/runtime/appserver_version.node_name.profile_name.server_name/

custom/gdc/gdc_custom.properties defines the details for collecting diagnosticand method trace data. For information about changing this file, see“Configuring collection of detailed diagnostic information” on page 76.

v DC_home/runtime/app_server_version.node_name.profile_name.server_name/cynlogging.properties defines the log file names and logging details for theJava portion of the data collector.

v DC_home/runtime/app_server_version.node_name.profile_name.server_name/cyn-cclog.properties defines the log file names and logging details for the C++portion of the data collector.

v DC_home/runtime/appserver_version.node_name.server_name/kwjdc.propertiesdefines communication with the monitoring agent, including the host name andport for the monitoring agent host.

Data collector log files

The default location for the log files generated by the data collector configurationutility is DC_home\data on Windows systems and DC_home/data on Linux systems.

The following table describes log files generated before and during theconfiguration process

Table 6. Log files generated before and during the configuration process

Full path name Description

DC_home/data/config-console.log User input while the config or reconfig script isrunning.

DC_home/data/config-message.log Messages generated while the config or reconfig scriptis running.

DC_home/data/config-trace.log Debug messages generate while the config or reconfigscript is running.

DC_home/data/reconfig.log Log written during the reconfiguration of data collectorfor application servers.

DC_home/data/unconfig-console.log User input while the unconfig script is running.

DC_home/data/unconfig-message.log Messages generated while the unconfig script is running.

DC_home/data/unconfig-trace.log Debug messages generated while the unconfig script isrunning.

DC_home/data/profile.cell.node.configdatacollector.log

For example: default.beta85.tvt6080.configdatacollector.log

Log written by the wsadmin script(configDataCollector.py) during configuration updatesto WebSphere Application Server.

Chapter 2. Installing and configuring 71

Page 78: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Table 6. Log files generated before and during the configuration process (continued)

Full path name Description

DC_home/data/profile.cell.node.unconfigdatacollector.log

For example: default.beta85.tvt6080.unconfigdatacollector.log

Log written by the wsadmin script(unconfigDataCollector.py ) during unconfigurationupdates to WebSphere Application Server.

DC_home/data/profile.findservers.log

For example: default.findservers.log

Log generated by findSevers.py. The file is used fordiagnosing problems with the find servers process.

DC_home/data/node.server_valCheck.log

For example: tvt6080_rd-test_valCheck.log

Log generated by WebSphere Application Sever validitychecking.

The data collector trace files are stored by default in the following locations:v On Windows systems: DC_home\logs\CYN\logs.v On Linux systems: DC_home/logs/CYN/logs.

Restriction: For log and trace file names that include profile, cell, node, or servervariables, when any of these variables includes non-ascii characters, the non-asciicharacters are converted to ascii characters.

Disabling various types of Byte Code Instrumentation for JEE APIs:

In Byte Code Instrumentation (BCI), the data collector intercepts method entry andexit calls for various types of Java APIs in order to create an execution flow of eachapplication request. Some resources are used for the monitoring. You can tune thedata collector so that some of the APIs are not monitored, reducing resource use.

To disable BCI monitoring for JEE APIs, add the following properties to the toolkitcustom properties file. For more information about this file, see “The toolkitproperties file” on page 70.

Table 7. Adding lines to the toolkit custom properties file

Type of JEE API Line to add to toolkit_custom.properties file

EnterpriseJavaBeans (EJB)

com.ibm.tivoli.itcam.toolkit.ai.enableejb=false

Java ConnectorArchitecture (JCA)

com.ibm.tivoli.itcam.toolkit.ai.enablejca=false

Java DatabaseConnectivity(JDBC)

com.ibm.tivoli.itcam.toolkit.ai.enablejdbc=false

Java Naming andDirectory Interface(JNDI)

com.ibm.tivoli.itcam.toolkit.ai.enablejndi=false

Java MessageService (JMS)

com.ibm.tivoli.itcam.toolkit.ai.enablejms=false

Web containersforServlets/JavaServer Pages(JSP)

com.ibm.tivoli.itcam.dc.was.webcontainer=false

72 IBM Performance Management (SaaS): BETA Documentation

Page 79: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Table 7. Adding lines to the toolkit custom properties file (continued)

Type of JEE API Line to add to toolkit_custom.properties file

HTTP sessioncount tracking

com.ibm.tivoli.itcam.toolkit.ai.enablesessioncount=false

CICS® TransactionGateway (CTG)

com.ibm.tivoli.itcam.dc.ctg.enablectg=false

IMS™com.ibm.tivoli.itcam.dc.mqi.enableims=false

Java Data Objects(JDO)

com.ibm.tivoli.itcam.dc.mqi.enablejdo=false

Message QueueInterface (MQI)

com.ibm.tivoli.itcam.dc.mqi.enablemqi=false

Axis web service com.ibm.tivoli.itcam.toolkit.ai.axis.enablewebservice=false

Remote MethodInvocation (RMI)

am.ejb.rmilistener.enable=false

IBM WebSphereApplication ServerEJB container

com.ibm.tivoli.itcam.dc.was.enableEJBContainer=false

Modifying performance monitoring infrastructure settings:

The data collector modifies the level of instrumentation for PerformanceMonitoring Infrastructure (PMI) on the monitored application server instance. Thedefault configuration is sufficient to supply the viewable monitoring data. You cancustomize this setting.

To customize these settings, in the data collector custom properties file (for moreinformation about this file, see “The Data Collector properties file” on page 70),modify the following properties:v To change the settings to a level predefined in the application server, use the

am.was6pmi.settings.2 property. Set it to basic, extended, or all.v For fine-grained customization of the instrumentation for a particular PMI

module, use the am.was6custompmi.settings.2 property. It has the formatmodule_type=number1,number2,..., for example:am.was6custompmi.settings.2=beanmodule=1,2,3,4,5,6,7,8,9,10,14,15,19,20,21,22,23

Use * to monitor all IDs in the module, or none to monitor none.In particular, to configure the data collector to collect Service Integration Bus(SIB) data, use the following setting:am.was6custompmi.settings.2=SIB Service=*

v If you do not want the data collector to modify the level of instrumentation forPMI, add the following line to the data collector custom properties file (see “TheData Collector properties file” on page 70):am.pmi.settings.nochange=true

Tip: The am.was6pmi.* property names are also valid for monitoring version 7,version 8, and version 8.5 application servers.

Tip: Ignore the properties named am.was6pmi.1, am.was6pmi.3,am.was6custompmi.settings.1, am.was6custompmi.settings.3. They are not in usefor the Monitoring Agent for WebSphere Applications.

Chapter 2. Installing and configuring 73

Page 80: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Important: To apply changes to PMI settings, restart the application serverinstance.

Enabling and disabling data collector memory monitoring:

The data collector can monitor the amount of native memory that the data collectoritself uses. You can view the results in a log file on the server. This capability isdisabled by default; you can use it to diagnose performance of the data collector.

If you enable data collector memory monitoring, the data collector saves memoryusage statistics to the DC_home/logs/CYN/logs/trace-dc-native.log trace log file.

The statistics reflect data collector memory consumption on the native side. TheJava side memory consumption is not reflected in the logged numbers.

To enable memory monitoring, set the following property in the data collectorcustom properties file :log.statistics=true

For more information about the data collector custom properties file, see “The DataCollector properties file” on page 70.

By default, the statistics are logged once every 30 seconds. You can set a differentperiod, in milliseconds, in the log.statistics.frequency property in the datacollector custom properties file. For example, to log memory usage statistics onceevery 10 seconds, use the following setting:log.statistics.frequency=10000

To disable memory monitoring, set the following property in the data collectorcustom properties file:log.statistics=false

What to do when deleting an application server profile: If you do not unconfigure thedata collector before you delete an application server profile, data collectorinstallation log and runtime data remains in the system, and running theWebSphere update command fails (typically with a JACL failed error message).

Unconfigure the data collector for all monitored application server instances in aprofile before deleting it.

Settings for the data collector if Java 2 security is enabled: By default, data collectorconfiguration enables Java 2 security on the application server, and sets apermissive policy. This policy ensures that the data collector can run properly, andprovides no other security protection. If you need a more restrictive policy,complete the following procedure to ensure that the policy becomes active and thedata collector can still work properly.

The data collector sets the Java security policy file location for all monitoredapplication server instances (java.security.policy system property) toDC_home/itcamdc/etc/datacollector.policy. You must edit this file in thefollowing way:1. Remove all existing content.2. Copy the sample security policy for the data collector from the

DC_home/itcamdc/etc/datacollector.security.policy file.

74 IBM Performance Management (SaaS): BETA Documentation

Page 81: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

3. If ITCAM for Transactions is installed on the server, add a grant statement forthe ITCAM for Transactions code base to the security policy file. Follow themodel for the grant statements provided in the sampledatacollector.security.policy file, but use the ITCAM for Transactionsinstallation root directory in the codeBase statement.

4. Add your required security policy settings.5. Save the file, and create a backup copy.

Important: Each time you configure or reconfigure the data collector for anapplication server instance, the file DC_home/itcamdc/etc/datacollector.policymight be overwritten. To ensure that your security policy remains active, restorethis file from the backup copy after configuring or reconfiguring the data collectorfor any application server instance.

Defining custom requests:

By default, only certain types of Java classes and methods are monitored asrequests by the data collector. Servlets, JSPs, EJB business methods, and certainstandard J2EE APIs are recognized as requests. You can designate additionalclasses and methods as custom requests.

For example, the data collector does not recognize Struts Action classes as requestsby default. However, you can set up custom request definitions and cause theactions to be recognized as Nested Requests.

Complete the following procedure to enable monitoring of custom requests anddesignate one or more methods as custom requests:1. Make a copy of the DC_home/itcamdc/etc/custom_requests.xml file in a

temporary location. Then, open the copy in a text editor.2. Modify the parameters in the file. The following table describes the parameters

that you can modify:

Table 8. Parameters for the custom requests configuration file

Tag name Description

edgeRequest Identifies one or more application methods that are to be Byte-Code-Instrumented for customrequest processing. By modifying the requestName, Matches, type, and methodName tags withinthe edgeRequest tag, you can customize the selection.

Each edgeRequest tag must contain exactly one methodName tag, and one or more Matchestags. Multiple edgeRequest tags can be specified.

requestName Defines a unique name for this request. The request name is displayed to the user when themethod entry and exit are traced.

Matches Identifies a class or classes that contain the methods that are to be Byte-Code-Instrumentedfor custom request processing. Multiple Matches tags can be present within a singleedgeRequest tag.

type Indicates whether a class must be a system or application class in order to match theedgeRequest tag.

methodName Identifies the names of the methods within one of the classes identified by the Matches tagthat are to be Byte-Code-Instrumented for custom request processing. Exactly one methodNametag can be specified in each edgeRequest tag.

requestMapper Optional. If this tag is specified, the data collector uses a request mapper to determineinformation that identifies the request. You can define nonstandard ways of extracting thisinformation. For more information about enabling and defining request mappers, see theAgent for WebSphere Applications reference in Service Management Connect.

Chapter 2. Installing and configuring 75

Page 82: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

The Matches and methodName tags can include wildcard characters. Thefollowing section describes how the wildcard characters works:v Asterisk (*) stands for zero or more occurrences of any character when used

by itself. When embedded within a sequence of characters (for example,java.*.String), it matches zero or more occurrences of any character exceptthe package separator (.).

v Two periods (..) can be used to specify all subpackages. It matches anysequence of characters that starts and ends with the package separator (.).For example, java..String matches java.lang.String and com.ibm..*matches any declaration beginning with com.ibm.

For example, an application with a package name of com.mycompany.myapp hasthe following requirements:v Within the Customer class, the creditCheck() method must be treated as a

custom request called CreditCheck.v Within the Supplier class, the inventoryCheck() method must be treated as a

custom request called SupplyCheck.

The following example shows the contents of the customizedcustom_requests.xml file that accomplishes this:

<customEdgeRequests><edgeRequest>

<requestName>CreditCheck</requestName><Matches>com.mycompany.myapp.Customer</Matches><type>application</type><methodName>creditCheck</methodName>

</edgeRequest><edgeRequest>

<requestName>SupplyCheck</requestName><Matches>com.mycompany.myapp.Supplier</Matches><type>application</type><methodName>inventoryCheck</methodName>

</edgeRequest></customEdgeRequests>

3. Complete one of the following steps:v Save the file in the DC_home/runtime/

app_server_version.node_name.server_name/custom directory. Then, in thetoolkit custom properties file, set the propertyam.camtoolkit.gpe.customxml.custom to the name (without path) of the filethat you modified in Step 2 on page 75. For more information about thetoolkit custom properties file, see “The toolkit properties file” on page 70.

v Save the file in any directory on your computer. Then, in the toolkit customproperties file , set the property am.camtoolkit.gpe.customxml.custom to thepath and name for the file that you modified in Step 2 on page 75. For moreinformation about the toolkit custom properties file, see “The toolkitproperties file” on page 70.

Configuring collection of detailed diagnostic information:

The data collector collects detailed diagnostic information on the monitoredapplication server instance. This information can be displayed in the diagnosticdashboards. Use the Application Performance Management console user interfaceto enable and disable collection of diagnostic and method trace information. Toconfigure the behaviour of the diagnostic data collection, including the amount ofdiagnostic information that the data collector stores, change thegdc_custom.properties configuration file.

76 IBM Performance Management (SaaS): BETA Documentation

Page 83: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Setting limits for the size and number of detailed information files

The data collector stores diagnostic information in a number of files. By default, itstores 100 files; if 100 files are already stored and a new file is created, the oldestfile is deleted. The data collector creates a new file every 15 minutes, or when thesize of the current file exceeds 200 megabytes. When the total size of the directorycontaining the files exceeds 2 gigabytes, the data collector deletes the oldest file.

You can change the following settings in the DC_home/runtime/appserver_version.node_name.profile_name.server_name/custom/gdc/gdc_custom.properties file:v To set the maximum amount of files with diagnostic information, set the

com.ibm.itcam.gdc.dfe.filelimit property, for example:com.ibm.itcam.gdc.dfe.filelimit=100

v To set the time, in minutes, after which the data collector creates a newdiagnostic data file, set the com.ibm.itcam.gdc.dfe.frequency property, forexample:com.ibm.itcam.gdc.dfe.frequency=15

v To set the maximum diagnostic data file size, in megabytes, set thedfe.file.maxlimit property, for example:dfe.file.maxlimit=200

If the current diagnostic data file reaches this size, the data collector creates anew diagnostic data file.

v To set the maximum total size of all data files, in bytes, set thetrace.dir.size.limit property, for example:trace.dir.size.limit=2147483648

If the sum of the sizes of all the diagnostic data files exceeds this value, the datacollector deletes the oldest data file. The minimum total size is 25 megabytes.

Setting full or partial collection of request and method diagnostic data

The data collector has the following default settings:v The data collector collects diagnostic data only for selected requests. The

selection (sampling) of the requests aims to include all errors and some goodrequests.

v Method data collection is disabled at server startup. You can use the AgentConfiguration page in the user interface to enable it.

v When method data collection is enabled, the data collector gathers method dataonly for some requests (of those for which diagnostic data is collected). Thisfurther selection (sampling) again aims to include all errors and some goodrequests.

You can change these settings using properties in the DC_home/runtime/appserver_version.node_name.profile_name.server_name/custom/gdc/gdc_custom.properties file.

Important: Changing these settings affects performance of the application server.On production servers, the performance degradation might be critical

To collect diagnostic data for every request, set the property:dc.sampling.enable=false

Chapter 2. Installing and configuring 77

Page 84: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

To enable method data collection at server startup, set the property:dfe.enable.methoddata=true

To enable collecting method data for every request for which diagnostic data iscollected, set the property:dc.sampling.methsampler.enabled=false

Tip: The dc.sampling.methsampler.enabled property has effect only when methoddata collection is enabled. To enable method data collection, use the AgentConfiguration page or the dfe.enable.methoddata property.

You can set other properties in the DC_home/runtime/appserver_version.node_name.profile_name.server_name/custom/gdc/gdc_custom.properties file to customize collection of diagnostic data. Thecomments in the file describe the properties.

Important: After changing the configuration file, restart the monitored applicationserver instance. Then the changes will take effect.

Configuring agents to communicate through a forward proxyTo forward your monitoring agent traffic through a forward proxy, edit the agentenvironment configuration file to set the KDH_FORWARDPROXY environment variable.

Before you begin

The monitoring agent does not support authenticating proxies.

A TCP connection is used to connect the monitoring agent to the forward proxy, aswell as the forward proxy to the IBM Performance Management (SaaS) gateway orserver.

If you want to have your monitoring agents communicate using an SSL proxy, itmust support Transport Layer Security (TLS) V1.2 and Elliptic Curve Certificates.IBM HTTP Server and Apache 2 meet the support requirements.

Procedure1. Open the agent environment configuration file in a text editor.

Open the agent install_dir/config/pc.ini file, where pc is theagent's product code, in a text editor. For multi-instance agents, open thepc_instance.ini file, where instance is the instance name of your agent.

Open the agent <install_dir>\TAMITM6_x64\KPCENV file for 64-bitagents, and <install_dir>\TAMITM6\KPCENV for 32-bit agents, where PC is theagent's product code.For a list of product codes, see “Entering agent commands” on page 100.

2. Edit the KDH_FORWARDPROXY environment variable.KDH_FORWARDPROXY=https://proxy-address:proxy-port-number

For example:KDH_FORWARDPROXY=https://HostA:8085

3. Optional: If you want to have your monitoring agents communicate using anSSL proxy, you must configure the forward proxy to support mutual SSLauthentication. The forward proxy must support mutual authentication withthe agents because the agents invoke the HTTP POST methods to the forward

78 IBM Performance Management (SaaS): BETA Documentation

Page 85: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

proxy. The forward proxy then forwards the POST to the PerformanceManagement console on the agent's behalf using information in the agentpayload.v To configure mutual SSL authentication between an agent

running on Linux to an IBM HTTP Server running on Linux, complete thefollowing steps:Use a single agent running on Linux as a source for the configurationactivity.a. Copy the contents of /opt/ibm/ccm/agents/keyfiles to a directory in

/opt/IBM/HTTPServer/conf.d, or you can copy to another directory ofyour choosing.

b. Set the path to the keystore to point to the keyfile.db file. For example,/opt/IBM/HTTPServer/conf.d/keyfiles/keyfile.kdb.

c. Set the stash file to point to the respective stash file in the same directory.For example, /opt/IBM/HTTPServer/conf.d/keyfiles/keyfile.sth.

d. Ensure all four files (keyfile.sth, keyfile.kdb, keyfile.crl,keyfile.rdb) are copied to your IBM HTTP Server.

v To configure mutual SSL authentication between an agentrunning on Windows to an IBM HTTP Server running on Windows,complete the following steps:Use a single agent running on Windows as a source for the configurationactivity.a. Copy the contents of c:\IBM\ITM\keyfiles to a directory in

c:\IBM\HTTPServer\conf.d, or you can copy to another directory of yourchoosing.

b. Set the path to the keystore to point to the keyfile.db file. For example,c:\IBM\HTTPServer\conf.d\keyfiles\keyfile.kdb.

c. Set the stash file to point to the respective stash file in the same directory.For example, c:\IBM\HTTPServer\conf.d\keyfiles\keyfile.sth.

d. Ensure all four files (keyfile.sth, keyfile.kdb, keyfile.crl,keyfile.rdb) are copied to your IBM HTTP Server.

4. Restart the agent to implement your changes. See “Entering agent commands”on page 100.

Integrating with other productsYou can integrate other products with IBM Performance Management (SaaS) toprovide you with a robust solution.

Configuring integration with IBM SmartCloud Control DeskYou can configure your events from Performance Management (SaaS) toautomatically open tickets in IBM SmartCloud Control Desk.

Procedurev To open tickets in your on-premises IBM SmartCloud Control Desk complete the

following steps:1. Configure your IBM SmartCloud Notes email account for IBM SmartCloud

Control Desk to use an IMAP mail client. During configuration, you mustensure you select Enable IMAP Access Now. For more information, seeEnabling IMAP access in the IBM SmartCloud for Social Business wiki.

Chapter 2. Installing and configuring 79

Page 86: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

2. In the Performance Management console, click System Configuration >Advanced Configuration, then set the following parameters:

Target Email AddressesSpecify your SmartCloud Notes email address that is used to createService Request tickets.

Email Subject LineSpecify a subject line for the email, such as PMaaS Event.

3. Go to Support on IBM Service Engage (http://ibmserviceengage.com/support/) and select Subscription to submit a support ticket to complete youenablement.Provide the following information in your ticket:– SmartCloud Notes email address

For example, [email protected].– SmartCloud Notes email password– SmartCloud Notes email fully-qualified server name

For example, imap.notes.na.collabserv.com.– SmartCloud Notes email port number

For example, 993.– Customer IBM SmartCloud Control Desk URL

Format the link as follows: https://<subscriber-id>.sccd.ibmserviceengage.com/maximo_t4hj/webclient/login/login.jsp?welcome=-true

v To open tickets in your IBM SmartCloud Control Desk SaaS environment, go toSupport on IBM Service Engage (http://ibmserviceengage.com/support/) andselect Subscription to submit a support ticket to complete you enablement.Provide the following information in your ticket:– SmartCloud Notes email address

For example, [email protected].– SmartCloud Notes email password– SmartCloud Notes email fully-qualified server name

For example, imap.notes.na.collabserv.com.– SmartCloud Notes email port number

For example, 993.– Customer IBM SmartCloud Control Desk URL

Format the link as follows: https://<subscriber-id>.sccd.ibmserviceengage.com/maximo_t4hj/webclient/login/login.jsp?welcome=-true

Installing the Integration Agent for Netcool/OMNIbusYou can forward your events from IBM Performance Management (SaaS) into youron-premises IBM Tivoli Netcool/OMNIbus event manager. To install theIntegration Agent for Netcool/OMNIbus, you must download an archive file fromthe IBM Service Engage website, extract the agent installation files, and then startthe installation script.

Before you begin

Only one instance of the Integration Agent for Netcool/OMNIbus can forwardevents from a single instance of a Performance Management (SaaS) servicesubscription to the Netcool/OMNIbus event manager at a time.

80 IBM Performance Management (SaaS): BETA Documentation

Page 87: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

The following procedure assumes a default Windows installation path ofC:\IBM\ITM. If you specify a different installation path, use your unique installationpath when you run commands or navigate to files.

Procedure1. To download the IBM Performance Management (SaaS) Integration archive file

that includes the Integration Agent for Netcool/OMNIbus, log in to MyServices (http://my.ibmserviceengage.com) from the IBM Service Engagewebsite. Save the file to a staging directory of your choosing. Install the agenton any system that has network connectivity to the Tivoli Netcool/OMNIbusProbe for Tivoli EIF. If needed, transfer the installation archive file. The archivefile contains the agent and installation script.

2. Extract the installation file.

a. Open a terminal shell session on the Red Hat Enterprise Linux system.b. Go to the directory where the archive file is located.c. Extract the installation files by using the following command:

tar -xf ./IPMaaS_Integration_Agents_version.tar

Extract the IPMaaS_Integration_Agents_version.zip file.Where version is the specific version of your archive file.The installation script is extracted to a directory named for the archive file andversion. For example: IPMaaS_Integration_Agent_Install_1.2.3. Agent binaryand configuration-related files are extracted into subdirectories within thatdirectory.

3. Run the installation script with Administrator privileges from the directory thatis named for the archive file and version.If you are installing the Integration Agent for Netcool/OMNIbus on the samesystem that your Probe for Tivoli EIF is located and the Probe for Tivoli EIF isusing the default port of 9998, the Integration Agent for Netcool/OMNIbus isautomatically configured to connect to your Probe for Tivoli EIF.

Note: If you are installing the Integration Agent for Netcool/OMNIbus on adifferent system than the one your Probe for Tivoli EIF is located, or you areusing a different port number than the default for the Probe for Tivoli EIF, youmust configure the Integration Agent for Netcool/OMNIbus after theinstallation is complete.Complete the following steps to install the agent.

./installAPMaaSAgents.sh

installAPMaaSAgents.bat

You are prompted to install the Integration Agent for Netcool/OMNIbus.A prerequisite scan of your environment starts and takes a few moments tocomplete. If any requirements are missing, a message directs you to a log filewith the reason for the failure. A prerequisite, such as a missing library orinsufficient disk space, stops the installation. You must address the failure, andstart the installation again. For more information, see “Dependencies” on page7.The agent is configured with the following default settings:

Chapter 2. Installing and configuring 81

Page 88: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Tivoli EIF Probe Host: localhost

Tivoli EIF Probe Port: 9998

After installation, the Integration Agent for Netcool/OMNIbus is automaticallystarted.The monitoring agent is installed into the following directories:

/opt/ibm/ccm/agent

C:\IBM\ITM\

4. If you are installing the Integration Agent for Netcool/OMNIbus on a differentsystem than the one your Probe for Tivoli EIF is located, or the Probe for TivoliEIF is using the different port number than the default port of 9998, theIntegration Agent for Netcool/OMNIbus must be configured to connect to yourProbe for Tivoli EIF.

Note: If you installed the Integration Agent for Netcool/OMNIbus on the samesystem that your Probe for Tivoli EIF is located and the Probe for Tivoli EIF isusing the default port of 9998 you do not need to complete this step.Complete the following steps to configure the agent.

a. Run the following command:/opt/ibm/ccm/agent/bin/omnibus-agent.sh config

b. When prompted, provide your Probe for Tivoli EIF host name and portnumber.After configuration is complete, the Integration Agent forNetcool/OMNIbus is automatically started.

Alternatively, you can also use the following steps to review and change yourconfiguration settings.a. Open the response file /opt/ibm/ccm/agent/samples/

omnibus_silent_config.txt in a text editor.b. Edit the file to set or change your configuration settings. Ensure you

uncomment the configuration lines.c. Save and close the response file.d. Reconfigure the agent by specifying the fully qualified path to the silent

configuration file you edited:/opt/ibm/ccm/agent/bin/omnibus-agent.sh config/opt/ibm/ccm/agent/samples/omnibus_silent_config.txt

e. Restart the agent to implement your changes:/opt/ibm/ccm/agent/bin/omnibus-agent.sh stop

/opt/ibm/ccm/agent/bin/omnibus-agent.sh start

a. Open the C:\IBM\ITM\samples\omnibus_silent_config.txt response file in atext editor.

b. Edit the file to specify your Probe for Tivoli EIF host name and portnumber. Ensure you uncomment the configuration lines.

c. Save and close the response file.d. Reconfigure the agent by specifying the fully qualified path to the silent

configuration file you edited:C:\IBM\ITM\BIN\omnibus-agent.bat config

C:\IBM\ITM\samples\omnibus_silent_config.txt

e. Restart the agent to implement your changes:

82 IBM Performance Management (SaaS): BETA Documentation

Page 89: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

C:\IBM\ITM\BIN\omnibus-agent.bat stop

C:\IBM\ITM\BIN\omnibus-agent.bat start

What to do next

If your Probe for Tivoli EIF and Netcool/OMNIbus ObjectServer are alreadyintegrated with IBM Tivoli Monitoring, IBM SmartCloud Monitoring - ApplicationInsight, or IBM SmartCloud Application Performance Management, your setup iscomplete.

If your Probe for Tivoli EIF and Netcool/OMNIbus ObjectServer were previouslynot integrated, follow the instructions in “Configuring the integration forNetcool/OMNIbus.”

If you want to stop using the Integration Agent for Netcool/OMNIbus or youwant to move the agent to a different system, uninstall the agent by using thefollowing command:

/opt/ibm/ccm/agent/bin/omnibus-agent.sh uninstall

C:\IBM\ITM\BIN\omnibus-agent.bat uninstall

Configuring the integration for Netcool/OMNIbusIf your Probe for Tivoli EIF and Netcool/OMNIbus ObjectServer have not beenpreviously integrated with IBM Tivoli Monitoring, you must complete extra tasksto complete your integration.

Before you begin

Before you complete the integration steps, stop the Integration Agent forNetcool/OMNIbus by using the following commands:

/opt/ibm/ccm/agent/bin/omnibus-agent.sh stop

C:\IBM\ITM\BIN\omnibus-agent.bat stop

In this procedure, when you follow links to the IBM Tivoli Monitoringdocumentation, complete only the steps that are provided at the linked page.

About this task

After installation of the Integration Agent for Netcool/OMNIbus, the requiredconfiguration files are in the following directories:

/opt/ibm/ccm/agent/localconfig/i0/omnibus

install_dir\localconfig\i0\omnibus

v itm_db_update.sql

v itm_event.rules

v itm_event_cache.sql

v itm_heartbeat.sql

v itm_proc.sql

Chapter 2. Installing and configuring 83

Page 90: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

v itm_sync.sql

Procedure1. Copy the Integration Agent for Netcool/OMNIbus itm_event.rules file to the

Probe for Tivoli EIF installation directory.2. Open the Probe for Tivoli EIF tivoli_eif.rules file in a text editor, then

uncomment the line that references the itm_events.rules file. For detailedsteps, see Updating the rules files of the EIF probe in the IBM TivoliMonitoring documentation.

3. If you are using a multitier OMNIbus solution, complete all the tasks asdescribed in the Updating the Netcool/OMNIbus ObjectServer with IBM TivoliMonitoring attributes, tables, and triggers section.

4. Update the Netcool/OMNIbus ObjectServer database schema by loading theitm_proc.sql and itm_db_update.sql files into the database by using one of thefollowing commands:

nco_sqlFor example:$OMNIHOME/bin/nco_sql -user username -password password -server server_name< path_to_file/itm_proc.sql

isqlFor example:path_to_file\itm_proc.sql | %OMNIHOME%\..\bin\redist\isql -U username-P password -S server_name

Note: Run the commands by using both of the .sql files.

Tip: You might need to repeat this step to ensure all the tables are correctlyadded to the Netcool/OMNIbus ObjectServer.

5. Restart the Integration Agent for Netcool/OMNIbus by using the followingcommands:

/opt/ibm/ccm/agent/bin/omnibus-agent.sh start

C:\IBM\ITM\BIN\omnibus-agent.bat start

Results

Your Netcool/OMNIbus integration is now complete.

Upgrading monitoring agentsPeriodically, new archive files containing upgraded monitoring agents are availablefor download from My Services (http://my.ibmserviceengage.com) on the IBMService Engage website.

About this task

If a new version of the agent is available, executing the installation scriptautomatically upgrades the agent. If the agent does not have a newer versionavailable, a message is displayed explaining that the agent is already installed;your installed agent is not affected.

To install an upgraded agent, follow the instructions in:

84 IBM Performance Management (SaaS): BETA Documentation

Page 91: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Procedurev “Installing monitoring agents on AIX systems” on page 9v “Installing monitoring agents on Linux systems” on page 10v “Installing monitoring agents on Windows systems” on page 14

What to do next

If you upgraded the WebSphere Applications agent, you must migrate the datacollector to the latest maintenance level. For detailed instructions, includinglimitations, see “WebSphere Applications agent: Migrating the data collector.”

WebSphere Applications agent: Migrating the data collectorAfter you update the Monitoring Agent for WebSphere Applications, you mustmigrate the data collector either interactively or in silent mode.

Migrating the data collector interactivelyYou can migrate an earlier maintenance level of the data collector interactivelyusing the migration utility.

Before you begin

If you installed the WebSphere application server or portal server on a Linuxsystem using a non-root user account, verify that the non-root user has read andwrite privileges on the following agent directories:v /opt/ibm/ccm/agent/install-images/kyn/dchome/7.3.0.3.0/data

v /opt/ibm/ccm/agent/install-images/kyn/dchome/7.3.0.3.0/bin

v /opt/ibm/ccm/agent/install-images/kyn/dchome/7.3.0.3.0/runtime

v /opt/ibm/ccm/agent/install-images/kyn/dchome/7.3.0.3.0/logs

Provide read and write permissions using the chmod 777 command, if required.

If you are migrating the monitoring of WebSphere Application Server Liberty,make sure the JAVA_HOME environment variable points to the version of the JRE thatis used by the application server.

About this task

You can migrate an earlier maintenance level of the data collector interactivelyusing the migration utility. If you want to migrate many application serverinstances, it might be more convenient to use the migration utility in silent mode.

Important:

v You can only migrate previous maintenance levels of 7.3 version of a datacollector. The version of the data collector is indicated in the data collector homedirectory path.

v You cannot migrate from the data collector version 7.3 to 7.3 fix pack 1. Instead,unconfigure the data collector and uninstall the agent version 7.3. Then installthe agent version 7.3 fix pack 1 and configure the data collector again.

Procedure1. On Linux systems, log in as the user that was used to install the application

server.

Chapter 2. Installing and configuring 85

Page 92: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

2. Run the command DC_home/bin/migrate.sh on Linux systems orDC_home\bin\migrate.bat on Windows systems to start the migration utility.

3. The utility displays the IP addresses of all network cards that are found onthe local computer system and prompts you to specify the interface to use forthe data collector:List of TCP/IP interfaces discovered:

1. 9.111.98.108Enter a number [default is: 1]:

4. Enter the number that corresponds to the IP address to use.5. The utility discovers all servers configured by older maintenance levels of the

data collector and lists them. The data collectors are grouped by maintenancelevel.

6. Select one or more application server instances from the list.Select application servers for migration, currently configured servers are:Configured by 7.3.0.0.01. ManagerCell.ManagerNode.server2(AppServerProfile)2. server1Configured by 7.3.0.1.03. server2Enter a number or numbers separated by commas or spaces, or enter * to select all:

The list might include both traditional WebSphere server instances and Libertyservers. Traditional WebSphere server instances might be under differentprofiles.

Tip:

v If several instances under one profile are monitored, you must select themall for migrating at the same time.

v Migrate all servers under the liberty profile at the same time. Partiallymigrating configured servers might cause instability.

Remember:

v For a stand-alone environment, application server instances must berunning.

v For a Network Deployment environment, the node agent and deploymentmanager must be running.

v Liberty servers are not required to be running during the migration.7. Enter the number that corresponds to the application server instance whose

data collector is to be migrated or enter an asterisk (*) to migrate the datacollector of all application server instances.To specify a subset of servers, enter the numbers, separated by commas, thatrepresents the servers. For example: 1,2,3.The migration utility automatically integrates each data collector with themonitoring agent. The monitoring agent host and port values are retrievedfrom the existing configuration files.

8. Enter an alias for each of the selected servers. The default value is the existingserver alias.Enter the server alias for server server2 in node ManagerNode[default is: server2_73000]:

Enter the server alias for server server1 in node opt.IBM.WLP.wlp[default is: server1_Liberty]:

9. The utility determines whether WebSphere global security is enabled for eachof the profiles where data collection is being migrated. If WebSphere Global

86 IBM Performance Management (SaaS): BETA Documentation

Page 93: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Security is enabled for one or more profiles, specify whether to retrievesecurity settings from a client properties file:Do you want to retrieve security settings from a client properties file(soap.client.props or sas.client.props)?[1 - YES, 2 - NO] [default is: 2]:

The data collector communicates with the WebSphere Administrative Servicesusing the RMI or the SOAP protocol. If global security is enabled for a profile,you must specify the user ID and password of a user who is authorized to login to the IBM WebSphere Application Server administrative console for theprofile.Alternatively, you can encrypt the user name and password and store them inthe application server client properties files before configuring the datacollector. You must use the sas.client.props file for an RMI connection, orthe soap.client.props file for an SOA connection.

10. Enter 1 to allow the utility to retrieve the user name and password from theappropriate client properties file and skip to step 12. Otherwise, enter 2 toenter the user name and password.Enter WebSphere admin user name:Enter WebSphere admin user password:

Important: It may take some time to log in to the WebSphere ApplicationServer administrative console.

11. Enter the user name and password for each profile whether WebSphere GlobalSecurity is enabled.

12. The utility migrates data collection for each selected application serverinstance. It displays a status message that indicates whether the migration ofeach server completed successfully. When the utility completes the migration,it displays the following message:Migration of the Data Collector has successfully completed with return code 0.

13. Restart the instances as directed by the utility. The data collector configurationtakes effect when the application server instances are restarted.

Results

The data collector is migrated to the latest maintenance level installed.

What to do next

The migration utility preserves the settings that were configured in the olderversion of the data collector. To modify these settings, you can run either theconfiguration or reconfiguration utility in interactive or silent mode from theDC_home\bin directory of the new data collector. For more information, see“Configuring and reconfiguring the data collector with the advanced utilities” onpage 50.

Migrating the data collector in silent modeYou can migrate an earlier maintenance level of the data collector using themigration utility in silent mode.

Before you begin

If you installed the WebSphere application server or portal server on a Linuxsystem using a non-root user account, verify that the non-root user has read andwrite privileges on the following agent directories:

Chapter 2. Installing and configuring 87

Page 94: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

v /opt/ibm/ccm/agent/install-images/kyn/dchome/7.3.0.3.0/data

v /opt/ibm/ccm/agent/install-images/kyn/dchome/7.3.0.3.0/bin

v /opt/ibm/ccm/agent/install-images/kyn/dchome/7.3.0.3.0/runtime

v /opt/ibm/ccm/agent/install-images/kyn/dchome/7.3.0.3.0/logs

Provide read and write permissions using the chmod 777 command, if required.Also, log in as the user that was used to install the application server.

If you are migrating the monitoring of WebSphere Application Server Liberty,make sure the JAVA_HOME environment variable points to the version of the JRE thatis used by the application server.

About this task

A sample silent properties file, sample_silent_migrate.txt, is packaged with themigration utility. The file is available in the /opt/ibm/ccm/agent/install-images/kyn/dchome/7.3.0.3.0/bin directory.

When you create your silent properties file, keep in mind these considerations:v A line in the file that starts with a number sign (#) is treated as a comment, and

is not processed. If the number sign is used elsewhere in the line, it is notconsidered to be the start of a comment. This means that you can use thenumber sign in passwords or for other uses.

v Each property is described on a separate line, in the following format: property= value.

propertyThis is the name of property. The list of valid properties that you canconfigure is shown in Table 9. Do not modify or remove properties inthe sample file that are not listed in the table.

value This is the value of the property. Default values for some properties arealready provided. You can delete default values to leave property valuesblank, or empty. An empty value is treated as if the property is notspecified, as opposed to using the default value. If you want to usedefault values, you can comment out the property in the file.

v Passwords are in plain text.v Properties and their values are case-sensitive.

Table 9 describes the properties that are available when migrating the data collectorin silent mode.

Table 9. Available properties for running the migration utility in silent mode

Property Comment

migrate.type Must be AD.

default.hostip If the computer system uses multiple IPaddresses, specify the IP address for the datacollector to use.

itcam.migrate.home Specifies the data collector home directory ofthe older maintenance version of the datacollector. The directory is not deleted as partof the migration.

88 IBM Performance Management (SaaS): BETA Documentation

Page 95: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Table 9. Available properties for running the migration utility in silent mode (continued)

Property Comment

was.wsadmin.connection.host Specifies the name of the host to which thewsadmin tool is connecting. In a NetworkDeployment environment, specify thewsadmin connection to the DeploymentManger. In a stand-alone environment,specify the wsadmin connection to theserver.

was.wsadmin.username Specifies the user ID of a user who isauthorized to log on to the IBM WebSphereApplication Server administrative console.This user must have the agent role on theapplication server.

was.wsadmin.password Specifies the password that corresponds tothe user specified in thewas.wsadmin.username property.

was.appserver.profile.name Specifies the name of the application serverprofile you want to configure.Remember: The property is not required fora Liberty profile.

was.appserver.home Specifies the WebSphere Application Serverhome directory.

was.appserver.cell.name Specifies the WebSphere Application Servercell name.Remember: The property is not required fora Liberty profile.

was.appserver.node.name Specifies the WebSphere Application Servernode name.Remember: The property is not required fora Liberty profile.

was.appserver.server.name Specifies the application server instancewithin the application server profile tomigrate to the new version of the datacollector. The silent properties file can havemultiple instances of this property.

Important:

v You can only migrate previous maintenance levels of 7.3 version of a datacollector. The version of the data collector is indicated in the data collector homedirectory path.

v You cannot migrate from the data collector version 7.3 to 7.3 fix pack 1. Instead,unconfigure the data collector and uninstall the agent version 7.3. Then installthe agent version 7.3 fix pack 1 and configure the data collector again.

Procedure1. Specify configuration options in the silent migration properties file.2. Run the command DC_home/bin/migrate.sh -silent

<sample_silent_migration_filename> on Linux systems orDC_home\bin\migrate.bat -silent <sample_silent_migration_filename> onWindows systems to start the migration utility in silent mode.

Chapter 2. Installing and configuring 89

Page 96: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Results

The data collector is migrated to the latest maintenance level installed.

What to do next

The migration utility preserves the settings that were configured in the olderversion of the data collector. To modify these settings, you can run either theconfiguration or reconfiguration utility in interactive or silent mode from theDC_home\bin directory of the new data collector. For more information, see“Configuring and reconfiguring the data collector with the advanced utilities” onpage 50.

Uninstalling monitoring agentsUninstall a single agent or all the agents from a managed system.

Before you begin

For the Monitoring Agent for WebSphere Applications, you must unconfigure thedata collector for all monitored server instances before you uninstall the agent.Follow the instructions in “WebSphere Applications agent: Unconfiguring the datacollector” on page 91.

For the Node.js agent, you must remove the monitoring plug-in from your Node.jsapplication before you uninstall the agent. Follow the instructions in “Node.jsagent: Removing the monitoring plug-in” on page 95.

For the Microsoft .NET agent, you must remove the data collector from your .NETapplications before you uninstall the agent. Follow the instructions in “Microsoft.NET agent: Removing the .NET data collector” on page 96.

Procedure1. On the VM or system where the monitoring agent (or agents) is installed, start

a command line and change to the binary directory:v /opt/ibm/ccm/agent/bin

v C:\IBM\ITM\BIN

2. To uninstall a specific monitoring agent, enter the agent script name and theuninstall option where name is the agent script name:v ./name-agent.sh uninstall

v name-agent.bat uninstall

For a list of the agent script names, see “Entering agent commands” on page100.

Remember: For the Monitoring Agent for Microsoft .NET, you must run thecommand with Administrator privileges.The monitoring agent is uninstalled from the managed system.If you have uninstalled all of your monitoring agents individually, complete thenext step to remove the framework files.

3. To uninstall all the monitoring agents from the managed system, enter thescript name and uninstall option:v ./smai-agent.sh uninstall_all

v smai-agent.bat uninstall_all

90 IBM Performance Management (SaaS): BETA Documentation

Page 97: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

All monitoring agents are uninstalled from the system or VM.

What to do next

For the Monitoring Agent for Python:1. Delete the Django pyc configuration file to ensure the restored Django pyc file

generates its binary.2. Restart the Apache server to remove the loaded middleware in the Apache

processes.

For the Monitoring Agent for Ruby, to uninstall the diagnostics data collector:1. Navigate to the home directory of your application, open its Gemfile, and

remove the following line from the file: gem ’stacktracer’

2. Restart your Ruby on Rails application.3. Uninstall the diagnostics data collector. Enter: gem uninstall Gemfile

4. Remove the runtime directory of the data collector. The default location of thisdirectory is /opt/ibm/ccm/agent/install-images/kkm/dchome

For the Monitoring Agent for Microsoft .NET, restart your .NET applications.

WebSphere Applications agent: Unconfiguring the datacollector

To remove the data collector from an application server instance, you can use theinteractive utility or the silent unconfiguration process.

For instances monitored with PMI resource monitoring, unconfiguration is notavailable. Monitoring of PMI data continues while the server is available.

Unconfiguring the data collector using the interactive utilityIf you no longer want the data collector to monitor one or more application serverinstances, you can unconfigure the data collector for them.

The ITCAM Data Collector for WebSphere Unconfiguration utility is a menudriven command-line utility for unconfiguring ITCAM Data Collector forWebSphere.

To unconfigure the data collector, complete the following procedure:1. From a command line, navigate to the DC_home\bin directory.2. Optionally, set the location of the Java home directory before you run the

script. For example:On Windows systems:set JAVA_HOME=C:\Progra~1\IBM\WebSphere\AppServer80\java

On Linux systems:export JAVA_HOME=/opt/IBM/AppServer80/java

3. Run the following command to start the ITCAM Data Collector for WebSphereUnconfiguration utility.On Windows systems:DC_home\bin\unconfig.bat

On Linux systems:DC_home/bin/unconfig.sh

Chapter 2. Installing and configuring 91

Page 98: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

The utility searches for all server instances that are monitored by the ITCAMData Collector for WebSphere.

Remember:

v For a stand-alone environment, application server instances must berunning during the configuration. (A WebSphere Application Server Libertyinstance does not need to be running).

v For a Network Deployment, WebSphere Virtual Enterprise, or WebSphereCompute Grid environment, the Node Agent and Deployment Managermust be running.

The utility prompts you to select one or more application server instancesfrom the list of configured servers:Choose one or more servers to unconfigure for data collection:Application Servers configured by the current version:1. co098170Node01Cell.co098170Node01.server1(AppSrv01)Enter a number or numbers separated by commas, or enter * to select all:

4. Enter the number that corresponds to the application server instance tounconfigure for data collection or enter an asterisk (*) to unconfigure datacollection for all application server instances. To specify a subset of servers,enter the numbers, separated by commas, that represent the servers. Forexample: 1,2,3.

5. The utility prompts you to specify whether you want to create a backup ofyour current WebSphere Application Server configuration:Do you want to backup current WebSphere configuration? [1 - YES, 2 - NO][default is: 2]:

Enter 1 to create a backup of the current configuration. Otherwise, enter 2 andskip to step 8.

6. The utility prompts you to specify the directory in which to store the backupof the configuration. For example:On Windows systems:Enter backup directory [default is: C:\IBM\ITM\dchome\7.3.0.3.0\data]:

On Linux systems:Enter backup directory[default is: /opt/ibm/ccm/agent/install-images/kyn/dchome/7.3.0.3.0/data]:

Specify a directory in which to store the backup of the configuration or acceptthe default directory.

7. The utility displays the name of the WebSphere home directory and theWebSphere profile for which a backup is created. For example:On Windows systems:WebSphere Home:C:\Program Files (x86)\IBM\WebSphere\AppServerWebSphere Profile:AppSrv01

On Linux systems:WebSphere Home:/opt/IBM/WebSphere/AppServer/profiles/AppSrv01WebSphere Profile:AppSrv01

8. The utility indicates whether WebSphere Global Security is enabled for theWebSphere Application profile that you specified:WebSphere Global Security is enabled.

If global security is not enabled, skip to step 11 on page 93.

92 IBM Performance Management (SaaS): BETA Documentation

Page 99: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

9. The utility prompts you to specify whether to retrieve security settings from aclient properties file:Do you want to retrieve security settings from a client properties file(soap.client.props or sas.client.props)?[1 - YES, 2 - NO] [default is: 2]:

The data collector communicates with the WebSphere Administrative Servicesusing the RMI or the SOAP protocol. If global security is enabled for a profile,you must specify the user ID and password of a user who is authorized to login to the IBM WebSphere Application Server administrative console for theprofile. Alternatively, you can encrypt the user name and password and storethem in client properties files before configuring the data collector. You mustuse the sas.client.props file for an RMI connection, or thesoap.client.props file for an SOAP connection.Enter 1 to allow the utility to retrieve the user name and password from theappropriate client properties file and skip to step 11. Otherwise, enter 2 toenter the user name and password.Enter WebSphere admin user name:Enter WebSphere admin user password:

10. If you selected the option to back up the current WebSphere configuration, theutility starts backing up the configuration. For example: On Windows systems:Backing up profile: AppSrv01 home: C:\Program Files(x86)\IBM\WebSphere\AppServer\bin ... Backup fileC:\IBM\ITM\dchome\7.3.0.3.0\data\v525400e96601Cell01.v525400e96601Node01.AppSrv01.WebSphereConfig_20120716161102.zipis successfully created

On Linux systems:Backing up profile: AppSrv01 home: /opt/IBM/WebSphere/AppServer/bin ...Backup file /opt/ibm/ccm/agent/install-images/kyn/dchome/7.3.0.3.0/data/v525400e96601Cell01.v525400e96601Node01.AppSrv01.WebSphereConfig_20120716161102.zip is successfully created

11. The utility unconfigures the data collector for the specified application serverinstances. A status message is displayed to indicate that the data collector wassuccessfully unconfigured. For example:Successfully executed Unconfiguring for Cell: v525400597750Node01CellNode: v525 400597750Node01 Profile: AppSrv01

12. After unconfiguring the data collector to monitor application server instances,you must restart the instances. The data collector unconfiguration takes effectwhen the application server instances are restarted.

Data collection is unconfigured for the specified application server instances.

PMI resource monitoring for the server instance is still available. If you want touse resource monitoring for a server instance after unconfiguring the data collector,restart the monitoring agent by running the following commands:v On a Windows system:

cd C:\IBM\ITM\binwas-agent.bat stopwas-agent.bat start

v On a Linux system:cd /opt/ibm/ccm/agent/bin./was-agent.sh stop./was-agent.sh start

Chapter 2. Installing and configuring 93

Page 100: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Unconfiguring the data collector in silent modeITCAM Data Collector for WebSphere can be unconfigured interactively with theITCAM Data Collector for WebSphere Unconfiguration utility. If you want tounconfigure many application server instances, it might be more convenient tounconfigure ITCAM Data Collector for WebSphere in silent mode.

When you unconfigure the data collector in silent mode, you first specifyconfiguration options in a properties file. A sample properties file,sample_silent_unconfig.txt, is packaged with the unconfiguration utility. The fileis available in the DC_home\bin directory. The DC_home variable is the locationwhere the data collector is installed.

Complete the following steps to perform a silent unconfiguration:1. Specify configuration options in the properties file.2. Go to the DC_home\bin directory on Windows systems or the DC_home/bin

directory on Linux systems.3. Run the following command:

unconfig.bat -silent [dir_path]\silent file

Linux systems:unconfig.sh -silent [dir_path]/silent file

4. After unconfiguring the data collector to monitor application server instances,you must restart the instances. The data collector configuration takes effectwhen the application server instances are restarted.PMI resource monitoring for the server instance is still available. If you want touse resource monitoring for a server instance after unconfiguring the datacollector, restart the monitoring agent by running the following commands:v On a Windows system:

cd C:\IBM\ITM\binwas-agent.bat stopwas-agent.bat start

v On a Linux system:cd /opt/ibm/ccm/agent/bin./was-agent.sh stop./was-agent.sh start

Properties file

When you create your silent response properties file, keep in mind theseconsiderations:v A line in the file that starts with a number sign (#) is treated as a comment, and

is not processed. If the number sign is used elsewhere in the line, it is notconsidered to be the start of a comment.

v Each property is described on a separate line, in the following format: property =value.

propertyThis is the name of property. The list of valid properties that you canconfigure is shown in Table 10 on page 95.

value This is the value of the property. Default values for some properties arealready provided. You can delete default values to leave property valuesblank, or empty. An empty value is treated as if the property is notspecified, as opposed to using the default value. To use default values,you can comment out the property in the file.

94 IBM Performance Management (SaaS): BETA Documentation

Page 101: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

v Passwords are in plain text.v Properties and their values are case-sensitive.

Table 10 describes the properties that are available when unconfiguring the datacollector in silent mode:

Table 10. Available properties for running the unconfiguration utility in silent mode

Property Comment

WebSphere Application Server connecting settings

was.wsadmin.connection.host Specifies the name of the host to which the wsadmin tool isconnecting.

WebSphere Application Server global security settings

was.wsadmin.username Specifies the user ID of a user who is authorized to log on to theIBM WebSphere Application Server administrative console. Thisuser must have the agent role on the application server.

was.wsadmin.password Specifies the password that corresponds to the user specified inthe was.wsadmin.username property.

WebSphere Application Server settings

was.appserver.profile.name Specifies the name of the application server profile you want tounconfigure.

was.appserver.home Specifies the WebSphere Application Server home directory.

was.appserver.cell.name Specifies the WebSphere Application Server cell name.

was.appserver.node.name Specifies the WebSphere Application Server node name.

Backup of the WebSphere Application Server configuration

was.backup.configuration Specifies whether to back up the current configuration of theWebSphere Application Server data collector configurationbefore unconfiguring the data collector. Valid values are Trueand False.

was.backup.configuration.dir Specifies the location of the backup directory.

WebSphere Application Server runtime instance settings

was.appserver.server.name Specifies an application server instance within the applicationserver profile for which you want to unconfigure the datacollector.Tip: The silent response file can have multiple instances of thisproperty.

Node.js agent: Removing the monitoring plug-in

About this task

Before you uninstall the Node.js agent, you must remove the monitoring plug-infrom your Node.js application.

Procedurev Remove the following line from the beginning of the Node.js application file:

require(’/opt/ibm/ccm/agent/lx8266/nj/bin/plugin/knj_index’).The plug-in line is removed from your Node.js application file.

v Restart your Node.js application to disable the monitoring plug-in.

Chapter 2. Installing and configuring 95

Page 102: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

What to do next

For more information about uninstalling the Node.js agent, see “Uninstallingmonitoring agents” on page 90.

Microsoft .NET agent: Removing the .NET data collector

About this task

Before you uninstall the Microsoft .NET agent, you must remove the .NET datacollector from your .NET applications.

Procedure1. Enter the following command as an administrator: cd C:\IBM\ITM\qe\bin

configdc unregisterdc

2. Stop all of your .NET applications to disable the data collector.3. Remove the old data collector dll files. Use one of the following options:

v Reboot your operating system to remove all data collector dll files.v To avoid rebooting your operating system, complete the following steps:

a. Try to delete the file C:\IBM\ITM\qe\bin64\CorProfLog.dll.A File in Use dialog is displayed. It identifies the .NET processes thatare currently running.

b. Restart each of the .NET processes.

What to do next

For more information about uninstalling the Microsoft .NET agent, see“Uninstalling monitoring agents” on page 90.

96 IBM Performance Management (SaaS): BETA Documentation

Page 103: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Chapter 3. Administering

Starting the Performance Management consoleLog in to your Performance Management console from your browser to review thehealth status of your applications.

Before you begin

Activate your account by using the link that is provided in the confirmation emailyou received after your initial sign-up for the service.

To ensure the user interface is not truncated, use a minimum resolution of 1280 x1024.

Procedurev To access your Performance Management console, use the link that is provided

in the email alerting you that your service is ready.v You can also access your console from the IBM Service Engage

(http://ibmserviceengage.com) website.1. Go to My Services (http://my.ibmserviceengage.com) on the IBM Service

Engage website.2. Log in with the user name and password that you used to register for the

service.3. In the Performance Management row, click Launch.

Results

After you log in, the Getting Started page or the Application PerformanceDashboard is displayed, depending on whether you cleared the check box forshowing Getting Started at startup. If you are in the Getting Started page, you canopen the Application Performance Dashboard by clicking View ApplicationStatus > Start Now.

What to do nextv Click System Configuration > Threshold Manager and create thresholds to

test for conditions that, when met, cause an event to open. For example, you canhave a threshold that opens an event after storage capacity reaches 90%.

Data sourcesThe types of applications that you can monitor in the Performance Managementconsole are your data sources.

The monitoring agents for supported data sources have predefined thresholds tohelp you get started with monitoring your consumer VM instances as soon as youlog in.

Data setsEach type of monitoring agent has many data sets that you can use tocreate thresholds to monitor for specific conditions. The dashboards showthe values of attributes from data sets.

© Copyright IBM Corp. 2014 97

Page 104: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Many data sets have enumerated attributes: the possible values are in atext format and represented by an integer. For example, the Linux OSagent Agent Active Runtime Status data set has an enumerated attributecalled Agent Availability Status with the following values:

Unknown (0)Not_found (1)Stopped (2)Start_Pending (3)Running (4)Manually_Stopped (5)Stop_Pending (6)Not_Configured (7)

Any dashboards or thresholds in the Application PerformanceManagement console that have enumerated attributes display the integerrather than the text it represents.

ThresholdsClick System Configuration > Threshold Manager to see any definedthresholds for your installed products and to create and edit thresholds.The thresholds must be assigned to an Agent Group to be distributed. Ifyou want the threshold applied to all managed systems of the given type,you must assign the threshold to the ALL agents group.

For enumerated attributes, use the integer value in the threshold definitioninstead of the text it represents.

Managing applicationsThe Application Performance Dashboard navigator has tools that you can use toadd or edit applications and their supporting software resources, or to remove anapplication.

When you add an application, you can create a new application and apply themanaged resources that are available, or select one from any discoveredapplications.

Before you begin

The My Components application in the navigator contains the managed systemsthat were discovered by the monitoring infrastructure. My Components cannot beedited or deleted.

About this task

Complete the following steps to add, edit, or remove an application from theApplication Performance Dashboard.

Procedure1. If the Application Performance Dashboard is not displayed, select it from the

Performance Menu or, if you are in the Getting Started page, clickView Application Status > Start Now.

2. In the Applications section of the navigator, add, remove, or modify anapplication:v To add an application, click . The Add Application window is displayed.

98 IBM Performance Management (SaaS): BETA Documentation

Page 105: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

v To modify an application, select it and click . The Edit Applicationwindow is displayed.

v To remove an application, select it and click . After you click OK toconfirm, the application is deleted. This method does not uninstall thesupporting components; only their appearance in the ApplicationDashboard.

3. Click Read to open the Read Application window with a list of anydiscovered applications, and take one or more of the following steps.v Click Detail to see the components of an application.v Select the radio button for the application that you want to use, and click

Save. The Read Application window closes, the source repository isdisplayed in the Application read from: field, and the components arelisted in Application components.

v Click Cancel to close the window without making a choice.

A discovered application can save you the effort of defining an application.4. Enter or edit the name of your application in the Application name field. You

can add a description in the Description field. Do not use the ! " % & ’ * ?< > } { symbols in the name or description:

5. In the Template field, keep the Custom Application template or select adifferent template using the button, and click Save. Any associatedcomponent types and instances are shown in the Application components list.If you are editing an application, you cannot specify a different template,except for Custom Application.The Monitoring Agent for Ruby shows two Application components: RubyApplications, for monitoring all the Ruby applications on the managedsystem; and Enable Ruby App Situations, for monitoring thresholds that havebeen defined for instance (subnode) level attributes. Select Ruby Applicationsto see status for all your Ruby applications, however note that situation eventswill not be displayed in your application. To see events that are triggered bythresholds, select Enable Ruby App Situations, click , and select theapplication instance or instances that you want to monitor and view eventsfrom.

6. To add components and instances to the application, take the following steps.a. Click and, in the Select Component window that opens, select a

component from the list. The Component Editor is displayed.b. Click an instance to select it or use the toolbar to search for

instances that contain the text in the search text box, select all instances, orclear all instances. You can also edit the component name, which is used asthe display name in the navigator for this application.

c. Click Add to add the instance or instances, and click Back.d. You can select another component to add instances to, or click Close.

The Application components list is updated with the new component names.A number in parentheses after the name indicates how many instances areassociated with the component.

7. To edit a component name or change the instance that is associated with it,select the component from the Application components list and click :a. To associate a different instance with the component, search for and select

the instance that you want.b. To change the component name that is used as the display name in the

navigator for this application, edit the Component name field.c. Click Save.

Chapter 3. Administering 99

Page 106: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

The Application components list is updated with the changes that you made.8. To remove a component or instance from the application, select it and click

. Click OK to confirm that you want to remove it.9. If other instances are related to the components in the Application

components list, a button that shows the number of related instances isdisplayed and you can take the following steps:a. Click the button to see the related instances in the Updated Details

window. A bar is shown for each type of update, with the name of theinstance below the bar. For example, if one of the components wasremoved, it shows below the Deleted components bar.

b. Select one or more instances and click Save to update the Applicationresources list.

10. When you are finished creating or editing the application, close theapplication editor by clicking Save to save your changes, or Cancel to undothe changes.

Results

The new or edited application is displayed in the Application Dashboard and thenavigator Applications section. When the application is selected, the componentsare displayed in the Groups section. If you deleted an application, it is no longerdisplayed.

Entering agent commandsThe same scripts that you use to install monitoring agents can also be used tocheck the status of an installed agent, stop or start it, or uninstall the agent.

About this task

The agent name and product codes are provided for your reference.

Table 11. Agent names to use when entering the name-agent.sh/.bat commands and theassociated agent product code

Monitoring agent

Agent name to use whenentering the name-agent.sh/.batcommands

Two letterproductcode

Monitoring Agent for Linux KVM linux_kvm v1

Monitoring Agent for Linux OS os lz

Monitoring Agent for Microsoft .NET dotnet qe

Monitoring Agent for MongoDB mongodb kj

Monitoring Agent for MySQL mysql se

Monitoring Agent for Node.js nodejs nj

Monitoring Agent for PHP php pj

Monitoring Agent for PostgreSQL postgresql pn

Monitoring Agent for Python python pg

Monitoring Agent for Ruby ruby km

Monitoring Agent for Tomcat tomcat ot

Monitoring Agent for UNIX OS os ux

100 IBM Performance Management (SaaS): BETA Documentation

Page 107: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Table 11. Agent names to use when entering the name-agent.sh/.bat commands and theassociated agent product code (continued)

Monitoring agent

Agent name to use whenentering the name-agent.sh/.batcommands

Two letterproductcode

Monitoring Agent for WebSphereApplications

was yn

Monitoring Agent for Windows OS os nt

Response Time Monitoring Agent rt t5

Procedurev On the system where you want to send a command to the

monitoring agent, change to the /opt/ibm/ccm/agent/bin directory, and enterany of the following commands where name is the agent script name.

Command Description

./name-agent.sh status Checks the monitoring agent status.

./name-agent.sh start Starts the monitoring agent. If the agent hasinstances, enter an instance name after thecommand.

./name-agent.sh stop Stops the agent. If the agent has instances,enter an instance name after the command.

./name-agent.sh config instance_namepath_to_silent_config_file

Configures the monitoring agent. Run thecommand in the directory where theconfiguration file is located or include it inthe path command.If the agent has instances, enter an instancename. For more information, see “Installinga monitoring agent on Linux”, step 6 onpage 13.

./name-agent.sh uninstall Uninstalls the monitoring agent. For moreinformation, see “Uninstalling monitoringagents” on page 90.

./smai-agent.sh uninstall_all Uninstalls all the monitoring agents on themanaged system.

./name-agent.sh View a description of the functions that areavailable with the script.

v On the system where you want to send a command to themonitoring agent, change to the C:\IBM\ITM\bin directory on the command line,and enter any of the following commands where name is the agent script name.

Command Description

name-agent.bat status Checks the monitoring agent status.

name-agent.bat start Starts the monitoring agent. If the agent hasinstances, enter an instance name after thecommand.

name-agent.bat stop Stops the agent. If the agent has instances,enter an instance name after the command.

Chapter 3. Administering 101

Page 108: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Command Description

name-agent.bat config instance_namepath_to_silent_config_file

Configures the monitoring agent. Run thecommand in the directory where theresponse file is located or include it in thepath command.If the agent has instances, enter an instancename. For more information, see “Installinga monitoring agent on Windows”, step 4 onpage 15.

name-agent.bat uninstall Uninstalls the monitoring agent. For moreinformation, see “Uninstalling monitoringagents” on page 90.

smai-agent.bat uninstall_all Uninstalls all the monitoring agents on themanaged system.

name-agent.bat View a description of the functions that areavailable with the script.

Enabling diagnostics and method trace data for WebSphere serversIf you have the IBM Application Diagnostics (SaaS) service subscription, use theAgent Configuration page to enable diagnostics and method trace data collection.

Before you beginv You must have IBM Application Diagnostics (SaaS) in your environment.v You must install and configure the Monitoring Agent for WebSphere

Applications on a virtual machine.v You must enable support for the collection of diagnostics data in the data

collector configuration. If you follow the simple configuration procedure,support for the collection of diagnostics data is automatically enabled. If you usethe advanced configuration procedure, you can choose whether to enablesupport for the collection of diagnostics data.

Tip: The Agent Configuration page show all the servers that are monitored by theagent. If any server is missing, it might not be correctly monitored. Check theagent log files on the monitored VM for error messages, for example, connectionerrors.

About this task

To display data in the Request Summary, Request Instances, and Request Sequencediagnostics dashboards, diagnostics data collection must be enabled for each serveryou are monitoring.

To display method data in the Request Sequence diagnostics dashboard, you mustenable diagnostics data and method trace data for each server you are monitoring.Method trace is disabled by default for each application server.

Important: If you enable method trace data collection, the application server loadand network traffic are significantly increased.

Take these steps to configure the collection of diagnostics and trace data for eachserver.

102 IBM Performance Management (SaaS): BETA Documentation

Page 109: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Procedure1. From the navigation bar, select System Configuration > Agent

Configuration. The Agent Configuration page is displayed.2. Go to the WebSphere tab.3. To enable diagnostics mode for one or several servers, complete these steps:

a. Select the check boxes of the servers on which you want to collectdiagnostics data.

b. From the Actions list, select Enable Diagnostics Mode. The status in theCurrent Diagnostics Mode column is updated to Yes for each selectedserver.

4. To enable diagnostics mode and method data collection for one or severalservers, complete these steps:a. Select the check boxes of the servers on which you want to collect

diagnostics and method trace data.b. From the Actions list, select Enable Diagnostics Mode and Method Trace.

The status in the Current Method Trace and the Current Diagnostics Modecolumns is updated to Yes for each selected server.

5. To disable method data collection for one or several servers, complete thesesteps:a. Select the check boxes of the servers on which you do not want to collect

method trace data.b. From the Actions list, select Disable Method Trace. The status in the

Current Method Trace column is updated to No for each selected server.6. To disable diagnostics mode and method data collection for one or several

servers, complete these steps:a. Select the check boxes of the servers on which you do not want to collect

method trace and diagnostics data.b. From the Actions list, select Disable Diagnostics Mode and Method Trace.

The status in the Current Method Trace and the Current Diagnostics Modecolumns is updated to No for each selected server.

Results

You configured the collection of transaction tracking, diagnostics and method tracedata for each selected server.

Enabling diagnostics data for Ruby on Rails applicationsIf you have the IBM Application Diagnostics (SaaS) service subscription, use theAgent Configuration page to enable diagnostics data collection.

Before you beginv You must have IBM Application Diagnostics (SaaS) in your environment.v You must install and configure the Monitoring Agent for Ruby on a virtual

machine.v You must configure support for the collection of diagnostics data in the data

collector configuration. For instructions, see “Configuring the Ruby agent” onpage 42.

Chapter 3. Administering 103

Page 110: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

About this task

To display data in the diagnostics dashboards, you must enable the collection ofdiagnostics data for each managed system you are monitoring. After you configuresupport for diagnostics data in the data collector configuration, the collection ofdiagnostics data is enabled by default for each managed system.

Take these steps to enable and disable the collection of diagnostics data for eachmanaged system:

Procedure1. From the navigation bar, select System Configuration > Agent

Configuration. The Agent Configuration page is displayed.2. Click the Ruby tab.3. To enable diagnostics data collection for one or more managed system,

complete these steps:a. Select the check boxes of the managed systems on which you want to

collect diagnostics data.b. From the Actions list, select Enable Data Collection. The status in the Data

Collector Enabled column is updated to Yes for each of the selectedmanaged systems.

4. To disable diagnostics data collection for one or more managed system,complete these steps:a. Select the check boxes of the managed systems on which you do not want

to collect diagnostics data.b. From the Actions list, select Disable Data Collection. The status in the

Data Collector Enabled column is updated to No for each of the selectedmanaged systems.

Results

You configured the collection of diagnostics data for each of the selected managedsystems.

Enabling Transaction TrackingTransaction Tracking is installed as a service and is then queried for data.Depending on the configuration you initially installed, you may need to enableTransaction Tracking to display topologies and instance data.

You can also disable Transaction Tracking if required, for scale, network, orperformance reasons, or if you downgrade to IBM Monitoring (SaaS).

For information about enabling and disabling Transaction Tracking, see thefollowing topics:v Microsoft .NET agentv Response Time Monitoring agentv WebSphere Applications agent

Advanced ConfigurationUse the Advanced Configuration page to control event forwarding.

104 IBM Performance Management (SaaS): BETA Documentation

Page 111: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Event ManagerThe Event Manager controls the forwarding of events using Simple MailTransfer Protocol.

You can use the following parameters to configure your events fromPerformance Management (SaaS) to automatically open tickets in IBMSmartCloud Control Desk. For additional configuration tasks, see“Configuring integration with IBM SmartCloud Control Desk” on page 79.v Target Email Addresses specifies the email addresses that events are

forwarded to. Separate each address with a comma (,), such [email protected],[email protected],[email protected].

v Email Subject Line is the text to use in the subject line of everyforwarded SMTP email event.

For information on forwarding your events to the IBM TivoliNetcool/OMNIbus event manager, see “Installing the Integration Agent forNetcool/OMNIbus” on page 80.

Chapter 3. Administering 105

Page 112: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

106 IBM Performance Management (SaaS): BETA Documentation

Page 113: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Chapter 4. Agent reference

The monitoring agent reference documentation is available through ServiceManagement Connect. This documentation provides information on data sets,dashboard widgets, and thresholds. You can download the agent reference PDFsfrom the Documentation section in the IBM Performance Management (SaaS) wiki.

Additionally, when you are logged in to the Performance Management console,

you can access the online help by clicking Help > Help Contents.

© Copyright IBM Corp. 2014 107

Page 114: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

108 IBM Performance Management (SaaS): BETA Documentation

Page 115: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Chapter 5. Troubleshooting

Review the troubleshooting topics for problems you might experience withinstalling, configuring, or using IBM Performance Management (SaaS).

You can also go to Support on IBM Service Engage (http://ibmserviceengage.com/support/) to search for troubleshooting topics, access the blog, and participate inthe forum.

Additional agent-specific troubleshooting information is available at the followinglinks:v For the Linux OS agent and Windows OS agent, see the IBM Tivoli Monitoring

V6.3 FP2 documentation on the wiki.v For the Response Time Monitoring Agent, see the “Troubleshooting: Web

Response Time” topic in the SmartCloud Application Performance ManagementInformation Center.

v For the WebSphere Applications agent, see the Application PerformanceDiagnostics troubleshooting documentation on the wiki.

Installation troubleshootingReview the installation troubleshooting symptoms and solutions for help withinstallation and upgrade issues.

Agent installation failsIf the monitoring agent fails to install, you can run commands to clean up theenvironment, and start the installation again.

Also, check the installation path. The agent installation fails if parentheses orspaces are included in the installation path. For example, C:\mydownloads\APMaaS_Agent_Install_1.1(1) must be amended toC:\mydownloads\APMaaS_Agent_Install_1.1 for a successful installation.

If a monitoring agent installation or upgrade from a previous version fails, theinstallation might have been terminated abnormally. For example, you might closethe command window while the monitoring agent is being upgraded. An errormessage is displayed, such as KCICF9004E: Installation failed. SeeC:\IBM\ITM\InstallITM\Abort*.log file for more details.

Agent installation or upgrade failsIf the installer reports that the agent installation or upgrade fails, use thefollowing command to uninstall the monitoring agent, and start theinstallation again:

name_agent.sh uninstall

name_agent.bat uninstall

where name is the type of monitoring agent, such as os or rt.

If the uninstall command fails, clean up the environment and run thesmai-agent.sh ininstall_all.sh or agent_cleanup.bat script and start theinstallation again.

© Copyright IBM Corp. 2014 109

Page 116: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Framework installation or upgrade failsIf the installer reports that the framework installation or upgrade fails,clean up the home directory and use the following command to uninstallall monitoring agents, and start the installation again:

smai-agent.sh uninstall_all

smai-agent.bat uninstall_all

Uninstallation of monitoring agents failIf the monitoring agents fail to uninstall, you can check whether or not the rpmdatabase is corrupted.

Uninstallation fails because of a corrupted rpm database on Linux systemsIf the uninstall command fails, and returns Failed dependencies in thecommand prompt output, you might have a corrupted rpm database.1. Check whether or not your rpm database is corrupted by using the

following command:/usr/lib/rpm/rpmdb_verify /var/lib/rpm/Packages

2. If errors are reported, the rpm database might be corrupted. To rebuildthe database, run the following command:

rpm --rebuilddb

3. After the database is rebuilt, run the uninstall script again:./smai-agent.sh uninstall_all

Agent troubleshootingReview the agent troubleshooting symptoms and solutions for help with agentissues.

Linux KVM agent: Errors with the agent contentDepending on your environment, you might encounter errors with certainattributes.

SymptomThe CPU model, and topology attributes, for example, sockets per node,cores per socket and threads per core are not available.

SolutionSelect a solution for one of the following environments:v Red Hat Enterprise Linux (RHEL) 5.x environment

In the Red Hat Enterprise Linux (RHEL) 5.x environment, you can usethe processing information to create new VMs or domains. Then, goingforward, you can ignore previous VMs. To create these new VMs ordomains, as you create a virtual machine or domain, complete thefollowing steps:1. Use the virsh command to output xml to a file: > virsh dumpxml >

domain1.xml.2. Manually, update the domain1.xml with the domain name and UUID

and add the cpu model and the following topology elements:<cpu match="exact">

<model>genuineIntel</model><topology sockets="1" cores="2"threads="1"/.

</cpu>

110 IBM Performance Management (SaaS): BETA Documentation

Page 117: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Note: For more information about values that relate to the modelelement, see CPU model and topology (http://libvirt.org/formatdomain.html#elementsCPU)

3. Create a new virtual machine or domain by using the followingupdated xml file: > virsh create domain1.xml

v RHEL 6.x environment1. On the command console, run the > virt-manager command.2. In the Virtualization Manager window, double click the VM to

configure.3. From the Virtual Machine window menu, select View > Details.4. Select Processor. Then, in the Configuration section, set the CPU

model, and in the Topology section, set the topology details.

SymptomWhen the agent is installed in RHEL 5.x environment, or an agent that isinstalled in RHEL5 or RHEL6 monitors a RHEL 5 KVM host, the followingattributes and attribute groups are unavailable:

Table 12. Unavailable attribute groups and attributes in an RHEL 5 environment

Attribute Group Attribute

Host Memory VM Memory Allocated -- value displayed as0

Percent Memory Used -- value displayed as0

VM Memory Allocated Fit Estimate --Unavailable

Virtual Machine Memory Allocated (GB) -- Unavailable

Memory Used (GB) -- Unavailable

Memory Percent -- Unavailable

SolutionThis issue is known with the RHEL 5.x environment. You must install theLinux KVM agent and the KVM host on the RHEL 6.x. environment.

Linux KVM agent: Errors with the KVM Hypervisor installationon UNIX

Certain errors occur with the KVM Hypervisor installation on UNIX.

SymptomDuring a command-line installation, you install a component that isinstalled, and you see the following warning:WARNING - you are about to install the SAME version of "component_name"where component_name is the name of the component that you are attemptingto install.

Important: This problem affects UNIX command-line installations. If youmonitor Windows environments only, this problem occurs if you install aproduct component, for example, a monitoring server on a UNIX system.

SolutionYou must exit and restart the installation process. You must not return to

Chapter 5. Troubleshooting 111

Page 118: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

the list where you selected the components to install. When you run theinstaller again, you must not attempt to install any component that isinstalled.

SymptomA message similar to"Unable to find running CMS on CT_CMSLIST"

is displayed in the log file.

SolutionThe agent cannot connect to the monitoring server and you must confirmthe following environment settings:1. Do multiple network interface cards (NICs) exist on the system?

If multiple NICs exist on the system, you must determine the NIC thatis configured for the monitoring server.

2. Ensure that you specify the correct host name and port settings forcommunication in the IBM Tivoli Monitoring environment.

SymptomAfter installation, the Linux KVM agent instance fails to start.

The following message is shown in the agent log:(4CF55620.003F-1:kbbssge.c,52,"BSS1_GetEnv") KBB_SIG1="-asyncoff -syncoff-dumpoff"(4CF55620.0040-1:signalmanager.cpp,170,"startManagerThread") Error starting signal managerthread.Return code = 11; Resource temporarilyunavailable. Use the return code and message to investigate the failure.Agent is terminating.

SolutionThe cause of the problem is the pdksh public domain Korn shell. You mustuninstall the pdksh shell and install the ksh rpm that is included on theLinux installation media.

SymptomIn the agent log, you see the messageSEVERE: DataSource.connect: failed to connect to data source ip address

SolutionFind the hypervisor URI of the host that failed to connect. The URI is listedin a message just before the failed to connect message.

On the computer where the agent is installed, enter the exportLIBVIRT_DEBUG=yes command followed by the virsh -chypervisor urithat failed command.

You must review the extra debug messages for symptoms of an underlyingproblem.

SymptomYou turn on the extra libvirt messages by using the exportLIBVIRT_DEBUG=yes command. Then, when you run the virsh -chypervisoruri command, you see this message:bash: nc: command not found

SolutionInstall netcat-openbsd on the host of the hypervisor that you want tomonitor.

112 IBM Performance Management (SaaS): BETA Documentation

Page 119: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Linux KVM agent: Errors with negative valuesYou might encounter problems in relation to values on some VMs.

SymptomSome values, for example, VM Memory Used (GB), or Percent MemoryUsed are negative.

SolutionThis is a known issue in Red Hat Enterprise Virtualization Manager(RHEVM) API 3.2 as shown in this Bug (https://bugzilla.redhat.com/show_bug.cgi?id=1068884). The problem is resolved in RHEVM API V 3.3.4and V 3.4.0. If you can not upgrade to RHEVM API V 3.3.4 or RHEVMAPI V 3.4.0, then restart the VM or the host.

Linux KVM agent: An oVirt API error in the RHEVMenvironment

For RHEVM, an oVirt API error occurs in the log files after you start the LinuxKVM agent.

SymptomThe following message is shown in the log files:An oVirt API error has occurred while connecting to <host_name>:code :401reason: Unauthorizeddetail: <html><head><title>JBoss Web/7.3.0Final-redhat-1 - JBWEB000064:Error report</title><style>...

Solution

1. Ensure that the specified password for the RHEVM connection iscorrect.

2. Alternatively, ensure that the host name matches the host name in theserver security certificate.

Generally, security certificates from the RHEVM server are qualified by thedomain name, rather than the IP address. You must use the domain namein the certificate to specify the host name in the configuration.

SymptomSome values, for example, VM Memory Used (GB), or Percent MemoryUsed are negative.

SolutionThis is a known issue in Red Hat Enterprise Virtualization Manager(RHEVM) API 3.2 as shown in this Bug (https://bugzilla.redhat.com/show_bug.cgi?id=1068884). The problem is resolved in RHEVM API V 3.3.4and V 3.4.0. If you can not upgrade to RHEVM API V 3.3.4 or RHEVMAPI V 3.4.0, then restart the VM or the host.

PHP agent: Dashboard widget data does not updateWhen working with the Monitoring Agent for PHP and the Post Request - Bottom5 and Visited Post Request - Top 5 widgets stop updating data when Post activitiesare running, you might need to delete old records from MySQL.

SymptomData for the Post Request - Bottom 5 and Visited Post Request - Top 5widgets does not update.

SolutionIf there are more than 1000 request records in MySQL, the PHP agent

Chapter 5. Troubleshooting 113

Page 120: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

might not update the data in the associated widgets. To correct the issue,delete the old records from MySQL and limit the total number of recordsto less than 1000. For example, you can use the following command:delete FROM prefix_req_stat_log WHERE`update_time` < ’2014-03-29 00:02:10’ ;

Where prefix is the name of your req_stat_log file.

Ruby agent: Instance not discoveredYou can create logical applications for displaying in the Application PerformanceDashboard that include your monitored Ruby on Rails applications.

If you have a Ruby application but do not see it in the list of available instancesfor adding to an application, read the symptoms, possible cause, and solution.

SymptomsWhile attempting to add a Ruby instance to an application (instructions in“Managing applications” on page 98), you do not see a started instance inthe list.

The Ruby instance was added to an application but does not appear in theApplication Performance Dashboard.

Cause The Ruby instance was started with daemonized Ruby processes. Forexample, you started the Ruby on Rails application using the rails servercommand with a -d argument.

SolutionDo not run Ruby applications in a daemon process.

WebSphere Applications agent: WebSphere Liberty serverdoes not start after it is configured with the data collector

After you configure the data collector when you installed the , the WebSphereLiberty server might not start due to a JRE version issue.

SymptomThe WebSphere Liberty server fails and the message Server server_namestart failed. Check server logs for details is displayed. A line withthe error message JVMJ9TI001E Agent library am_ibm_16 could not beopened is created in the console.log file, or on the console if the serverattempted to start by using the “run” option.

SolutionMessage JVMJ9TI001E Agent library am_ibm_16 could not be openedindicates that the version of JRE used to start the WebSphere Liberty serveris different from the version of JRE used to run the configuration utility.Because WebSphere Liberty doesn't provide its own JRE, it is required touse the same JRE version (JVM bit version and vendor) for running theconfiguration utility and running a WebSphere Liberty server.

To resolve the problem, set the JAVA_HOME environment variable to theversion of JRE that is used to run the WebSphere Liberty server, then rerunthe configuration utility.

Tomcat agent: Tomcat server not monitoredIn case of certain configuration errors, the Tomcat server is not monitored after youhave configured the Tomcat agent.

114 IBM Performance Management (SaaS): BETA Documentation

Page 121: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

SymptomNo monitoring data is displayed for a Tomcat server

SolutionEnsure that the agent is started. To check the status of the agent, change tothe /opt/ibm/ccm/agent/bin and enter the following command:./tomcat-agent.sh status

To start the agent, enter the following command:/opt/ibm/ccm/agent/bin/tomcat-agent.sh start instance_name, whereinstance_name is the name of the instance that you have set duringconfiguration.

Ensure that the JMX remote is enabled in the Tomcat server. Forinstructions, see https://tomcat.apache.org/tomcat-6.0-doc/monitoring.html#Enabling_JMX_Remote.

If, after these checks, the server is still not monitored, rerun theconfiguration for the agent, ensuring that you enter correct information.For instructions, see “Configuring the Tomcat agent” on page 45.

Microsoft .NET agent: Dashboards do not update or displaydata

When you are working with the Microsoft .NET agent and its dashboards, thegroup widgets might either display no data or take a long time to load data.

SymptomSome of the group widget do not display data or are slow to update.

Solution

1. Verify that JSO files are being generated in the C:\IBM\ITM\dcruntime\data\request directory. If JSO files are generated, complete these steps:a. Modify the JSO file properties in the data collector properties file:

1) From the C:\IBM\ITM\qe\config directory, open thedotNetDcConfig.properties.inactive file in a text editor.

2) Decrease the maximum number of records stored in a JSO file.Modify the value of the kqe_svc.requestRecordCount property.The default value is 1000.

3) Decrease the maximum number of JSO files that are maintainedin the output directory. Modify the value of thekqe_svc.maxJsoCount property. The default value is 100.

4) Activate the configuration changes. Enter: cd C:\IBM\ITM\qe\binconfigdc activateconfig

5) Restart the .NET application.b. Modify the criteria for loading JSO files.

1) From the C:\IBM\ITM\TMAITM6_x64 directory and open therundotnetagent.bat file in a text editor.

2) Decrease the time span criteria of the JSO files to load. Modifythe value of the -Dkqe.timespan property in the following line:"%JAVA_HOME%\bin\java" -classpath %CLASSPATH%-Dkqe.cache.interval=%KQE_CACHE_INTERVAL% -Xmx1024m-Dkqe.timespan=1800 -Djlog.propertyFileDir.CYN=%KQE_LOG_CONFIG%

Chapter 5. Troubleshooting 115

Page 122: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

-Dattributegroup.def.jar=%ATTRIBUTE_DEF%-Ddc.runtime.dir=%DC_RUNTIME_DIR% com.ibm.tivoli.monitoring.annotation.cpci.CommonAgentCustomClient> %STDOUT_LOG% 2>&1

In this example, the agent loads JSO files that were generated inthe last 30 minutes (1800 seconds).

3) Restart the agent.a) Enter: cd C:\IBM\ITM\bin\dotnet-agent.bat stop

b) Enter: cd C:\IBM\ITM\bin\dotnet-agent.bat start

If no JSO files are generated, complete these steps:1. Verify that diagnostics data collection is enabled in the data collector

configuration:a. From the C:\IBM\ITM\qe\bin directory, to view the data collector

configuration enter configdc getconfig

b. Verify that the .NET Data Collector Enabled property is set to Trueand the HttpModule property is set to Enabled. For example:Configuration Enabled: True.NET Data Collector Enabled: TrueTransaction Application Server Enabled: TrueTransaction Application Server Host: 127.0.0.1Transaction Application Server Port: 5456Profiler: EnabledSOAP: EnabledHttpModule: EnabledISAPI: EnabledTrace Log Garbage Collection: Disabled

2. Verify that the profiler service is started. From a command prompt,enter net status DotNetProfilerService.If it is stopped, enter net start DotNetProfilerService.

Getting Started links blocked in ChromeIn the Chrome v21 browser, you are blocked from going to the linked page.Review the description and solution.

SymptomWhen using the Chrome v21 or later browser, you are blocked fromopening the links in the Getting Started page.

DiagnosisStarting with Chrome v21, any unsecured (HTTP rather than HTTPS) orunauthenticated browser links are blocked.

SolutionClick the shield tool and select “Load unsafe script”" to continue to thepage. Alternatively, right-click the link and select “Open in new tab” or“Open in new browser” to continue to the page.

116 IBM Performance Management (SaaS): BETA Documentation

Page 123: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Dashboards show no data, partial data, or incorrect data from themonitoring agent

If you do not see data in the Application Performance Dashboard for a particularmonitoring agent, check for time out errors and ensure you are using NTP(Network Time Protocol) on the monitored system.

Additionally, review the agent-specific solutions in this topic.

SymptomIn the Application Performance Dashboard ( Performance >Application Performance Dashboard), you see no data, partial data, orincorrect data for a specific agent or agents after selecting an item in theGroups or Instance section of the navigator.

Diagnosis and SolutionThis problem can occur when the monitoring agent's clock is notsynchronized with your Application Performance Management console. Ifthe agent's clock is set ahead of the infrastructure clock, the agent mightnot download the latest configuration from the infrastructure.

Use NTP (Network Time Protocol) on monitored systems to insure the timeon the system running the agent is accurate. Time zones must be setcorrectly for the time zone they are in, such as UTC-3 for Brasilia and UTC+9 for Seoul.

If your problem was not solved by using NTP, review the logs toinvestigate further.

All monitoring agents:On the system where the monitoring agent is installed, review themost recent agent log for any command timeout messages. Agentlog names are host_name_pc_agent_instance_name_timestamp.log

wherehost_name is the name of the system on which the agent isinstalledpc is the two-character product code, such as kj or km

agent_instance_name is the name that was given to the instanceduring agent configurationtimestamp is the time and date when the log was savedand the path is

opt/ibm/ccm/agent/logs

C:\IBM\ITM\TMAITM6_x64\logs

If you see that command timeout messages appear frequently, theagent's shell script might be taking too long to return withinformation and is timing out. The time out period is controlled inthe pc_agent_instance_name.config file by theCDP_DP_SCRIPT_TIMEOUT environment variable, which has a defaultvalue of 30 seconds. Set CDP_DP_SCRIPT_TIMEOUT andCDP_DP_REFRESH_INTERVAL to higher values to give the scriptsenough time to complete successfully.

PHP agent:Your Apache version might be lower than the supported version.Check the Apache HTTP Server httpd.conf configuration file and

Chapter 5. Troubleshooting 117

Page 124: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

ensure that both the mod_status and ExtendedStatus On options areenabled. For more information, see “Configuring the PHP agent”on page 34.

Ensure the PHP agent plug-in in WordPress is activated. For moreinformation, see “Configuring the PHP agent” on page 34.

In the WordPress List widget, you might see PHP or a different textstring listed under WordPress Document Root. This text string doesnot follow the standard format for the WordPress Document Root.This error might be caused by a PHP module exception. To ensurethe PHP modules are working, execute the php -m command.Correct any modules with warnings or exceptions.

Ruby agent:On the system where the monitoring agent is installed, review thekm_agent_instance_name_script.log for any entries withCMD=CONNECTION that start withapp_name#app_root_directory#IP_address#port_number#pid#mem.

Each line following the timestamp corresponds to a different Rubyapplication. For example, if a user has an application named“MongoStore” with root directory /root/Ruby/mongodb_store, oneof the rows might look like this example:

MongoStore#/root/Ruby/mongodb_store#9.42.14.228#4444#20522#4959124

9.42.14.228 corresponds to the IP address of the system thatthe application is on4444 corresponded to the application's listening port number20522 corresponds to the product ID of the application4959124 corresponded to the system's memory

If the line starts with the pound sign (#) instead of the app_name,you must reconfigure the Ruby agent instance to include the Rubyruntime binary location.

Dashboard shows no events or event statusIf you can see metrics from a data source but no severity indicator is displayed inthe Application Performance Dashboard Events tab, or no threshold events arebeing reported, you might need to restart the monitoring agent.

Threshold events have unknown severity after agent recycleIf the monitoring agent is stopped and restarted, the event severity information islost and any new events show a severity of Unknown.

Thresholds are not applied to the monitoring agentAfter a threshold is created, the threshold is never applied to the monitoring agent.This problem might occur because of a time synchronization issue.

SymptomAfter a new threshold is created for a data source in the ThresholdManager, the threshold is never applied to the monitoring agent.

DiagnosisThis problem can occur when the monitoring agent's clock is not

118 IBM Performance Management (SaaS): BETA Documentation

Page 125: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

synchronized with your Application Performance Management console. Ifthe agent's clock is set ahead of the infrastructure clock, the agent mightnot download the latest configuration from the infrastructure.

SolutionUse NTP (Network Time Protocol) on monitored systems to insure the timeon the system running the agent is accurate. Time zones must be setcorrectly for the time zone they are in, such as UTC-3 for Brasilia and UTC+9 for Seoul.

Changed language but some text is still in EnglishAfter setting the language in your browser, you still see some text in English.Review the diagnosis and possible resolution.

SymptomYou set the primary language in your browser, closed down all browserwindows, restarted the browser, and logged in. Most of the PerformanceManagement console content appears in the language that you set butsome text is still in English.

DiagnosisSome of the supported browsers distinguish between text returned fromthe monitoring infrastructure and text rendered locally, and treat thetranslations differently.v In Mozilla Firefox, there is no difference and you should see everything

in the language you set.v In Google Chrome, if you selected your preferred language and

highlighted it but did not click Display Google Chrome in thislanguage, you might see some text in English.

v In Microsoft Internet Explorer, you might see some text in English.

Solution

v In Google Chrome, return to the language settings, select your preferredlanguage and click Display Google Chrome in this language.

v In Microsoft Internet Explorer, set the operating system for yourlanguage.

Restriction: Some agents, installation scripts, names of data sets, and theircomponent attributes are not translated. This is a current limitation.

Locale supportIBM Performance Management (SaaS) supports the IBM Group 1 languages andseveral other languages. The Language Licenses are translated in the IBM Group 1languages and the other supported languages, with the exception of Hungarianand Thai.

This product supports the IBM Group 1 languages, which are listed here:v Germanv Spanishv Brazilian Portuguesev Frenchv Italianv Japanese

Chapter 5. Troubleshooting 119

Page 126: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

v Koreanv Traditional Chinesev Simplified Chinesev Russian

The following languages are also supported:v Thaiv Czechv Polishv Hungarian

Language licences are translated into the following languages:v Czechv Germanv Greekv Englishv Spanishv Frenchv Indonesianv Italianv Japanesev Koreanv Lithuanianv Polishv Portuguesev Russianv Slovenianv Turkishv Chinesev Traditional Chinese

Collecting monitoring agent logs for IBM SupportUse the problem determination collection tool, pdcollect, to gather required logs andother problem determination information that is requested by IBM Support formonitoring agents.

The PD collector tool is installed with each monitoring agent.

Before you begin

Root or administrator permission is required for the PD collector tool to collectsystem information from the monitoring agents. You can review the agent logsindividually in the (Linux) opt/ibm/ccm/agent/logs and (Windows)C:\IBM\ITM\TMAITM6_x64\logs folders.

About this task

To run the PD collector tool, complete the following steps:

120 IBM Performance Management (SaaS): BETA Documentation

Page 127: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Procedure1. On the command line, change to the agent directory:

v /opt/ibm/ccm/agent/bin

v C:\IBM\ITM\BIN

2. Run the following command:v ./pdcollect

v pdcollect

A file with a time stamp in the file name is generated in the tmp directory, suchas /tmp/pdcollect-nc049021.tar.Z.

3. Send the output files to your IBM Support representative.

What to do next

If you have installed the Ruby agent and you have IBM Application Diagnostics(SaaS), run the kkm collector tool, kkmCollector, on Linux systems to gatherconfiguration files, output files such as JSO files, and log files.1. Change to the /opt/ibm/ccm/agent/lx8266/km/bin directory.2. Run the command ./kkmCollector

A file with a time stamp in the file name is generated in the tmp directory, suchas /tmp/kkm_dchome.tar.gz

3. Send the output files to your IBM Support representative.

Chapter 5. Troubleshooting 121

Page 128: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

122 IBM Performance Management (SaaS): BETA Documentation

Page 129: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Accessibility

Accessibility features help users with physical disabilities, such as restrictedmobility or limited vision, to use software products successfully. IBM PerformanceManagement (SaaS) supports a command prompt interface for installation and aweb-based interface for configuration and usage. Product functionality andaccessibility features vary according to the interface.

The major accessibility features in this product enable users in the following ways:v Use assistive technologies, such as screen-reader software and digital speech

synthesizer, to hear what is displayed on the screen. Consult the productdocumentation of the assistive technology for details on using those technologieswith this product.

v Operate specific or equivalent features using only the keyboard.v Magnify what is displayed on the screen.

In addition, the product documentation was modified to include the followingfeatures to aid accessibility:v All documentation is available in both HTML and convertible PDF formats to

give the maximum opportunity for users to apply screen-reader software.v All images in the documentation are provided with alternative text so that users

with vision impairments can understand the contents of the images.

Performance Management (SaaS) and its related publications, areaccessibility-enabled. For more information about the accessibility features of thedocumentation, see Accessibility.

Note: Some content presented in IBM Knowledge Center might not yet be in aformat that a screen reader can process. If you need help, [email protected].

Interface information

The interface offers the greatest range of functionality, but is not entirely accessible.

Navigating the interface using the keyboard

Standard shortcut and accelerator keys are used by the product and aredocumented by the operating system. See the documentation provided by youroperating system for more information.

Magnifying what is displayed on the screen

You can enlarge information on the product windows using facilities provided bythe operating systems on which the product is run. For example, in a MicrosoftWindows environment, you can lower the resolution of the screen to enlarge thefont sizes of the text on the screen. See the documentation provided by youroperating system for more information.

© Copyright IBM Corp. 2014 123

Page 130: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

IBM and accessibility

See the IBM Human Ability and Accessibility Center for more information aboutthe commitment that IBM has to accessibility.

124 IBM Performance Management (SaaS): BETA Documentation

Page 131: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Notices

This information was developed for products and services offered in the U.S.A.IBM may not offer the products, services, or features discussed in this document inother countries. Consult your local IBM representative for information on theproducts and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product,program, or service that does not infringe any IBM intellectual property right maybe used instead. However, it is the user's responsibility to evaluate and verify theoperation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not give youany license to these patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785 U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBMIntellectual Property Department in your country or send inquiries, in writing, to:

Intellectual Property LicensingLegal and Intellectual Property LawIBM Japan, Ltd.19-21, Nihonbashi-Hakozakicho, Chuo-kuTokyo 103-8510, Japan

The following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law :

INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THISPUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESSFOR A PARTICULAR PURPOSE.

Some states do not allow disclaimer of express or implied warranties in certaintransactions, therefore, this statement might not apply to you.

This information could include technical inaccuracies or typographical errors.Changes are periodically made to the information herein; these changes will beincorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.

Any references in this information to non-IBM Web sites are provided forconvenience only and do not in any manner serve as an endorsement of those Websites. The materials at those Web sites are not part of the materials for this IBMproduct and use of those Web sites is at your own risk.

© Copyright IBM Corp. 2014 125

Page 132: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

IBM may use or distribute any of the information you supply in any way itbelieves appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purposeof enabling: (i) the exchange of information between independently createdprograms and other programs (including this one) and (ii) the mutual use of theinformation which has been exchanged, should contact:

IBM Corporation2Z4A/10111400 Burnet RoadAustin, TX 78758 U.S.A.

Such information may be available, subject to appropriate terms and conditions,including in some cases payment of a fee.

The licensed program described in this document and all licensed materialavailable for it are provided by IBM under terms of the IBM Customer Agreement,IBM International Program License Agreement or any equivalent agreementbetween us.

Any performance data contained herein was determined in a controlledenvironment. Therefore, the results obtained in other operating environments mayvary significantly. Some measurements may have been made on development-levelsystems and there is no guarantee that these measurements will be the same ongenerally available systems. Furthermore, some measurement may have beenestimated through extrapolation. Actual results may vary. Users of this documentshould verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers ofthose products, their published announcements or other publicly available sources.IBM has not tested those products and cannot confirm the accuracy ofperformance, compatibility or any other claims related to non-IBM products.Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.

All statements regarding IBM's future direction or intent are subject to change orwithdrawal without notice, and represent goals and objectives only.

This information is for planning purposes only. The information herein is subject tochange before the products described become available.

This information contains examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples include thenames of individuals, companies, brands, and products. All of these names arefictitious and any similarity to the names and addresses used by an actual businessenterprise is entirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, whichillustrate programming techniques on various operating platforms. You may copy,modify, and distribute these sample programs in any form without payment toIBM, for the purposes of developing, using, marketing or distributing applicationprograms conforming to the application programming interface for the operatingplatform for which the sample programs are written. These examples have not

126 IBM Performance Management (SaaS): BETA Documentation

Page 133: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

been thoroughly tested under all conditions. IBM, therefore, cannot guarantee orimply reliability, serviceability, or function of these programs. You may copy,modify, and distribute these sample programs in any form without payment toIBM for the purposes of developing, using, marketing, or distributing applicationprograms conforming to IBM's application programming interfaces.

Each copy or any portion of these sample programs or any derivative work, mustinclude a copyright notice as follows: © (your company name) (year). Portions ofthis code are derived from IBM Corp. Sample Programs. © Copyright IBM Corp.2014. All rights reserved.

If you are viewing this information in softcopy form, the photographs and colorillustrations might not be displayed.

Trademarks

IBM, the IBM logo, and ibm.com are trademarks or registered trademarks ofInternational Business Machines Corp., registered in many jurisdictions worldwide.Other product and service names might be trademarks of IBM or other companies.A current list of IBM trademarks is available on the web at “Copyright andtrademark information” at www.ibm.com/legal/copytrade.shtml.

Adobe, Acrobat, PostScript and all Adobe-based trademarks are either registeredtrademarks or trademarks of Adobe Systems Incorporated in the United States,other countries, or both.

Cell Broadband Engine is a trademark of Sony Computer Entertainment, Inc. in theUnited States, other countries, or both and is used under license therefrom.

IT Infrastructure Library is a registered trademark of the Central Computer andTelecommunications Agency which is now part of the Office of GovernmentCommerce.

Intel, Intel logo, Intel Inside, Intel Inside logo, Intel Centrino, Intel Centrino logo,Celeron, Intel Xeon, Intel SpeedStep, Itanium, and Pentium are trademarks orregistered trademarks of Intel Corporation or its subsidiaries in the United Statesand other countries.

ITIL is a registered trademark, and a registered community trademark of TheMinister for the Cabinet Office, and is registered in the U.S. Patent and TrademarkOffice.

Java, JavaBeans, and all Java-based trademarks and logos are trademarks orregistered trademarks of Oracle and/or its affiliates.

Linear Tape-Open, LTO, the LTO Logo, Ultrium, and the Ultrium logo aretrademarks of HP, IBM Corp. and Quantum in the U.S. and other countries.

Linux is a trademark of Linus Torvalds in the United States, other countries, orboth.

Microsoft, Windows, Windows NT, and the Windows logo are trademarks ofMicrosoft Corporation in the United States, other countries, or both.

UNIX is a registered trademark of The Open Group in the United States and othercountries.

Notices 127

Page 134: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

Other company, product, or service names may be trademarks or service marks ofothers.

Privacy policy considerations

IBM Software products, including software as a service solutions, (“SoftwareOfferings”) may use cookies or other technologies to collect product usageinformation, to help improve the end user experience, to tailor interactions withthe end user or for other purposes. In many cases no personally identifiableinformation is collected by the Software Offerings. Some of our Software Offeringscan help enable you to collect personally identifiable information. If this SoftwareOffering uses cookies to collect personally identifiable information, specificinformation about this offering’s use of cookies is set forth below.

Depending upon the configurations deployed, this Software Offering may usesession cookies that collect each user’s user name for purposes of sessionmanagement, authentication, and single sign-on configuration. These cookies canbe disabled, but disabling them will also likely eliminate the functionality theyenable.

If the configurations deployed for this Software Offering provide you as customerthe ability to collect personally identifiable information from end users via cookiesand other technologies, you should seek your own legal advice about any lawsapplicable to such data collection, including any requirements for notice andconsent.

For more information about the use of various technologies, including cookies, forthese purposes, See IBM’s Privacy Policy at http://www.ibm.com/privacy andIBM’s Online Privacy Statement at http://www.ibm.com/privacy/details thesection entitled “Cookies, Web Beacons and Other Technologies” and the “IBMSoftware Products and Software-as-a-Service Privacy Statement” athttp://www.ibm.com/software/info/product-privacy.

128 IBM Performance Management (SaaS): BETA Documentation

Page 135: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance
Page 136: IBM Performance Management (SaaS): BETA Documentation · Chapter 1. Product overview IBM® Performance Management (SaaS) is a comprehensive solution that helps manage the performance

����

Printed in USA