TIBCO Service Performance Manager Installation and Configuration ®

TIBCO Service Performance Manager Installation and Configuration ®
TIBCO® Service Performance Manager
Installation and Configuration
Software Release 2.3.0
May 2015
Two-Second Advantage®
2
Important Information
SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH
EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY
(OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE
EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY
OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.
USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND
CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED
SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE
CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD
OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE)
OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER
LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THE
SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND
YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE
BOUND BY THE SAME.
This document contains confidential information that is subject to U.S. and international copyright laws
and treaties. No part of this document may be reproduced in any form without the written
authorization of TIBCO Software Inc.
TIBCO and Two-Second Advantage are either registered trademarks or trademarks of TIBCO Software
Inc. in the United States and/or other countries.
Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform Enterprise
Edition (J2EE), and all Java-based trademarks and logos are trademarks or registered trademarks of
Oracle Corporation in the U.S. and other countries.
All other product and company names and marks mentioned in this document are the property of their
respective owners and are mentioned for identification purposes only.
THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT
ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED
AT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWARE
VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM.
THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL
ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE
CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO
SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S)
AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.
THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR
INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE,
INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.
Copyright © 2008-2015 TIBCO Software Inc. ALL RIGHTS RESERVED.
TIBCO Software Inc. Confidential Information
TIBCO® Service Performance Manager Installation and Configuration
3
Contents
Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6
Installation Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Installation Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Database Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Installation Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Installation Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Installing TIBCO Service Performance Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Installing in GUI Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Installing in Console Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Installing in Silent Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Verifying Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
TIBCO HOME Files and Directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Postinstallation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Postinstallation Steps for the EMS Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Setting EMS_HOME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Creating EMS Queues and Factories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Postinstallation Steps for Admin Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Setting the Properties in spmteaagent.properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Setting the JMX Properties in tibspm.tra . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Postinstallation Steps for the SPM Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Configuring the Service Performance Manager and the TIBCO ActiveMatrix Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Generating the Database Schema and Starting the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Starting the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Starting TIBCO SPM Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Uninstallation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Uninstalling in GUI Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Uninstalling in Console Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Configure TIBCO Service Performance Manager Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Guidelines for Running TIBCO Configuration Tool in the GUI Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Configuring the TIBCO Service Performance Manager Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Configuring the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Generating Service Performance Manager Database Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Running TIBCO Configuration Tool in the Console Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Changing the Heap Size of the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
TIBCO® Service Performance Manager Installation and Configuration
4
Changing the Heap Size in Console Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Configure the Admin Agent for SPM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Creating a Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Logging Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Server Logging Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
TIBCO SPM Dashboard Logging Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
TIBCO SPM Admin Agent Logging Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
TIBCO StreamBase LiveView Project Generator Logging Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Service Performance Manager Example Logging Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Integration with TIBCO StreamBase LiveView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
LiveView Desktop for Data Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Generating The LiveView Project Based on SPM Schemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Running the Example LiveView Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Running the Client API Application Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Client Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Overriding the Default Property Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
LiveView Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Hawk Integration Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Types of Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Deployment Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
TIBCO Enterprise Message Service Server Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
TIBCO Service Performance Manager Server Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Improving the Performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Data Retention Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
TIBCO® Service Performance Manager Installation and Configuration
5
Figures
Domain Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42
Hawk Integration with TIBCO StreamBase LiveView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
TIBCO® Service Performance Manager Installation and Configuration
6
TIBCO Documentation and Support Services
All TIBCO documentation is available on the TIBCO Documentation site:
https://docs.tibco.com
Product-Specific Documentation
Documentation for TIBCO products is not bundled with the software. Instead, it is available on the
TIBCO Documentation site. To directly access documentation for this product, double-click one of the
following file depending upon the variant of TIBCO Enterprise Administrator you are using:
TIBCO_HOME\release_notes\TIB_spm_<version>_docinfo.html.
The following documents for this product can be found on the TIBCO Documentation site:
®
●
TIBCO Service Performance Manager Installation and Configuration
●
TIBCO Service Performance Manager User's Guide
●
TIBCO Service Performance Manager API Reference Guide
●
TIBCO Service Performance Manager Agent for ActiveMatrix BusinessWorks™ User's Guide
●
TIBCO Service Performance Manager Release Notes
®
®
®
®
How to Contact TIBCO Support
For comments or problems with this manual or the software it addresses, contact TIBCO Support:
●
For an overview of TIBCO Support, and information about getting started with TIBCO Support,
visit this site:
http://www.tibco.com/services/support
●
If you already have a valid maintenance or support contract, visit this site:
https://support.tibco.com
Entry to this site requires a user name and password. If you do not have a user name, you can
request one.
How to Join TIBCOmmunity
TIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts. It is a
place to share and access the collective experience of the TIBCO community. TIBCOmmunity offers
forums, blogs, and access to a variety of resources. To register, go to:
https://www.tibcommunity.com
TIBCO® Service Performance Manager Installation and Configuration
7
Installation Overview
Before proceeding with the actual installation, you must get familiar with installation modes,
installation types, prerequisites, and profiles.
Installation Modes
Three installation modes are available: GUI, console, and silent.
GUI Mode
In the GUI mode, the installer presents panels using which you can select a product, its location, and
so on. To invoke the installer in the GUI mode, double-click the executable.
Console Mode
You can use the Console mode to run the installer from the command prompt or terminal window.
This is useful if your machine does not have a GUI environment.
Silent Mode
You can use the silent mode to install the product using either default or custom settings that are
saved in a response file. The silent mode installs the product without prompting you for information.
Installation Types
Two installation types are available: Profile or Custom.
●
The Profile installation type installs all the software for a specific profile.
●
The Custom installation type enables you to select components.
Installer Account
Microsoft Windows
You must have administrator privileges for the machine on which this product is installed. If you do
not have administrator privileges, the installer exits. You must then log out of the system and log in as
a user with the required privileges, or request your system administrator to assign the privileges to
your account.
If you intend to install the product on a network drive, ensure that the account used for installation
has the permission to access the network drive.
UNIX
Any of the following users can install this product.
●
Regular (non-root) user
●
Super-user (root)
A graphic environment such as CDE or X Windows is required to run the installer in the GUI mode.
Installer Log File
The installer log file, tibco_universal_installer.username_install.log, is written to the .TIBCO/
install_timestamp folder of the user’s home directory.
To change the location of the installer log file, specify the option -V
run the installer.
logFile="myLogFile"
when you
The installer log file captures the following information:
TIBCO® Service Performance Manager Installation and Configuration
8
●
Installation environment details such as the user that invoked the installer, host name, Java home in
the environment, operating system details, and so on
●
List of assemblies installed
Installation Prerequisites
Before installing in an existing installation environment, all the processes that are using Java from
must be stopped.
TIBCO_HOME
Before you run TIBCO Universal Installer on your Windows or UNIX system, you must login as a user
with appropriate permissions, and your system must meet the hardware and software requirements as
mentioned in the following sections.
Some software is required, and the rest is optional. Before you run the installer, make sure you are
running on a supported platform. See the readme file available at readme.txt for information about
the supported operating system platforms, versions, and about the required patches.
Hardware Requirements
For information about the hardware and software requirements, as well as supported platforms, related
TIBCO software, and third party products, see the readme file that is provided with the product.
The Universal Installer requires disk space in the temporary directory before installation, and
additional space in the temporary directory for running the installer. Refer to the following table and
ensure you have sufficient disk space available in the directory you want to use as the installation
environment (TIBCO_HOME) directory.
Installation Prerequisites
Directory /
Location
Disk Space Requirement
Temporary
Directory before
installation. For
example, c:/
temp or /tmp
Before you start the installation, you need this space to download the installable
archive file. For example, the file with the name
TIB_spm_<version>_win_x86.zip is the installable archive file. This file needs
about 140 MB of disk space.
Temporary
Directory during
installation.
This is the directory where you must unzip the installable zip so that you can
later execute Universal Installer.
For example, c:/
temp/
spm200install
This directory requires about 275 MB of disk space.
On Microsoft Windows, the default temporary directory location is
%SystemDrive%:/Documents and Settings/user_name/Local Settings/
or /tmp/
Temp.
spm200install
If your system does not have sufficient free disk space in the default temporary
directory, you can use the is:tempdir option when starting the installer, to run
the installer with a different temporary directory.
For example: TIBCOUniversalInstaller
-is:tempdir /new_tmp
where /new_tmp has sufficient free disk space.
Installation
Environment
Directories
The installation directory is SPM_HOME, that needs at least 350 MB of disk space.
TIBCO® Service Performance Manager Installation and Configuration
9
Software Requirements
The installation includes some of the components, although they may be optional.
Refer to the following table for the software requirements for a well-functioning system. Refer to the
readme file for details about the supported versions of various third-party software components.
Software Requirement
Mandator
y
Bundled with
Installer?
TIBCO
Enterprise
Message
Service
(EMS)
Yes
No, it is not
supplied
within installer
and needs a
separate
installation.
TIBCO Enterprise Message Service is the messaging
transport. At least one EMS server must be installed on
the network that can be used with TIBCO Service
Performance Manager.
Java
Runtime
Environme
nt (JRE)
Yes
Yes, it is
supplied
within the
installer.
TIBCO Service Performance Manager bundles Java
Runtime Environment (JRE) 1.7.0 with available
patches, on the target machine. However, you need
not use the JRE bundled with installer and can use
your version of JRE (new or previously installed on
the same machine). In that case, you need to edit/
modify the required.tra and .cfg files to reflect the
accurate JRE location.
Tomcat
Web Server
Yes
Yes, it is
supplied
within the
installer
TIBCO Service Performance Manager bundles Tomcat
7.x. It is not a prerequisite as during the installation
process, it is installed on your machine.
Software
Comments
The Tomcat web server is necessary to host the TIBCO
ActiveMatrix(R) Dashboard application.
Database
Yes
No, it is not
supplied
within installer
and needs a
separate
installation.
TIBCO Service Performance Manager requires a
database for data persistence. You may connect to
Oracle, PostGreSQL, DB2, or MS SQL Server - one of
the external JDBC compliant database(s).
TIBCO
StreamBase
No
No, it is not
supplied
within
installer.
If you plan to install LiveView during TIBCO Service
Performance Manager installation, you needs a
separate installation of LiveView. Using LiveView
Desktop, you can monitor the data.
®
TIBCO
StreamBase
LiveView®
Database Requirements
There are some limitations observed while working with DB2 and MS SQL Server.
DB2 Requirements
If you are using DB2 for data persistence, use the following configuration:
TIBCO® Service Performance Manager Installation and Configuration
10
●
Set the table space size to 32k. For example,
CREATE DATABASE <spm db> AUTOMATIC STORAGE YES ON 'C:/' USING CODESET IBM-1252
TERRITORY US COLLATE USING SYSTEM PAGESIZE 32768;
●
Set the Bufferpool to 32k.
MS SQL Server Requirements
●
Enable SNAPSHOT transaction isolation for MS SQL Server database.
To enable READ_COMMITTED_SNAPSHOT for the Service Performance Manager database, run
the following commands as Database System Administrator (sa):
ALTER DATABASE <spmDB name> SET READ_COMMITTED_SNAPSHOT ON;
ALTER DATABASE <spmDB name> SET ALLOW_SNAPSHOT_ISOLATION ON;
●
When using SQL Server, ensure that you use case sensitive collation. You may enable case sensitive
collation using a command similar to the following:
CREATE DATABASE spm COLLATE SQL_Latin1_General_CP1_CS_AS;
Refer to the SQL Server documentation for more information regarding collation.
Installation Environment
Before installation, make sure the system meets all the prerequisites. First, decide on the installation
environment and folder and then download and extract the installation package.
●
TIBCO_HOME
is the top-level installation directory for TIBCO products.
●
TIBCO_HOME
is referred to as the installation environment.
Installation environments isolate product installations; a product installed into an installation
environment does not automatically access components in other environments.
An installation environment consists of a name and a folder.
●
The name identifies the environment and it is appended to the name of the Windows services
created by the installer. It is a component of the path to the product in the Windows Start > All
Programs menu.
●
The folder contains the installed software. When you install, you can choose a new installation
environment or an existing installation environment.
If a previous installation of a TIBCO product did not use the TIBCO Universal Installer, the TIBCO
Universal Installer does not detect the folder it uses as an installation environment folder. If you wish to
use the existing location as the installation folder, create a new installation environment and choose the
folder where the other products exist.
Installation Profiles
During custom installation, you can choose from three different installation profiles: TIBCO Service
Performance Manager, SPM Admin Agent and ActiveMatrix BusinessWorks 5 Agent. Depending on
the profile you choose, select components get installed.
Components of Service Performance Manager
Component
Description
Server
When you select the TIBCO Service Performance Manager profile, this
component is selected by default. Installs the TIBCO Service Performance
Manager Server components.
TIBCO® Service Performance Manager Installation and Configuration
11
Component
Description
Client
When you select the TIBCO Service Performance Manager profile, this
component is selected by default. Installs the TIBCO Service Performance
Manager Client components.
TIBCO
ActiveMatrix
Dashboard
When you select the TIBCO Service Performance Manager profile, this
component is selected by default. Installs the TIBCO ActiveMatrix Dashboard
application to display aggregated and computed key performance indicators
(KPI) in easy-to-understand dashboard layouts for TIBCO ActiveMatrix 3.3.x.
WebServer Apache Tomcat
When you select the TIBCO Service Performance Manager profile, this
component is selected by default. Installs the Apache Tomcat web server to
host TIBCO ActiveMatrix Dashboard application.
Adapter for TIBCO
StreamBase
LiveView
When you select the TIBCO Service Performance Manager profile, this
component is selected by default. Installs necessary artifacts for integration
with TIBCO StreamBase LiveView. Provides out-of-the-box samples of predefined dashboards to view TIBCO Service Performance Manager computed
KPI results using LiveView Desktop.
TIBCO SPM
Dashboard
When you select the TIBCO Service Performance Manager profile, this
component is selected by default. Installs the TIBCO SPM Dashboard
application which is a dashboard server that provides snapshot and
streaming queries to any SPM schema hosted by the server. This dashboard is
used by Admin Agent.
Admin Agent
This is an optional component. Installs Admin Agent for administration of
SPM and dashboard servers and provides rules and alerting for the products
monitored by SPM servers.
ActiveMatrix
BusinessWorks 5
Agent
This is an optional component. Select this profile if you want to use an agent
to interact with TIBCO ActiveMatrix Business works™. If you do not have
Service Performance Manager installed, ensure that it is one of the profiles
selected when you are performing a custom installation.
TIBCO® Service Performance Manager Installation and Configuration
12
Installing TIBCO Service Performance Manager
Install TIBCO products with TIBCO Universal Installer. The installer runs on multiple platforms. You
can run the installer in the GUI mode, console mode, or silent mode.
The following sections describe the installation process in the available installation modes:
●
Installing in GUI Mode
●
Installing in Console Mode
●
Installing in Silent Mode
Installing in GUI Mode
When you run the installer in the GUI mode, the installer prompts you for information about the
installation environment, and other customizations.
Procedure
1. Open the physical media or download the package.
2. Extract the contents of the package to a temporary directory.
3. Navigate to the temporary directory.
4. Run TIBCOUniversalInstaller. You can do so in one of the following ways:
●
Double-click the installer icon.
●
On the command prompt, provide the absolute path of the installer file without specifying any
options. The installer defaults to the GUI mode.
a) On the Welcome dialog, click the Next button. Read through the license text when the License
Agreement dialog appears, select the I Accept The Terms of The License Agreement radio
button, and then click the Next button.
5. In the TIBCO Installation Home dialog, select an installation environment.
An installation environment isolates product installations. A product installed into an installation
environment does not access components in other installation environments. An installation
environment consists of a name and path. You can specify a new environment or an existing
environment.
●
Create A New TIBCO_HOME: To install the product into a new installation environment, specify
the following properties:
Directory
The directory into which the product is installed. Type a path or click Browse to specify the
path or accept the default location.
The path cannot contain special characters such as "*", "#", "?", ">", "<", "%", "&", "$", "`", or "|".
The path cannot be the same as the path of an existing environment.
Name
Identifies the installation environment. The name cannot contain special characters such as
"*", "?", ">", "<", ":", "|", "/", "\", or quotation marks(").
The name is appended to the name of the Windows services created by the installer. It is a
component of the path to the product in the Windows Start > All Programs menu.
TIBCO® Service Performance Manager Installation and Configuration
13
If you install TIBCO Enterprise Message Service after installing Service
Performance Manager, ensure that the EMS_HOME property points to the TIBCO
Enterprise Message Service installation directory in various configuration files and
startup scripts. See Setting EMS_HOME.
●
Use An Existing TIBCO_HOME: To install the product into an existing installation environment,
select the environment from the drop-down list.
In this case, select Use An Existing TIBCO_HOME to install this product into the TIBCO_HOME
directory where the TIBCO products are installed.
Click the Next button.
6. By default, TIBCO Universal Installer selects the Typical installation profile.
To customize the profile feature settings, select the Customize Installation check box and use the
feature tree on the right. Click the Next button.
Installation
Profile
Description
TIBCO Service
Performance
Manager
Select this profile to install the following components:
1. Client
2. Server
3. TIBCO ActiveMatrix Dashboard: is primarily used by TIBCO
ActiveMatrix to monitor TIBCO ActiveMatrix assets.
4. TIBCO SPM Dashboard: is a dashboard provided by Service Performance
Manager. This is especially useful when you interact with TIBCO
Enterprise Administrator using an agent or when you want to build your
custom dashboards.
5. Adapter for TIBCO StreamBase LiveView: is used to interact with TIBCO
StreamBase LiveView, which is a plug-in to TIBCO Service Performance
Manager.
Admin Agent
Select this profile if you want the Service Performance Manager to be exposed
®
to the TIBCO Enterprise Administrator. The installs an Admin Agent
Runtime. If you are using custom installation, ensure that TIBCO Service
Performance Manager is one of the profiles you have selected. If you are
using an older version of Service Performance Manager, upgrade to the
current version. This version of the release ships the TIBCO SPM Dashboard
that is used by the Admin agent.
The Admin agent interacts with the TIBCO Enterprise
Administrator server that is not shipped with this product. Ensure
that you install TIBCO Enterprise Administrator separately.
ActiveMatrix
BusinessWorks 5
Agent
Select this profile if you want to use an agent to interact with TIBCO
ActiveMatrix BusinessWorks™. If you do not have Service Performance
Manager installed, ensure that it is one of the profiles selected when you are
performing a custom installation.
7. Select the JVM provided by TIBCO or select the JVM installed separately.
8. If the TIBCO EMS Server is not in the same TIBCO_HOME as the TIBCO Service Performance
Manager, you get a warning message that it is not detected in the TIBCO_HOME. The Enterprise
Message server is used by Service Performance Manager so ensure that you install it separately.
Select the JVM provided by TIBCO or JVM installed separately.
TIBCO® Service Performance Manager Installation and Configuration
14
9. (Only on Unix Machines) Perform the following steps:
a) Accept the LGPL License Agreement.
b) Either download or specify the location of the LGPL Assembly.
10. Verify the list of products selected to install and click Install to start the installation process.
11. (Optional) Select Launch TIBCO Configuration Tool to start the configuration process after the
installation. If you want to configure the product later, you can skip this step for now.
To launch TIBCO Configuration Tool later, run TCT_HOME/
is the location you have selected to install TIBCO
Configuration Tool. For example, on Windows system, if you have installed TIBCO
Configuration Tool under TIBCO_HOME, TCT_HOME points to C:/TIBCO_HOME/tct/
<version>.
TIBCOConfigurationTool.TCT_HOME
12. Click the Finish button to complete the installation process and exit the universal installer.
Installing in Console Mode
After you prepare your system and the installation media, you can run the installer in the console
mode.
Procedure
1. Open the physical media or download the package.
2. Extract the contents of the package to a temporary directory.
3. Using a console window, navigate to the temporary directory.
4. Run the following:
Windows
TIBCOUniversalInstaller -console
UNIX
TIBCOUniversalInstaller.bin -console
Mac
./TIBCOUniversalInstaller-mac.command
5. Complete the installation by responding to the console window prompts.
6. To configure, run the following:
Windows TIBCOConfigurationToolc -consoleMode
UNIX TIBCOConfigurationTool -consoleMode
On Windows, the name ends with a c; do not type TIBCOConfigurationTool consoleMode.
Installing in Silent Mode
In the silent mode, the universal installer does not prompt for any inputs during installation. Instead,
the inputs are read from a configuration file that can be provided as a command-line parameter. If no
value is specified, the installer uses the default TIBCOUniversalInstaller_spm_<version>.silent
file.
The TIBCOUniversalInstaller_spm_<version>.silent file is packaged in the directory that contains
the universal installer. Edit the file with information for your environment before launching the silent
installation. The file includes comments that describe the installation properties you can set. While
TIBCO® Service Performance Manager Installation and Configuration
15
using the TIBCOUniversalInstaller_spm_<version>.silent file, copy the file to a different name
and use that file for the silent install.
If errors occur during the installation, they are listed in the installation log file located in the
User_Home/.TIBCO directory.
Procedure
1. Open the physical media or download the package.
2. Extract the contents of the package to a temporary directory.
3. Using a console window, navigate to the temporary directory.
4. Make a copy of the TIBCOUniversalInstaller_spm_<version>.silent file and rename the file.
5. Using a text editor, open the copied file. You may need to update the install location, ENV_NAME, and
features to install.
●
Update the install location. The default location is:
<entry key="installationRoot">C:/tibco</entry>
●
Update features to install. Set the features that you want to install to true.
6. Run the following:
Windows
TIBCOUniversalInstaller.cmd -silent -V responseFile="myfilename.silent"
UNIX
TIBCOUniversalInstaller.bin -silent -V responseFile="myfilename.silent"
7. To configure the product after installation, run TCT_HOME/TIBCOConfigurationTool.
Verifying Installation
Ensure that the installation was successful by verifying that all the folders were successfully created by
the installer.
You can verify the installation by selecting one of the following steps:
Procedure
1. Click Start > Programs > TIBCO > TIBCO Service Performance Manager .
2. Browse to TIBCO_HOME, the folder where TIBCO Service Performance Manager products are
installed. Typically, TIBCO_HOME is c:/tibco. If the files are installed correctly, the files will be
placed as mentioned in TIBCO HOME Files and Directories.
TIBCO HOME Files and Directories
This section discusses the directory structure of TIBCO_HOME and SPM_HOME.
After the product installation, you can see the directory structure as shown in the following table.
TIBCO_HOME
Files and Directories (Cont’d)
Directory
Description
Contents
TIBCO_HOME/_installInfo
Contains information about
all installed products
/assembly_registry
TIBCO® Service Performance Manager Installation and Configuration
16
Directory
Description
Contents
TIBCO_HOME/release_notes
Stores readme and Release
Notes of TIBCO Service
Performance Manager
tib_spm_<version>_rea
dme.txt
TIBCO_HOME/spm,
that is, SPM_HOME
tib_spm_<version>_rel
eotes.pdf
Contains all the TIBCO
Service Performance
Manager components. The
default folder is
TIBCO_HOME/spm/
<version>.
TIBCO_HOME/tct
Contains files related to
TIBCO Configuration Tool
TIBCO_HOME/tea
Contains information about
the Admin agents
agents
The primary focus is on
the contents under
agents/spm/2.3:
/bin
/lib
/logs
/setup
/teagentlib
/ui
TIBCO_HOME/tibcojre64
Contains files used by JRE
/lib
TIBCO_HOME/tools
/scripts
/universal_installer
/wrapper
SPM_HOME/adapters
Contains the TIBCO
StreamBase LiveView
components
/liveview/lib,
lv_examples,
lv_projectgenerator
TIBCO® Service Performance Manager Installation and Configuration
17
Directory
Description
Contents
SPM_HOME/bin
Contains various
executables for running the
Server and example.
tibspmexamples is a
self-running example to
demonstrate the
various client APIs, and
features.
tibspmddlgenerator is
a tool provided to
generate various DDL
and DML scripts for the
chosen type of
database.
is the Service
Performance Manager
server and
tibspmpassword is a
password obfuscator
that can be used to
encrypt password
credentials for
Enterprise Message
Service transport.
tibspm
While using
tibspmpassword, do
not start a password
with the following
special characters:
●
# (pound or hash
sign),
●
! (exclamation sign).
This folder also has
various TRA
configuration files,
corresponding to the set
of executables
mentioned in the earlier
column. It also has
convenience scripts
(setspm4ems.*) to set
up Enterprise Message
Service artifacts for
Service Performance
Manager.
SPM_HOME/config
Contains the configuration
files required by the Server,
example, and Logger
This folder contains
log4j, spm,
spmdashboard, schema
files.
TIBCO® Service Performance Manager Installation and Configuration
18
Directory
Description
Contents
SPM_HOME/apidocs
Contains the APIs
api—Contains JavaDoc
API for all Service
Performance Manager
client APIs.
SPM_HOME/examples
Contains api, and probes,
and schemas subfolders.
api—Contains Java
example code that
executes as
tibspmexamples on
how to use client APIs,
send facts, write
queries, and so on.
probes—Bundles some
sample probes (source
code and compiled
library JAR) .
SPM_HOME/lib
Contains all the Service
Performance Manager
component libraries
SPM_HOME/logs
Default folder for
dashboard and server logs
This is the default
folder where Service
Performance Manager
logs are generated:
spmdashboard.log
spm.log
SPM_HOME/setup
Contains Service
Performance Manager Post
Install - automated setup
script
SPM_HOME/spmdashboard
Contains Service
Performance Manager Web
Application archive
(spmdashboard.war) and
some scripts for monitoring
dashboard data. If you do
not wish to use the bundled
Tomcat Web Container,
deploy this WAR file in
some other web container.
SPM_HOME/spmdashboard/tomcat
Contains the Tomcat web
container
SPM_HOME/spmdashboard/tomcat/logs
Contains the log files for the
Tomcat web container
spmdashboard.war
startspmdashboard.bat
stopspmdashboard.bat
TIBCO® Service Performance Manager Installation and Configuration
19
Directory
Description
Contents
SPM_HOME/smbw_agent
Contains the files and
folders for ActiveMatrix
BusinessWorks 5.x and 6.x
monitoring.
Contains various
folders for
configuration, setup,
and samples:
bin
config
lib
liveview
logs
setup
Postinstallation
After installation, you need to set some properties depending on the location of the TIBCO Enterprise
Message Service server. You also need to set some properties for the SPM Dashboard. If you are using
the Admin Agent, there are additional properties to be set.
1. Postinstallation Steps for the EMS Server: involves setting the EMS_HOME and creating EMS
queues and factories.
2. Postinstallation Steps for the SPM TEA Agent: involves setting the properties in TEA_HOME/
agents/spm/2.3/config/spmteaagent.properties file and enabling the JMX properties in the
SPM_HOME/2.3/bin/tibspm.tra file.
3. Postinstallation Steps for the SPM Dashboard: involves setting the properties in the SPM_HOME/2.3/
spmdashboard/tomcat/bin/setenv.bat file
Postinstallation Steps for the EMS Server
After installing Service Performance Manager, you must set the EMS_HOME and create EMS queues
and factories.
These steps depend on:
●
The installation order of TIBCO Enterprise Message Service and TIBCO Service Performance
Manager
●
Whether they share the same SPM_HOME or use different TIBCO_HOME
●
Whether they are installed on the same machine or on different machines
Setting EMS_HOME
Based on the location of the EMS server and the Service Performance Manager server, you have to
manually set your EMS_HOME.
The following table covers the scenarios and corresponding postinstallation steps.
TIBCO® Service Performance Manager Installation and Configuration
20
Postinstallation
Setup Details
Installation Order
Postinstallation
Single machine
with the same
1. TIBCO Enterprise
Message Service
No manual steps needed
TIBCO_HOME
2. TIBCO Service
Performance Manager
Single machine
with the same
1. TIBCO Service
Performance Manager
Set EMS_HOME to the TIBCO Enterprise Message Service
installation directory in the following files:
TIBCO_HOME
2. TIBCO Enterprise
Message Service
●
SPM_HOME/bin/setems4spm.bat
●
SPM_HOME/bin/tibspm.tra
●
SPM_HOME/bin/tibspmddlgenerator.tra
●
SPM_HOME/bin/tibspmexamples.tra
●
SPM_HOME/bin/tibspmpassword.tra
●
SPM_HOME/examples/probes/hawk_probe/
tibhawkprobe4spm.tra
●
SPM_HOME/adapters/liveview/lv-projectgenerator/
tibspmgenerator4lv.tra
Single machine
with different
TIBCO_HOME
Any order
For example,
EMS_HOME=C:/tibco/EMS/<version>
●
SPM_HOME/spmdashboard/startspmdashboard.bat
●
SPM_HOME/spmdashboard/tomcat/bin/setenv.bat
●
SPM_HOME/spmdashboard/tomcat/bin/service.bat.
TIBCO® Service Performance Manager Installation and Configuration
21
Setup Details
Installation Order
Different
machines where
TIBCO
Enterprise
Message
Service is
installed on
machine 1 and
TIBCO Service
Performance
Manager on
machine 2
Postinstallation
●
●
Perform the following steps:
1.
Copy the following files from SPM_HOME/bin
of machine 2 to EMS_HOME/lib of machine 1:
setems4spm.bat and setems4spm.scr
2.
Execute setems4spm.bat.
Ensure that the folder structure for EMS client
libraries on local machine points to EMS_HOME/
lib.
●
Copy the folder structure EMS_HOME/lib from
machine 1 to machine 2 and place it at the same
level as SPM_HOME. Verify the following files are
present under EMS_HOME/lib on machine 2:
jms.jar (or jms-2.0.jar with EMS 8.0), tibjms.jar,
slf4j*.jar, tibcrypt.jar
●
Update all TRA and bat files to set EMS_HOME =
SPM_HOME
●
Set the EMS_HOME in the following files:
—
SPM_HOME/bin/setems4spm.bat
—
SPM_HOME/bin/tibspm.tra
—
SPM_HOME/bin/tibspmddlgenerator.tra
—
SPM_HOME/bin/tibspmexamples.tra
—
SPM_HOME/bin/tibspmpassword.tra
—
SPM_HOME/examples/probes/hawk_probe/
tibhawkprobe4spm.tra
—
SPM_HOME/adapters/liveview/lvprojectgenerator/tibspmgenerator4lv.tra
—
SPM_HOME/spmdashboard/
startspmdashboard.bat
—
SPM_HOME/spmdashboard/tomcat/bin/
setenv.bat
—
SPM_HOME/spmdashboard/tomcat/bin/
service.bat.
Creating EMS Queues and Factories
The EMS Queues and factories are the channels provided by the EMS server to enable communication
between the client and server.
The non-admin users need Send, Receive, and Browse permissions to access TIBCO Enterprise Message
Service queues.
TIBCO® Service Performance Manager Installation and Configuration
22
Procedure
1. Go to SPM_HOME/bin directory.
2. Make sure that correct EMS_HOME is set in all TRA and configuration files.
3. Open the setems4spm.scr file for editing.
If the EMS server and the Service Performance Manager server are on different machines,
perform the following steps:
Open the setems4spm.bat file, and set EMS_HOME=
machine>.
<EMS_HOME
location of the local
4. If the EMS server and the Service Performance Manager server are set up on different machines,
edit SPM_HOME/bin/setspm4ems.scr script file and replace "localhost" with the appropriate IP
address of the machine on which the TIBCO EMS server is running. For example:
instead of
connect tcp://localhost:7222
create factory SPMQueueConnectionFactory queue
url=tcp://localhost:7222
use
connect tcp://123.456.789.111:7222
create factory SPMQueueConnectionFactory queue
url=tcp://123.456.789.111:7222
5. Replace //localhost with IP address of the machine on which TIBCO Enterprise Message Service
is running in all the property files and startup scripts.
For example,
connect tcp://10.97.122.174:7222
create factory SPMQueueConnectionFactory queue url=tcp://10.97.122.174:7222
6. Execute the command setems4spm.bat. This command creates the required queues and connection
factories to be used by the server and client.
7. If you want to change the names of the connection factories and queues, make corresponding
changes to the Service Performance Manager server, TIBCO ActiveMatrix Dashboard, and sample
files.
Postinstallation Steps for Admin Agent
These steps are optional and are needed only if you install the Admin Agent. The steps involve setting
the properties in the TIBCO_CONFIG_HOME/cfgmgmt/spmteagent/config file and enabling the JMX
properties in the SPM_HOME/2.3/bin/tibspm.tra file. The TIBCO_CONFIG_HOME is the location of
the cfgmgmt folder.
Setting the Properties in spmteaagent.properties
You must specify the hostname, port number, and the TIBCO Enterprise Administrator server URL in
the spmteaagent.properties file.
Procedure
1. Open TIBCO_CONFIG_HOME/tibco/cfgmgmt/spmteaagent/config/spmteaagent.properties.
2. Set the following properties:
TIBCO® Service Performance Manager Installation and Configuration
23
Properties
Description
spm.tea.agent.hostname Specify the hostname of this Admin agent. Make sure that the hostname
specified here is reachable from the TIBCO Enterprise Administrator
server machine, else the agent will not get registered with the TIBCO
Enterprise Administrator server.
spm.tea.agent.port
Specify a port number, ensure it is available.
tea.server.url
If the TIBCO Enterprise Administrator server is remote, specify the
URL. The Admin agent automatically registers with the specified
TIBCO Enterprise Administrator Server.
3. Save the file.
Setting the JMX Properties in tibspm.tra
The Admin agent interacts with the SPM server and the SPM Dashboard through JMX. The JMX
properties are set in the SPM_HOME/2.3/bin/tibspm.tra file.
Procedure
1. Open SPM_HOME/2.3/bin/tibspm.tra.
2. Set the following properties:
Properties
Description
java.property.com.sun.management.jmxremot
e
This property should be set to true.
java.property.com.sun.management.jmxremot
e.host
Specify the IP Address of the remote host.
java.property.com.sun.management.jmxremot
e.port=9500
Specify an available port number. Defaults to
9500.
java.property.com.sun.management.jmxremot
e.authenticate=false
Defaults to true. Set it to false explicitly if
you do not want the remote host to be
authenticated.
java.property.com.sun.management.jmxremot
e.ssl=false
Defaults to true. Set it to false explicitly if
you do not want SSL.
java.property.logback.configurationFile
Specify the location of
file. Defaults to
logbackConfig.xml
TIBCO_CONFIG_HOME/tibco/cfgmgmt/
spmteaagent/config/logback-config.xml.
TIBCO® Service Performance Manager Installation and Configuration
24
Properties
Description
java.property.deploymentConfigurationFile
You can change the property to point to the
location of deploymentConfig.xml file. It
defaults to
TIBCO_CONFIG_HOME/tibco/cfgmgmt/
spmteaagent/config/
deploymentConfig.xml.
The Admin Agent for SPM will refer to this
property for the location of
deploymentConfig.xml file. If no file is found
at this location, it will create a new one under
TIBCO_CONFIG_HOME/tibco/cfgmgmt/
spmteaagent/config.
If the property,
java.property.deploymentConfigurationF
ile,
is not specified, then it looks for the
file in
SPM_TEA_AGENT_HOME/config.
deploymentConfig.xml
SPM_TEA_AGENT_HOME is the location of the
Admin Agent as mentioned in the
tibspmteaagent.tra file.
3. Save the file.
Postinstallation Steps for the SPM Dashboard
The SPM Dashboard is a component shipped with Service Performance Manager. To ensure that the
dashboard works, you need to set some properties in the SPM_HOME/2.3/spmdashboard/tomcat/bin/
setenv.bat file.
Procedure
1. Open SPM_HOME/2.3/spmdashboard/tomcat/bin/setenv.bat.
2. Modify the property, CATALINA_OPTS to have the correct remote host name, port number, ssl and
authentication options, if any. The property is commented by default. The default setting of the
property is as follows:
Platform
Command
Windows
set CATALINA_OPTS=
-Dcom.sun.management.jmxremote Dcom.sun.management.jmxremote.host=localhost
-Dcom.sun.management.jmxremote.port=9600 Dcom.sun.management.jmxremote.ssl=false
-Dcom.sun.management.jmxremote.authenticate=false
Linux
export CATALINA_OPTS=
-Dcom.sun.management.jmxremote Dcom.sun.management.jmxremote.host=localhost
-Dcom.sun.management.jmxremote.port=9600 Dcom.sun.management.jmxremote.ssl=false
-Dcom.sun.management.jmxremote.authenticate=false
3. Save the file.
TIBCO® Service Performance Manager Installation and Configuration
25
Getting Started
After the successful installation of TIBCO Service Performance Manager, you must configure the server,
dashboard, and generate the database schema. After completing the configuration, you can start the
server and the dashboard.
Configuring the Service Performance Manager and the TIBCO ActiveMatrix Dashboard
Before you start monitoring your services, you must configure the Service Performance Manager server
and dashboard.
Procedure
1. Navigate to TIBCO_HOME/tct/<version>, and run TIBCOConfigurationTool to launch TIBCO
Configuration Tool.
2. Refer to the Configuring the TIBCO Service Performance Manager Server to configure the Service
Performance Manager.
3. Refer to the Configuring TIBCO ActiveMatrix Dashboard to configure ActiveMatrix Dashboard.
Generating the Database Schema and Starting the Database
You can either use the TIBCO Configuration Tool or use the SPM_HOME/bin/tibspmddlgenerator
utility to generate the database schema.
Procedure
1. Launch TIBCO Configuration Tool.
2. Refer to Generating Service Performance Manager Database Schema to generate database schema
3. Start the database.
4. Create a database user or schema user as per your database selection.
5. Execute the DDL scripts generated in Step 2..
Ensure that the JDBC driver jar files compatible with the selected database is available to
the server. To do so, add them in the tibspm classpath by either placing them in
SPM_HOME/lib/ext or by directly modifying the classpath in the chosen TRA file.
Starting the Server
Before using the product for monitoring the services deployed, ensure that you start the server.
Procedure
● Start the Server using one of the following methods:
●
Click Start > All Programs > TIBCO > SPM_HOME > TIBCO Service Performance Manager
<version> > Start SPM Server.
●
Start tibspm from SPM_HOME/bin. By default, the tibspm uses tibspm.tra as its configuration
file. If a different TRA file is being used, open the command prompt and use the following
command:
tibspm --propFile <path to the .TRA file>
The server uses a configuration file as specified in the application_args property of the TRA
file that is configured either using TIBCO Configuration Tool or manually.
TIBCO® Service Performance Manager Installation and Configuration
26
Changes to any of the properties require a server restart.
Starting TIBCO SPM Dashboard
During installation, TIBCO Universal Installer renames the default service.bat (supplied by Apache
Tomcat) in SPM_HOME/spmdashboard/tomcat/bin folder to service-preSPM.bat, and copies a
new version of service.bat.
Procedure
1. Edit SPM_HOME/spmdashboard/tomcat/bin/service.bat to substitute %TIBCO_EMS_HOME_ESC%
with appropriate local TIBCO Enterprise Message Service installation path.
After you substitute, you can use this service.bat to start Apache Tomcat hosting the
Service Performance Manager Dashboard application as a Windows Service using
service.bat {install | uninstall} on a Windows command prompt. If you install it
as a Windows Service, an entry - TIBCO SPM Dashboard appears in the services list
(services.msc).
2. To use Enterprise Message Service 8.0.0 or later, edit the file SPM_HOME/spmdashboard/
tomcat/bin/setenv.bat (or setenv.sh) and service.bat and change "%EMS_HOME%/lib/
jms.jar to %EMS_HOME%/lib/jms-2.0.jar.
If you are working with a version earlier than 8.0, skip to the next step.
3. Start the TIBCO SPM Dashboard using one of the following methods:
●
●
Click Start > All Programs > TIBCO > SPM_HOME > TIBCO Service Performance Manager
<version> > Start SPM Generic Dashboard.
Go to the SPM_HOME/spmdashboard folder and run the following executables:
startspmdashboard.bat
The UI for SPM Dashboard is available using Admin agent.
Uninstallation
Uninstall TIBCO products with TIBCO Universal Installer. The installer runs on multiple platforms.
You can run the installer in the GUI mode or console mode.
Uninstalling in GUI Mode
Using the TIBCO Universal Installer, you can uninstall all products in a particular TIBCO_HOME, or you
can uninstall specific products that have been installed in a TIBCO_HOME.
Shut down all running TIBCO applications.
If TIBCO Service Performance Manager Dashboard is started as a Windows Service, it must be stopped
gracefully and there are no open connections to Service Performance Manager and Enterprise Message
Service servers.
Navigate to TIBCO_HOME/tools/universal_installer and run TIBCOUniversalInstaller.
In the TIBCO Installation Manager page, perform the following steps:
●
Select the Uninstall Products From Selected TIBCO Home Location radio button.
●
Select the TIBCO_HOME location from the TIBCO Home Location drop-down list.
The Welcome dialog appears. Click the Next button.
Select an uninstallation option. The wizard provides two uninstallation options:
TIBCO® Service Performance Manager Installation and Configuration
27
●
Custom Uninstall: You can select the products to be removed.
●
Typical Uninstall: The universal uninstaller removes all the products in this TIBCO_HOME.
Click the Next button. If you selected the Custom Uninstall (Select The Products To Be Removed)
radio button, select the check boxes for products to uninstall, and then click the Uninstall button.
Review the Pre-Uninstall Summary and click the Uninstall button to start the uninstallation
process.
Review the Post-Uninstall Summary and click the Finish button to exit the uninstall wizard.
If you have installed Admin Agent, remember that uninstallation does not remove files
under TIBCO_HOME/tea .
Uninstalling in Console Mode
Uninstalling in the console mode helps you uninstall from the command line.
Procedure
1. Using a command window, navigate to the TIBCO_HOME/tools/universal_installer directory.
2. Type the following command at the command prompt:
TIBCOUniversalInstaller -console
3. Complete the uninstallation by responding to the console window prompts.
TIBCO® Service Performance Manager Installation and Configuration
28
Configure TIBCO Service Performance Manager
Components
TIBCO Service Performance Manager provides almost all the configuration by default. However, you
can change the default configuration by using TIBCO Configuration Tool or by using the
corresponding property files.
TIBCO Configuration Tool can be run in one of the following modes: GUI and Console.
Guidelines for Running TIBCO Configuration Tool in the GUI Mode
There are some factors that are common to all components available in the GUI mode
Here are some factors that are common to all components available in the GUI mode:
●
Based on the configuration selected, the wizard prompts you for more information about that
component. You can click Next or Back to traverse the workflow.
●
Use the Save option of the wizard to save your data any time and continue with the configuration
later.
●
Use the Load button to load data from one of your previous sessions.
If you have an existing installation of TIBCO Configuration Tool in a TIBCO_HOME and
you install Service Performance Manager in the same TIBCO_HOME, TIBCO
Configuration Tool does not show the last configured values the next time it is started. In
this case, you have to explicitly load from the previous session folders.
●
While configuring the component, at any point in time, you can click Finish to end the
configuration. When you click Finish, the last screen of the wizard is displayed.
●
If you do not want to continue with the configuration, you can either click Cancel or the Finish
button.
●
Most properties displayed in the wizards have a hover-over tooltip that indicates the equivalent
property in the properties file and the description of the property.
●
Every property that can be configured using the tool can also be manually configured using the
corresponding property file.
●
When TIBCO Configuration Tool starts, the initial data is loaded from TIBCO_HOME/tct/
components/shared/1.0.0/plugins/com.tibco.tct.spm_1.0.0.00X.
Configuring the TIBCO Service Performance Manager Server
You can use TIBCO Configuration Tool to configure the Service Performance Manager server. TIBCO
Configuration Tool is launched using TIBCO_HOME/tct/<version>/TIBCOConfigurationTool.
When TIBCO Configuration Tool starts, the initial data is loaded from TIBCO_HOME/tct/components/
shared/1.0.0/plugins/com.tibco.tct.spm_1.0.0.00X. Alternatively, you can manually change
the properties specified in the SPM_HOME/config/spm-config.properties file.
Procedure
1. Open the spm-config.properties file in the SPM_HOME/config folder for editing.
2. Uncomment the required property, and specify a new value.
TIBCO® Service Performance Manager Installation and Configuration
29
Result
TIBCO Configuration Tool does not recognize the changes made directly to the spmfile. Hence it is recommended to always use TIBCO Configuration Tool to make
changes to the configuration.
config.properties
To start TIBCO Configuration Tool in the console mode, perform the following steps:
●
On the command prompt, navigate to TCT_HOME/<version>.
●
Start TIBCOConfigurationToolc -consoleMode to launch TIBCO Configuration Tool.
Before going through the procedure, ensure that you go through the guidelines in Guidelines for
Running TIBCO Configuration Tool in the GUI Mode.
Configuring the Server
You can configure the database settings, schema settings, threadpool, JMS settings and so on of the
server.
Procedure
1. The following steps help you launch the Configure TIBCO Service Performance Manager Server
wizard:
a) Navigate to TIBCO_HOME/tct/<version>, and run TIBCOConfigurationTool to launch TIBCO
Configuration Tool.
b) Select a TIBCO configuration folder. The TIBCO configuration folder stores configuration data
generated by TIBCO products. Configuration data can include sample scripts, session data,
configured binaries, logs, and so on. If you want, you can change the default location of this
folder.
c) Click Configure TIBCO Service Performance Manager Arguments -V2.3.
d) Click Configure TIBCO Service Performance Manager Server and click Next.
2. Use the properties mentioned in the following table to configure the database and click Next when
you are done.
Database Configuration Properties
Property in
spm-config.
Field Name
properties
Mandator
y
Database
Driver
rta.jdbc.driver
Database
URL
rta.jdbc.url
Default Value
Description
Yes
org.postgresql.Drive
r
Specify the name of
the JDBC driver
Yes
jdbc:postgresql://
Provide the location
of the database
server.
localhost:5432/
database
See the
documentation
specific to your JDBC
driver for more
information.
TIBCO® Service Performance Manager Installation and Configuration
30
Property in
spm-config.
Field Name
properties
Mandator
y
Default Value
Description
Username
rta.jdbc.user
Yes
spm_user
The username that
the Service
Performance
Manager server uses
to access the
database.
This user must have
read and write
permissions to the
database.
Password
rta.jdbc.password
Yes
The password that
the server uses, in
conjunction with the
username provided
in
dbstore_driver_usern
ame, to access the
database
3. (Optional) Select Advanced Options to configure advanced database options.
If you do not select Advanced Options, the advanced properties take default values.
However, if you use Advanced Options, the properties take the last configured values.
a) Provide the following values, and click Next.
Database Configuration Advanced Properties
Field Name
Property in spmconfig.properties
Initial
Connections
Mandat
ory
Default
Value
rta.jdbc.initial.connection.
size
No
10
The number of
connections allowed at
initialization
Max
Connections
rta.jdbc.max.connection.si
ze
No
100
Specifies the maximum
number of
simultaneous client
connections to the
database
Transaction
Batch Size
rta.jdbc.batch.size
No
1000
Specify the database
batch size
JDBC Key
rta.jdbc.key
No
""
Database connection
pool internal identifier
Description
b) (Optional) To test the validity of the connection, click Test Connection. To do so, specify the
JDBC Driver Path. You should make available the driver jars for the database that you choose,
TIBCO® Service Performance Manager Installation and Configuration
31
and specify the full path of this jar file here. TIBCO Configuration Tool modifies the server's
classpath in the specified ".TRA" file.
c) Click Next.
4. Use the properties mentioned in the following table to configure JMS and click Next when you are
done.
JMS Configuration Properties
Field
Name
Property in spmconfig.properties
Context
Factory
rta.jms.jndi.contextfactory
Mandat
ory
Default Value
Description
No
com.tibco.tibjms.naming
.Tibjms
JMS
Transport
JNDI context
factory
InitialContextFactory
Provider
URL
rta.jms.jndi.url
No
tibjmsnaming://
localhost:7222
JMS provider
URL
Username
rta.jms.connection.usernam
e
No
admin
JMS provider
connection
username.
Password
rta.jms.connection.passwor
d
No
JMS provider
connection
password.
The default
value is the
obfuscated
value of
<BLANK>,
Note that it is
not a single
blank space
character.
a) (Optional) Select Advanced Options to configure advanced JMS options. Provide the following
values and click Next.
JMS Configuration Advanced Properties
Property in spmconfig.
Man
dat
Field Name
properties
ory
Default Value
Description
Queue
Connection
Factory
rta.jms.
No
SPMQueue
JMS queue connection
factory
queueconnectionfacto
ry
ConnectionFactory
TIBCO® Service Performance Manager Installation and Configuration
32
Property in spmconfig.
Man
dat
Field Name
properties
ory
Default Value
Description
Inbound Queue
rta.jms.inbound.queu
e
No
spm.inbound.queue
JMS inbound queue
for the Service
Performance Manager
server to receive
messages
Outbound
Queue
rta.jms.outbound.que
ue
No
spm.outbound.queue
JMS outbound queue
for the Service
Performance Manager
server to send
messages
Inbound Query
Queue
rta.jms.inbound.query
.queue
No
spm.inbound.
JMS inbound query
queue for Service
Performance Manager
server to receive
messages.
Fault Tolerance
Queue
rta.ft.queue.name
No
spm.ft.queue
This is the queue on
which the Service
Performance Manager
server exchanges
messages related to
fault tolerance. The
Service Performance
Manager Client API
does not use this
queue.
Retry Interval
rta.jms.connection.ret
ry.interval
No
5000
JMS connection retry
interval. Time
interval in
milliseconds for
retrying a failed JMS
connection.
Outbound
Message Expiry
rta.jms.outbound.
No
432000000
JMS message
expiration in
milliseconds for
outbound messages
from the Service
Performance Manager
server.
a.
message.expiry
query.queue
Use the properties mentioned in the following table to configure the Threadpool and click Next
when you are done.
TIBCO® Service Performance Manager Installation and Configuration
33
Threadpool Configuration Properties
Field Name
b.
Property in spmconfig.properties
Man
dat
ory
Default
Value
Description
Common
Threadpool Size
rta.worker.thread.count
No
32
The number of worker
threads for the common
thread pool
Metric
Compute
Threadpool Size
rta.metric.compute.thread.co
unt
No
32
Number of threads to
perform the core
computation jobs. Each
hierarchy computes on a
single thread.
(Optional) SelectAdvanced Options to configure advanced Threadpool options. Provide the
following values and click Next.
Threadpool Configuration Advanced Properties
Field Name
Property in spmconfig.properties
Man
dat
ory
Default
Value
Description
Common
Threadpool
Queue Size
rta.worker.queue.size
No
64
The queue size for the
common thread pool
Metric Compute
Threadpool
Queue Size
rta.metric.compute.queue.siz
e
No
64
Queue size for the
metric thread pool.
Change it only when
you change
rta.metric.compute.thre
ad.count. A value twice
the queue thread size is
recommended.
Common
Threadpool
Minimum
Threads
rta.worker.thread.count.min
No
0
The minimum number
of threads to retain in
the thread pools even
when there is less load
on them. This value
should be less than or
equal to
rta.worker.thread.count.
TIBCO® Service Performance Manager Installation and Configuration
34
Field Name
Common
Threadpool
Idletimeout
Man
dat
Property in spmconfig.properties
rta.worker.thread.idle.timeo
ut
ory
Default
Value
No
300
Description
Time interval in seconds
after which idle threads
of the thread pools are
stopped, till the thread
count reaches the
rta.worker.thread.count.
min setting.
5. Use the properties mentioned in the following table to configure the server and click Next when
you are done.
Server Configuration Properties
Property in
spm-config.
Man
dat
Field Name
properties
ory
Default Value
Description
Schema Store
Location
rta.schema.store
No
SPM_HOME/config
Location on the file
system where the server
loads the schema files.
L1 Cache Size
rta.l1.cache.size
No
10000
Size of the L1 cache used
to store metric nodes. L1
cache ensures that
frequently used data is
cached inside the JVM
and hence not loaded
from the database. The
L1 cache uses an LRU
algorithm.
a) (Optional) Select Advanced Options to configure advanced server options. Provide the
following values and click Next.
TIBCO® Service Performance Manager Installation and Configuration
35
Server Configuration Advanced Properties
Field Name
Property in spmconfig.properties
Man
dat
ory
Default
Value
Description
Server Batch
Size
rta.server.batch.size
No
100
Client batches
further are
batched on the
server for
processing, for
enhanced
performance.
This property
specifies the
batch size to use
on the server.
Server Batch
Size Flush
Period (ms)
rta.server.batch.flush.period
No
5000
Time interval in
milliseconds to
wait for a server
batch to
complete.
Incomplete
batch is still
processed at this
interval.
Rule Metric
Node Cache
Size
rta.l1.cache.size.rule.metric.nodes
No
10000
Size of the L1
cache used to
store rule/action
state nodes.
Larger cache
with
appropriately
large JVM heap
(-Xmx setting )
results in better
performance.
Session
Heartbeat
Threshold (ms)
rta.config.session.heartbeat.threshol
d
No
60000
Maximum time
in milliseconds
that a named
session can be
kept alive, since
the last heart
beat from client
is received.
TIBCO® Service Performance Manager Installation and Configuration
36
Field Name
Man
dat
Property in spmconfig.properties
ory
Default
Value
Description
Snapshot
Query Timeout
rta.snapshot.query.timeout
No
300000
Defines timeout
in milliseconds
for expiration of
snapshot query.
If the query is
not accessed for
the specified
duration, it
expires after the
specified period.
Rules Actions
Scan Frequency
rta.rules.actions.scan.frequency
No
5000
Specifies in
milliseconds
how often to
scan for
scheduled
actions,
6. Use the properties mentioned in the following table to configure storage and recovery and click
Next when you are done.
Storage and Recovery Configuration Properties
Property in spmconfig.
Man
dat
Field Name
properties
ory
Default Value
Description
Store Facts
rta.store.facts
No
false
Whether to store the facts
into the database. For a
very high transaction
rate, setting this property
to false helps improve
the performance.
Since Service
Performance Manager
2.3.0 relies on EMS for
recovery, it is not
necessary to store these
facts. One may still need
to store them for business
reasons.
TIBCO® Service Performance Manager Installation and Configuration
37
Property in spmconfig.
Man
dat
Field Name
properties
ory
Default Value
Description
Process
Duplicate Facts
rta.process.duplicate.
No
true
Defines whether to
process or skip duplicate
facts. Applicable only
when
rta.store.facts=true.
Else this has no effect.
facts
When set to true,
reprocess a possible
duplicate fact.
When set to false, skip
over a possible duplicate
fact.
7. Use the properties mentioned in the following table to configure mail and log and click Next when
you are done.
Action Configuration Properties
Field Name
Property in spmconfig.properties
Man
dat
ory
Default
Value
Description
SMTP Server
Host
rta.mail.smtp.host
Yes
none
Used by E-mail alert actions.
Specifies the SMTP server
host name.
SMTP Server
Port
rta.mail.smtp.port
No
25
Used by E-mail alert actions.
SMTP server port.
SMTP Server
Username
rta.mail.smtp.user
No
none
Used by E-mail alert actions.
Required only if SMTP
server authentication is true.
Specifies the SMTP server
user name.
TIBCO® Service Performance Manager Installation and Configuration
38
Field Name
SMTP Server
Password
Property in spmconfig.properties
rta.mail.smtp.password
Man
dat
ory
Default
Value
No
Description
Used by E-mail alert actions.
Required only if SMTP
server authentication is true.
Specifies SMTP server user
password.
You can also enter an
encrypted password in this
field. To encrypt the
password, you can use a
password generator tool to
obfuscate it. If the password
entered in the spmconfig.properties file is
plain-text, the same appears
in the Configuration tab on
TIBCO ActiveMatrix
Dashboard.
Authenticate
SMTP Server
rta.mail.smtp.authenticat
ion
No
false
Used by E-mail alert actions.
Specifies whether the SMTP
server authentication is
required or not.
Email Sender
rta.mail.from
No
Current
system
user
Used by E-mail alert actions.
Specifies E-mail From (Email Sender)
Mail Retry
Count
rta.mail.retry.count
No
3
This field is under Advanced
Options. Maximum number
of times to retry the send
email operation. A value of
-1 attempts this operation
infinitely.
Mail Retry
Interval
rta.mail.retry.interval
No
2000
This field is under Advanced
Options. Time interval, in
milliseconds, between retry
attempts.
Log Format
rta.log.alert.format
No
XML
The default format of
logging actions is XML. As
an alternate, you can use the
TEXT format.
8. The following steps show how to handle configuration files:
a) Starting the Service Performance Manager with a TRA file.
The Service Performance Manager server uses two different files, one for starting the server JVM
and another for application configuration. tibspm.tra is the default file used to start the server JVM.
This file provides runtime parameters to start the JVM, such as heap sizes, classpath, etc. It also
passes on the application specific configuration to the server using the application_args
TIBCO® Service Performance Manager Installation and Configuration
39
property. By default, this property points to spm-config.properties in SPM_HOME/config folder.
You can use TIBCO Configuration Tool to change the application_args property to a
different.TRA file as follows:
1. In the SPM Start TRA File option, specify the full path of the new TRA file. Remember that the
TRA file should first be created externally.
To start Service Performance Manager with the new TRA file, use
tibspm --propFile
<new-tra-file>
9. Changing or overriding the existing server configuration.
Save Options for the Configuration File
Option
Description
Override the original
configuration file
Select this option to apply the current configuration to the
existing server configuration file, which by default for the first
time, is spm-config.properties in SPM_HOME/config folder.
Save as a new file
Select this option to create a new file with the specified name
and location.
In both cases, the chosen TRA file (in Starting the Service Performance Manager with a TRA file.) is
modified to use this server configuration by changing its application_args property accordingly.
TIBCO Configuration Tool also stores these changes such that the defaults values are loaded from
the last run.
The default values are not be loaded from the last run if there is a previous version of
TIBCO Configuration Tool installed in this TIBCO_HOME as part of another TIBCO product
installation. If so, you must explicitly load the previously stored configuration using the
"Load" option and point it to the appropriate sessions files.
10. Perform the following steps on the summary page:
a) TIBCO Configuration Tool now shows the location of the folder where the current session state
is stored. You can change it as required. Select a location for the Session Scripts and Log Folder.
b) Ensure that Configure TIBCO Service Performance Manager Arguments is selected. It is
selected by default.
c) Click Configure to configure the server.
Generating Service Performance Manager Database Schema
You can use TIBCO Configuration Tool to generate the database schema. TIBCO Configuration Tool is
launched using TIBCO_HOME/tct/<version>/TIBCOConfigurationTool.
Alternatively, you can use the SPM_HOME/bin/tibspmddlgenerator utility from the command prompt
to generate the database schema.
Before going through the procedure, ensure that you go through the guidelines in Guidelines for
Running TIBCO Configuration Tool in the GUI Mode.
Procedure
1. The following steps help you launch the Configure TIBCO Service Performance Manager Server
wizard:
a) Navigate to TIBCO_HOME/tct/<version>, and run TIBCO Configuration Tool to launch
TIBCO Configuration Tool.
TIBCO® Service Performance Manager Installation and Configuration
40
b) Select a TIBCO configuration folder. The TIBCO configuration folder stores configuration data
generated by TIBCO products. Configuration data can include sample scripts, session data,
configured binaries, logs, and so on. If you want, you can change the default location of this
folder.
c) Click Configure TIBCO Service Performance Manager Arguments -V2.3.
d) Click Generate TIBCO Service Performance Manager Database Schema and click Next.
2. Provide the following details:
a) Database Type: The target database for which the database DDL schema files must be generated.
Select one of the following supported databases: oracle, postgresql, sqlserver, and db2.
b) Config folder: Location of the Service Performance Manager schema XML files. By default, it is at
SPM_HOME/config.
c) Output Folder: The generated scripts are stored at this location. By default, it is at
SPM_HOME/bin/<Database_Type_Name>.
d) Property File: Default values for database output folders and so on are read from a property file.
By default, it is at SPM_HOME/bin/tibspmddlgenerator.tra.
3. Click Generate Scripts to generate the database schema. An information window indicating the
successful creation of the schema is displayed and click OK. In the Output folder location, the
following files are generated:
spm_<database_type_name>_cleanupdml.sql
spm_<database_type_name>_createddl.sql
spm_<database_type_name>_dropddl.sql
a) Click Next.
4. Perform the following steps on the summary page:
a) TIBCO Configuration Tool now shows the location of the folder where the current session state
is stored. You can change it as required.
b) Ensure that Configure TIBCO Service Performance Manager Arguments is selected. It is
selected by default.
5. Click Configure or Cancel or Finish to exit TIBCO Configuration Tool.
Running TIBCO Configuration Tool in the Console Mode
You can run TIBCO Configuration Tool from the command prompt on the platform of your choice.
Procedure
1. In a console window, navigate to the TIBCO_HOME/tct/version directory and run the following
command:
Console Mode Commands
Platform
Description
Linux, UNIX
TIBCOConfigurationTool -consoleMode
Windows
TIBCOConfigurationToolc -consoleMode
(and not TIBCOConfigurationTool
consoleMode.
-
2. The information provided guides you through the steps. Select one of the configuration options and
press Enter.
3. Follow the configuration tool prompts to set up your environment. After you review the
preinstallation summary, type F to view the summary of the configuration.
TIBCO® Service Performance Manager Installation and Configuration
41
4. Type G to start the configuration process.
5. When configuration completes, you can select a second configuration option or type q to quit.
Changing the Heap Size of the Server
You can change the heap size of the Service Performance Manager server by specifying the properties
in the corresponding TRA file, the default being tibspm.tra.
Changing the Heap Size in Console Mode
You can set the initial and maximum heap size in the Console mode.
Follow these steps if you start the server in console mode.
Procedure
1. Open tibspm.tra.
2. Change the following properties:
java.heap.size.initial=128M
java.heap.size.max=256M
Do not explicitly add -Xms, -Xmx properties under java.extended.properties.
3. At the command prompt, uninstall the windows NT service of the Service Performance Manager
server using the following command:
tibspm -uninstall
4. At the command prompt, install the Service Performance Manager server using the following
command:
tibspm -install
5. Restart the service.
To run Service Performance Manager as an NT service, ensure that the following
properties in spm-config.properties are set with the absolute paths:
rta.schema.store=<TIBCO_HOME>/spm/<version>/config
Configure the Admin Agent for SPM
This step is applicable only if you have installed the Admin Agent component. Configuring the Admin
agent involves creating domains for every product that is being monitored by Service Performance
Manager.
Ensure that you have configured the SPM server (logging configuration, database schema and so on),
SPM Dashboard server. Only when the SPM server and dashboard server are running should you
configure the Admin agent for SPM.
To configure the Admin agent, start by creating domains. For details on creating a domain, see Creating
a Domain.
Creating a Domain
A domain is a logical grouping of a collection of Service Performance Manager servers in a fault
tolerant mode and a collection of dashboard servers in a load-balanced mode. It is recommended that
TIBCO® Service Performance Manager Installation and Configuration
42
you create one domain per product. The changes made here affect the TIBCO_CONFIG_HOME/tibco/
cfgmgmt/spmteagent/config/deploymentConfig.xml
Prerequisites
Before using this procedure, ensure that the SPM server, SPM Dashboard server, EMS server, the
TIBCO Enterprise Administrator server, and the Admin agent are running.
Procedure
1. Login to the TIBCO Enterprise Administrator. The default user name and password is admin.
2. Under Products, click the Service Performance Manager card.
The Domain Management pane is displayed. If there is a domain defined in TIBCO_CONFIG_HOME/
tibco/cfgmgmt/spmteagent/config/deploymentConfig.xml, it is displayed in the Domain
Management pane. The health of the SPM Servers and Dashboards in the domain are displayed
here.
Domain Management
3. From the Domain Management pane, click Create Domain.
4. In the Domain Name field, specify the domain name. The domain name should not have spaces or
special characters such as @,#,*, & , and so on.
5. In the Dashboard Access URL, specify the Dashboard Access URL. The default dashboard access
URL is obtained from the TIBCO_CONFIG_HOME/tibco/cfgmgmt/spmteagent/config/
deploymentConfig.xml file. The dashboard access URL specified here is the load balancer URL.
If there is only one dashboard access URL, ensure that you make that as the load balancer
URL.
6. Click Engines.
7. For a particular machine, provide the following details:.
a) Provide IP Address.
b) Provide the SPM Instance and the SPM Instance URL.The URL of the SPM instance is obtained
from TIBCO_CONFIG_HOME/tibco/cfgmgmt/spmteagent/config/deploymentConfig.xml.You
can add multiple SPM Instances, but ensure that those instances are installed and available.
When you are specifying the SPM Instance URL, ensure that they are JMX enabled and
reachable.
c) If you have more machines with SPM server instances, click Add Machine. Repeat the process of
adding machines and SPM instances.
TIBCO® Service Performance Manager Installation and Configuration
43
8. Click Dashboards.
a) Provide IP Address.
b) Provide the name of Dashboard Instance, JMX Connection URL, and the HTTP Access URL.
You can find URL of the SPM Dashboard instance in TIBCO_CONFIG_HOME/tibco/cfgmgmt/
spmteagent/config/deploymentConfig.xml. You can add multiple SPM Dashboard Instances,
but ensure that those instances are installed and available.
c) If you have more machines with SPM server instances, click Add Machine. Repeat the process of
adding machines and SPM instances.
9. Click Save.
The changes made here are reflected in TIBCO_CONFIG_HOME/tibco/cfgmgmt/spmteagent/
config/deploymentConfig.xml.
If you are directly modifying the deploymentConfig.xml file, ensure that you restart the
Admin agent. It is recommended that you do not directly modify the
deploymentConfig.xml file.
Logging Configuration
Each of the Service Performance Manager components uses log4j for application logging.
By default:
●
Server logs are generated under SPM_HOME/logs/spm.log.
●
TIBCO SPM Dashboard logs are generated under SPM_HOME/logs/spmdashboard.log.
●
Example logs are generated under SPM_HOME/logs/spmdemo.log.
TIBCO Service Performance Manager component logging can be configured as follows:
Server Logging Configuration
TIBCO Service Performance Manager server logs are at SPM_HOME/logs/spm.log.
Application Log File Appender
log4j.appender.ApplicationRFileAppender=org.apache.log4j.RollingFileAppender
log4j.appender.ApplicationRFileAppender.File=SPM_HOME/logs/spm.log
log4j.appender.ApplicationRFileAppender.MaxFileSize=10MB
log4j.appender.ApplicationRFileAppender.MaxBackupIndex=10
log4j.appender.ApplicationRFileAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.ApplicationRFileAppender.layout.ConversionPattern= %d{dd MMM yyyy
HH:mm:ss,SSS zzz Z} %p %t [%c] - %m%n
The following appender in the log4j.properties file is used to log actions:
●
Log Action File Appender
Log Action File Appender
log4j.appender.LogActionAppender=org.apache.log4j.RollingFileAppender
log4j.appender.LogActionAppender.File=SPM_HOME/actionlogs/logaction.log
log4j.appender.LogActionAppender.MaxFileSize=10MB
log4j.appender.LogActionAppender.MaxBackupIndex=5
log4j.appender.LogActionAppender.layout=org.apache.log4j.PatternLayout
log4j.category.LogActionLogger=INFO, LogActionAppender
TIBCO SPM Dashboard Logging Configuration
The dashboard logs are generated at SPM_HOME/logs/spmdashboard.log.
You can configure these logs using the SPM_HOME/config/spm_dashboard_log4j.properties log
configuration file. Configure the log file path with the following property:
log4j.appender.dashboardAppender.File=../logs/spmdashboard.log
TIBCO® Service Performance Manager Installation and Configuration
44
By default, Tomcat server logs are generated at SPM_HOME/spmdashboard/tomcat/logs.
TIBCO SPM Admin Agent Logging Configuration
The loggack configuration properties are in logback-config.xml.
For logback configuration, see http://logback.qos.ch/manual/configuration.html. Basic properties are:
1. location of the log file
2. maximum and minimum number of files
3. file size
4. Admin agent log level.
By default, the Admin agent logs are generated at TIBCO_HOME/tibco/cfgmgmt/spmteaagent/
logsspm-tea-agent.log.
TIBCO StreamBase LiveView Project Generator Logging Configuration
On running the sample LiveView project existing in SPM_HOME/adapter/liveview/lv-examples, the
logs are generated at logs/LV_SPM_Adapter.log by default.
You can modify LV_SPM_Logback.xml to change the logging level or log file location.
Service Performance Manager Example Logging Configuration
The example logs are generated at SPM_HOME/logs/spmdemo.log.
You can configure these logs using the SPM_HOME/config/Demo_log4j.properties log configuration
file. Configure the log file path with the following property:
log4j.appender.RFileApp.File=SPM_HOME/logs/SpmDemo.log.
TIBCO® Service Performance Manager Installation and Configuration
45
Integration with TIBCO StreamBase LiveView
You can use TIBCO Service Performance Manager along with LiveView to monitor the data generated
in other TIBCO products.
By designing a service probe, the data is intercepted from the product and sent to TIBCO Service
Performance Manager for aggregation. The aggregated data can be displayed in LiveView Desktop.
LiveView Desktop for Data Monitoring
TIBCO Service Performance Manager supports the use of LiveView to monitor data generated from
products such as TIBCO ActiveMatrix, TIBCO ActiveMatrix BusinessWorks, and TIBCO Hawk.
If you want to monitor the data generated in any product, you must first design a probe that intercepts
the product data and passes it on to the TIBCO Service Performance Manager server. The probe passes
the real time data to the TIBCO Service Performance Manager server where it is aggregated based on
the specified schema. This aggregated data can be viewed in LiveView Desktop.
To integrate TIBCO Service Performance Manager with LiveView, perform the following tasks:
●
Install Adapter for LiveView during the product installation. See the section Installation Profiles for
details.
If Adapter for TIBCO StreamBase LiveView is installed, edit SPM_HOME/adapters/
liveview/lv-projectgenerator/
tibspmgenerator4lv.tra
to set EMS_HOME and STREAMBASE_HOME manually.
●
Define schema according to your product monitoring requirement to be used for aggregation.
●
Design a probe that provides real-time data to TIBCO Service Performance Manager server. See the
sample probe design available in SPM_HOME/examples/probes for reference.
●
Generate the folder structure that is acceptable to LiveView. See Generating The LiveView Project
Based on SPM Schemas for details.
●
View the data in LiveView Desktop.
After you install the Adapter for LiveView, the files for integration get installed in the folder,
SPM_HOME/adapter/liveview. It contains the following subfolders:
●
lib:
●
lv-examples: contains out-of-the-box schema exmples for TIBCO ActiveMatrix 3.0, TIBCO
ActiveMatrix BusinessWorks 5.0, TIBCO Hawk 5.0. You can run these samples and view the out-ofthe-box dashboards in LiveView Desktop.
●
contains the lib files to run LiveView.
lv-projectgenerator:
schema.
provides utility to create LiveView artifacts using the customized xml
Generating The LiveView Project Based on SPM Schemas
TIBCO Service Performance Manager provides a utility, tibspmgenerator4lv, using which you can
generate the necessary artifacts for LiveView dashboards for your own custom Service Performance
Manager XML schema defined for KPI aggregation.
This utility takes the Service Performance Manager XML schema as an input and creates the
appropriate folder structure required for the LiveView project with all the necessary artifacts. With the
help of these generated LiveView projects, you can view the data in LiveView Desktop.
TIBCO® Service Performance Manager Installation and Configuration
46
Procedure
1. Open the SPM_HOME/adapter/liveview/lv-projectgenerator folder.
2. Execute tibspmgenerator4lv as follows:
tibspmgenerator4lv –f <input_directory or file -0 <output_directory
●
<input-directory
itself [Mandatory]
or file>:
the path to a directory containing schema files or a schema file
●
<output-directory> the directory where the LiveView project is generated. Default is current
directory.
For example, tibspmgenerator4lv
–f ../../config –o ./TopLevel/
It creates one folder per schema as shown in the following snippet:.
./DataPurge
./DataPurge/DataPurge.sbapp
./lv-interfaces
./lv-interfaces/AssetHierarchyDemoServiceHitCountPublisher.sbint
./lv-interfaces/AssetHierarchySchemas.sbint
./lv-interfaces/DemoServiceHitCountSchemas.sbint
./lv-systemdata
./SPMDataPublisher
./SPMDataPublisher/SPMDataPublisher.sbapp
AssetHierarchy.lvconf
DataPurge.lvconf
DemoServiceHitCount.lvconf
sbd.sbconf
SPM_Example_Schema.xml
SPMDataPublisher.lvconf
spm-liveview-config.properties
SPMTableSpace.lvconf
LV_SPM_Logback.xml
Each of the generated folders contain an lv-systemdata subfolder where the preconfigured
dashboards are provided. The folder structure adheres to the LiveView server requirement.
3. Replace the variables in sbd.sbconf with actual values:
●
%TIBCO_JAVA_HOME_ESC%:
Replace it with TIBCO JRE path which is included with Service
Performance Manager installation.
●
%TIBCO_SPM_HOME_ESC%:
Replace it with SPM_HOME path.
●
%TIBCO_EMS_HOME_ESC%:
Replace it with EMS_HOME path.
●
Do not change ${STREAMBASE_HOME} variable. The value automatically gets replaced with
running the project using StreamBase command prompt.
4. Compare the generated folder structure with the examples distributed at SPM_HOME/adapters/
liveview/lv-examples.
Running the Example LiveView Project
To know how to work with the distributed examples for LiveView, read the Examples-README.pdf in
the SPM_HOME/adapters/lv-examples folder.
TIBCO® Service Performance Manager Installation and Configuration
47
Samples
There are a few examples that are bundled with the product. The samples can be located at SPM_HOME/
examples.
Running the Client API Application Example
You can run the tibspmexamples to take a look at how the Client API application works.
Procedure
1. Open a command prompt and go to SPM_HOME/bin.
2. Stop and restart the server.
To start the server, click Start > All Programs > TIBCO > SPM_HOME > TIBCO Service
Performance Manager <version> > Start SPM Server. You can manually stop the server by
clicking CTRL+C on the server window.
3. Execute tibspmexamples.
Refer to the example source code distributed in src.zip to know how to use client Java
API. You need to set appropriate PATH and CLASSPATH to compile and execute such
programs. See tibspmexamples.tra to understand the list of all libraries needed.
The list of properties for configuring the samples that are shipped with the product are provided in
Client Properties.
Client Properties
The client properties are used by the sample client program shipped with the product. The
ActiveMatrix probe for TIBCO Service Performance Manager exposes a set of API properties that may
be different from the set of client properties.
Refer to TIBCO ActiveMatrix® Service Grid Installation Addendum document for details on ActiveMatrix
probe for TIBCO Service Performance Manager.
The client properties are only documented for sake of demonstrating the client API configuration
capabilities.
●
The client API does not recognize these properties. The client API only recognizes ConfigProperty
elements.
The Demo_config.properties file includes a subset of the following client properties.
Client Properties
Property
Man
dat
ory
rta.client.connection.username
Yes
Specifies username of metric engine.
rta.client.connection.password
Yes
Specifies password for metric engine.
Default
Value
Description
TIBCO® Service Performance Manager Installation and Configuration
48
Property
Man
dat
ory
Default
Value
Description
rta.client.jms.jndi.contextfactor
y
No
com.tibc
o.tibjms
.naming
.TibjmsI
nitialCo
ntextFac
tory
Specifies context factory class for the JMS
provider
rta.client.jms.jndi.url
No
tibjmsnaming://
Specifies JMS JNDI URL
localhos
t:7222
rta.client.jms.queueconnectionf
actory
No
SPMQu
eueCon
nection
Factory
Queue connection factory name. Needs to be
pre-created
rta.client.jms.inbound.queue
No
spm.inb
ound.qu
eue
Queue name on JMS to perform sync/async
operations
rta.client.jms.outbound.queue
No
spm.out
bound.q
ueue
Queue name on JMS for client to receive
notifications from metric engine
rta.client.taskmgr.threadpool.si
ze
No
5
Number of threads to be used for fact
publishing per session
rta.client.taskmgr.threadpool.k
eepalive.time
No
60
Specifies the time (in seconds) to keep alive the
task manager threads. When this time elapses,
idle threads time out.
rta.client.fact.queue.depth
No
100
Defines the queue depth for the internal queue
for batching facts
rta.client.fact.batch.size
No
1
Number of facts to batch before publishing to
the server
rta.client.fact.eviction.enabled
No
true
Enable or disable async eviction of facts once
the queue depth is full.
When disabled, eviction is done by thread
putting the fact. Disabling it may result in more
facts being lost if the fact batch size is high and
the put rate is more than the consumption rate.
rta.client.fact.eviction.frequenc
y
No
100
You can set this property only if
rta.client.fact.eviction.enabled
true.
is set to
TIBCO® Service Performance Manager Installation and Configuration
49
Property
Man
dat
ory
Default
Value
rta.client.fact.batch.expiry
No
5
Defines the amount of time in seconds to wait
to flush residual facts if the batch size
condition is not met.
rta.client.heartbeat.interval
No
60 *
1000
Specifies time interval in milliseconds used by
named client sessions to send heartbeat
rta.client.ping.interval
No
1000
Time interval in milliseconds used for ping
with the server.
rta.client.retry.count
No
3
Maximum retries for an operation in case it
fails
rta.client.retry.wait
No
1000
Time in milliseconds to wait before retrying the
operation
rta.client.sync.response.timeout
No
10000
Time in milliseconds to wait for the rta engine
to wait for the server to send a response for a
sync operation like query registration
rta.client.sync.jms.msg.expiry
No
5*
60000 =
300000
Time in milliseconds for the JMS provider to
keep a message before it expires
rta.client.logmanager.class
No
"com.tib
co.rta.lo
g.impl.
Default
LogMan
ager"
Specifies external log manager impl.
Description
* @see com.tibco.rta.log.LogManager
* @see com.tibco.rta.log.LogManagerFactory
rta.client.async.dispatcher.max.
pool.size
No
2147483
647
The thread pool used for dispatching results
from outbound queue to clients. For instance,
streaming queries/commands.
rta.client.async.dispatcher.time
out
No
300000
The thread pool used for dispatching results
from outbound queue to clients has an idle
timeout in milliseconds.
Overriding the Default Property Values
If required, you can override the default values of the client properties.
Procedure
1. Open the Demo-config.properties file in the SPM_HOME/config folder for editing.
2. Uncomment the required property and specify a new value.
TIBCO® Service Performance Manager Installation and Configuration
50
LiveView Samples
Selecting Adapter for LiveView during installation installs some integration samples in SPM_HOME/
You can run these samples and view the sample dashboards in LiveView Desktop.
adapter/liveview.
You can change the Service Performance Manager client properties defined in spmdatapublisher.sbpapp. You can change settings such as, the JMS Provider URL, batch size of a
snapshot query, and so on.
The following sections provide more details on these samples:
●
Hawk Integration Sample
●
ActiveMatrix Integration Sample
Hawk Integration Sample
You can integrate a Hawk setup with TIBCO Service Performance Manager. Facts emitted by Hawk are
published on the server. You can use the LiveView dashboard to query such facts and publish it on the
dashboard.
The following diagram shows the various components of integrating a Hawk System with TIBCO
Service Performance Manager and TIBCO StreamBase LiveView.
Hawk Integration with TIBCO StreamBase LiveView
Hawk / Service Performance Manager Adapter
This is a standalone process that consumes the Hawk Console API and interacts with Hawk agents and
Hawk microagents on one side. Configure the adapter to invoke certain microagent methods and the
interval to invoke them.
On the other side, the data returned by the microagents is converted to Service Performance Manager
facts using the Service Performance Manager Client API and published to the Service Performance
Manager server.
The SPM_HOME/examples/hawk_probe folder contains a sample and a readme file that explains how to
setup, configure, and run the sample probe.
Service Performance Manager Server
The Service Performance Manager server is bootstrapped with Hawk Sample SPM Schema. Configure
the Service Performance Manager server to run with the Hawk sample. It involves generating the
corresponding database schema for this sample, and starting the Service Performance Manager server.
TIBCO® Service Performance Manager Installation and Configuration
51
Types of Projects
You can generate three types of projects using LiveView.
Hawk Project for TIBCO StreamBase LiveView
This project is generated using the LiveView project generator utility tibspmgenerator4lv using the
HAWK_5_0_SPM_Schema.xml as input. This is used to bootstrap the LiveView Server.
LiveView Server
Use the generated project as an input to the LiveView server and start the LiveView server. The generic
Service Performance Manager Adapter automatically starts during the LiveView server startup
sequence.
LiveView Dashboard
It is a pre-configured desktop (with pre-configured queries and charts) for the Hawk project.
TIBCO® Service Performance Manager Installation and Configuration
52
Deployment Scenarios
Various deployment scenarios are supported by TIBCO Service Performance Manager.
The following diagram shows a recommended deployment of Service Performance Manager for TIBCO
ActiveMatrix environment. It is however, not a product requirement. You can deploy one or more
components on the same machine provided it has sufficient server resources.
You may not be able to achieve the required level of fault-tolerance if it is not deployed as per the
recommendations.
TIBCO Enterprise Message Service Server Deployment
TIBCO Service Performance Manager uses the Fault Tolerance feature of Enterprise Message Service.
Each of the primary and secondary Enterprise Message Service servers should be deployed on separate
server machines to account for the Enterprise Message Service server machine level failures. They
should share a common datastore. For more information on fault tolerance, refer to TIBCO Enterprise
Message Service User’s Guide.
TIBCO® Service Performance Manager Installation and Configuration
53
TIBCO Service Performance Manager Server Deployment
Each of the Service Performance Manager servers should also be deployed on separate server machines
to account for the Service Performance Manager machine level failures.
You may start multiple instances of the Service Performance Manager server process on the same
machine to account for the level failures of the Service Performance Manager server process on the
same machine.
To connect to a fault tolerance enabled Enterprise Message Service pair, each of the Service
Performance Manager server instances should use an Enterprise Message Service fault tolerance URL
similar to the following:
rta.jms.jndi.url=tibjmsnaming://server-machine-1:7222, tibjmsnaming://servermachine-2:7222
TIBCO Service Performance Manager server uses the EMS Exclusive Queue feature for fault-tolerance.
The server inbound queue over which the server receives messages should be configured as an
exclusive queue. This is already done in the Enterprise Message Service setup script that is bundled
with the product. Using an exclusive queue ensures that the Enterprise Message Service server always
delivers messages only to the first connection on that queue. Hence, only one Service Performance
Manager server is primary at any time. When this primary instance fails, Enterprise Message Service
automatically starts to deliver the messages to any one of the remaining connections in that queue.
TIBCO® Service Performance Manager Installation and Configuration
54
Improving the Performance
There are several factors that contribute towards the performance of TIBCO Service Performance
Manager.
The following are the recommendations for performance improvement.
Client Batching
TIBCO Service Performance Manager Client API supports a time and count based batch. Whenever a
time threshold or a count threshold is reached, the batch of facts is bundled as a single message and
sent to the EMS server. The optimization is because the database inserts a batch of facts in a single
transaction and all associated metric computations for this batch as a single database transaction per
hierarchy.
Server Batching
In addition to client batching, server side batching is also performed. Client batches are further batched
inside the server for processing, for enhanced performance.
Do not save facts, if possible
If you do not save facts, you get the best performance. If facts need to be saved, determine how many of
them can be stored, since it would impact performance.
Size the facts table and purge frequencies
If you choose to save the facts, it is very important to keep the size of the facts table in check such that
performance is not impacted.
Do not use processed facts table
Maintenance of yet another set of tables increases the load on the database to a great extent. Rely on
TIBCO Enterprise Message Service for failures and recovery processing.
Use a large L1 cache
We recommend using as much RAM as possible and a proportionately large L1 cache.
Use a machine with large number of cores
Each of the dimension hierarchies as defined in the schema, takes up one CPU core for processing.
Besides, a large number of threads would be required to efficiently serve streaming queries, snapshot
queries, and rule evaluations. We recommend a multicore server class machine for running the Service
Performance Manager server.
Use an optimized Oracle setup
Database must be optimized for enhanced performance.
TIBCO® Service Performance Manager Installation and Configuration
55
Data Retention Policies
By default, data (facts) in TIBCO Service Performance Manager is persisted to a database. Unless
deleted, the FACT table in the database grows with time. TIBCO Service Performance Manager enables
you to purge the older data from the system. Facts are deleted based on the created_time of the fact.
Retention Policy for FACTS
The older data can be purged periodically from the system using the following settings defined in the
schema XML file:
<schema name="AMX_3_0" display-name="ActiveMatrix Service Grid 3.x">
<retention-policies>
<retention-policy type="fact" period="1" unit="DAY" purge-time-of-day="-1" purgefrequency-period="3600000"/>
Where:
●
type:
Set the value of this attribute to "fact" to configure a retention policy for facts.
●
period:
A number, to be used along with the attribute "unit". These two attributes together define
how much data is to be retained.
For example, setting period=1 and unit="DAY": If you set period=1 and unit="DAY", all facts
older than one day are purged. If you set period=2 and unit="WEEK", all facts older than two
weeks are purged. Possible values for unit are "DAY", "WEEK", and "HOUR".
●
●
purge-time-of-day:
Specify the time of the day when the purge activity would be scheduled. It
takes the format HHMI where HH is the hour of the day and MI is the minute of the hour. For example,
setting it to 0100 would schedule the first purge activity for 01 AM. Use -1 if you want the purge
activity to be repeated every purge-frequency-period.
purge-frequency-period:
milliseconds.
Specify how often to run the purge activity. Specify the time period in
Retention Policy for Metrics and Hierarchies
Use a retention policy in the schema XML to configure the retention policy for dimension hierarchies.
For metric hierarchy tables, metrics are purged based on updated_time of the metric. The value of the
type attribute should be a fully-qualified name of a dimension hierarchy as defined in the schema. All
other attributes have the same meaning as defined in the previous section. For example, the first line in
the following example, prompts TIBCO Service Performance Manager to purge all metrics data that is
older than 2 weeks, for the hierarchy DevNodeCube/SrvTrends. It is configured to run at 01 AM and
with a frequency of 1 day (86400000 milliseconds).
<retention-policy type="DevNodeCube/SrvTrends" period="2" unit="WEEK" purge-time-ofday="0100" purge-frequency-period="86400000"/>
Similarly, you can configure the retention policy of all other hierarchies by modifying the schema file.
The defaults for TIBCO Service Performance Manager are as shown in the following table:
Level, Dimension, and Measurement based on Hierarchy
Purge
Frequency
Period
Retention Policy Time
Period
Unit
Purge Time of
Day
fact
1
DAY
-1
3600000
DevNodeCube/SrvTrends
2
WEEK
0100
86400000
TIBCO® Service Performance Manager Installation and Configuration
56
Purge
Frequency
Period
Retention Policy Time
Period
Unit
Purge Time of
Day
DevNodeCube/ApplTrends
2
WEEK
0110
86400000
DevNodeCube/NodeTrends
2
WEEK
0120
86400000
DevNodeCube/By Service
2
WEEK
0130
86400000
DevNodeCube/SvcInstTrends
2
WEEK
0140
86400000
DevNodeCube/GrpByClientIPRes
2
WEEK
0150
86400000
DevNodeCube/GrpBySrvClientIP
2
WEEK
0200
86400000
DevNodeCube/HttpResource
2
WEEK
0210
86400000
DevNodeCube/JdbcResource
2
WEEK
0220
86400000
InfCube/InferredStatus
2
WEEK
0230
86400000
Assets/env
2
WEEK
0240
86400000
Assets/app
2
WEEK
250
86400000
Assets/node
2
WEEK
300
86400000
Assets/node_hist
2
WEEK
0310
86400000
Assets/svcinst
2
WEEK
0320
86400000
Assets/svcinst_hist
2
WEEK
0330
86400000
Assets/http
2
WEEK
0340
86400000
Assets/http_hist
2
WEEK
0350
86400000
Assets/jdbc
2
WEEK
0400
86400000
Assets/jdbc_hist
2
WEEK
0410
86400000
Data can be deleted by the database administrator directly. If this is the preferred option, the
administrator can set the values in the schema file to very large values such that the purge times are
effectively disabled.
TIBCO® Service Performance Manager Installation and Configuration
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement