Agent for ActiveMatrix BusinessWorksâ„¢ User's Guide

Agent for ActiveMatrix BusinessWorksâ„¢ User's Guide
TIBCO® Service Performance Manager Agent
for ActiveMatrix BusinessWorks™ User's Guide
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 Agent for ActiveMatrix BusinessWorks™ User's Guide
3
Contents
Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
TIBCO® Service Performance Manager Agent for ActiveMatrix BusinessWorks™ . . . . . . . . . . . . . . . . . . . . . . . 6
TIBCO Service Performance Manager Agent for ActiveMatrix BusinessWorks 5.x . . . . . . . . . . . . . . . . . . . . . . . 7
Assets Monitored for ActiveMatrix BusinessWorks 5.x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Configuring the SPM Agent for ActiveMatrix BusinessWorks 5.x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Admin Agent for Rules and Alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
LiveView Desktop for ActiveMatrix BusinessWorks 5.x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Starting LiveView Server for ActiveMatrix BusinessWorks 5.x Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Monitor ActiveMatrix BusinessWorks 5.x Artifacts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Health Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Service Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Process View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Shared Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
The Main Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
TIBCO Service Performance Manager Agent for ActiveMatrix BusinessWorks 6.x . . . . . . . . . . . . . . . . . . . . . . 17
Assets Monitored for ActiveMatrix BusinessWorks 6.x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Configuring the SPM Agent for ActiveMatrix BusinessWorks 6.x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
The SPM Agent for ActiveMatrix BusinessWorks 6.x Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Admin Agent for Rules and Alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
LiveView Desktop for ActiveMatrix BusinessWorks 6.x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Starting LiveView Server for Monitoring ActiveMatrix BusinessWorks 6.x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
LiveView Dashboards for ActiveMatrix BusinessWorks 6.x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
TIBCO® Service Performance Manager Agent for ActiveMatrix BusinessWorks™ User's Guide
4
Figures
Health Summary Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Services Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Service Operations Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Process View Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
HTTP Requests Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
The Main Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Applications Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Process Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Activities Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Process Instances Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Main Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
TIBCO® Service Performance Manager Agent for ActiveMatrix BusinessWorks™ User's Guide
5
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 Agent for ActiveMatrix BusinessWorks™ User's Guide
6
TIBCO® Service Performance Manager Agent for
ActiveMatrix BusinessWorks™
Using Service Performance Manager (SPM), you can monitor and administer ActiveMatrix
BusinessWorks 5.x and 6.x assets.
Using Service Performance Manager, you can monitor the data generated through ActiveMatrix
BusinessWorks activities and events. However, the list of events and activities that can be monitored
for ActiveMatrix BusinessWorks version 5.x and 6.x differs.
TIBCO Service Performance Manager Agent for ActiveMatrix BusinessWorks (the SPM agent)
intercepts the ActiveMatrix BusinessWorks generated events and publishes them to the SPM server.
The real time is then aggregated based on the specified schema.
For more details about the SPM agent, see the following sections:
●
TIBCO Service Performance Manager Agent for ActiveMatrix BusinessWorks 5.x
●
TIBCO Service Performance Manager Agent for ActiveMatrix BusinessWorks 6.x
TIBCO® Service Performance Manager Agent for ActiveMatrix BusinessWorks™ User's Guide
7
TIBCO Service Performance Manager Agent for
ActiveMatrix BusinessWorks 5.x
The SPM agent for ActiveMatrix BusinessWorks 5.x is essential to monitor ActiveMatrix
BusinessWorks 5.x artifacts.
Running the SPM agent for ActiveMatrix BusinessWorks 5.x involves the following activities:
●
Install the SPM agent by selecting the ActiveMatrix BusinessWorks 5 Agent installation profile
during the SPM installation. See Installation.
●
Generate the database schema using the DDL generator, perform the required configuration, and
start the SPM server. See Configuring the SPM Agent for ActiveMatrix BusinessWorks 5.x.
The SPM agent then starts and keeps listening to the activities executed in ActiveMatrix
BusinessWorks 5.x.
●
You can configure rules and alerts for SLA management in the SPM Admin agent. See Admin Agent
for Rules and Alerts.
●
Additionally, you can also view the aggregated data using a visualization tool, such as TIBCO
StreamBase LiveView® Desktop. See LiveView Desktop for ActiveMatrix BusinessWorks 5.x.
Assets Monitored for ActiveMatrix BusinessWorks 5.x
You can monitor engines, processes, and webservices in ActiveMatrix BusinessWorks with the SPM
agent.
The following list explains the artifacts and their details as monitored by the SPM agent:
●
Engine: Monitors if the status of the BW engine(s) is active or inactive.
●
Processes: Monitors if the process is active or inactive as processes can be selectively enabled or
disabled from TIBCO Administrator.
●
Webservices: Monitors if the status of webservices (with SOAP event source as starter) is active or
inactive depending on the state of the process starter.
The following tables provide lists of metrics that can be monitored for these assets.
Engine Attributes
Attribute
Description
Domain
TRA Domain
Engine
Name of the BW Engine
Process Attributes
Attribute
Description
Project
The name of the ActiveMatrix BusinessWorks
project
Process
The name of the process in the project
Process Starter Type
The starter activity for the process
TIBCO® Service Performance Manager Agent for ActiveMatrix BusinessWorks™ User's Guide
8
Attribute
Description
Job ID
The job unique ID
General Activity Attributes
Attribute
Description
Job Status
The job status such as Continue, Dead, Running
and so on
Activity Start Time
The start time for any activity in the process
Activity Exec Time
Total execution time for a particular activity
Activity Name
The name of the activity that is being executed
currently
Activity Type
ActiveMatrix BusinessWorks activity type such
as Log, Write to file, and so on
Activity Path
Fully qualified name of the activity (Includes
process/sub-process/group)
Preceding Transition
The transition executed to reach this activity
Preceding Activity
The activity executed prior to the current activity
Activity Status
The current status (Success/Fault)
Activity Hit
Whether the activity is being called
Activity Success
If the activity was executed successfully
Activity Fault
If there was a fault in executing the activity
SOAP Event Source
Attribute
Description
Operation Name
The webservice operation that was invoked
Direction
Inbound/Outbound
Transport Binding Type
JMS or HTTP
Service Name
The name of the service
Service Type
The service or reference
TIBCO® Service Performance Manager Agent for ActiveMatrix BusinessWorks™ User's Guide
9
SOAP Request/Reply
Attribute
Description
Operation Name
The webservice operation that was invoked
Direction
Inbound/Outbound
Transport Binding Type
JMS or HTTP
Service Name
The name of the service
Service Type
The service or reference
HTTP Receiver
Attribute
Description
HTTP Method
The method such as GET, POST, or DELETE
HTTP Request URI
The requested URI
Protocol
HTTP/HTTPS
Client IP
Requestor I/P
Installation
To monitor ActiveMatrix BusinessWorks 5.x using TIBCO Service Performance Manager, you must
install custom profile ActiveMatrix BusinessWorks 5 Agent during SPM installation.
If the slf4j-api-1.5.2.jar, slf4j-log4j12-1.5.2.jar and tibcrypt.jar files are missing, copy them from the
machine where SPM is installed.
Refer to the 'Installing in GUI mode’ section in the TIBCO Service Performance Manager Installation Guide.
After the ActiveMatrix BusinessWorks 5 Agent profile is installed, the <SPM_HOME>/smbw-agent folder
is created.
Configuring the SPM Agent for ActiveMatrix BusinessWorks 5.x
Several configurations are needed to enable the monitoring of ActiveMatrix BusinessWorks 5.x assets.
Procedure
1. Create the SPM database schema for ActiveMatrix BusinessWorks 5.x as follows:
a) Copy the BW_5_11_Schema.xml file from the <SPM_HOME>\liveview\lv-dashboard folder to
<SMBW_HOME>/config.
b) Generate the database scripts using the DDL generator for the above schema and create tables in
database.
See the section 'Generating Service Performance Manager Database Schema' in TIBCO® Service
Performance Manager Installation and Configuration .
c) Start SPM Server.
d) Start the database.
e) Start SPM Dashboard.
TIBCO® Service Performance Manager Agent for ActiveMatrix BusinessWorks™ User's Guide
10
2. For each ActiveMatrix BusinessWorks application that you want to monitor, you must update the
corresponding TRA file and set the following properties.
a) Navigate to <TRA_HOME>/domain/<domain_name>/applications/<application> and set the
following properties:
●
tibco.env.EMS_HOME=<installation path for TIBCO Enterprise Message Service
6.0 or above>
●
tibco.env.SMBW_HOME=<SPM_HOME>/smbw-agent
Both the tibco.env.EMS_HOME and tibco.env.SMBW_HOME values should be
added to the beginning of the .tra file. If not BWS SPM Agent will not initialize
correctly.
●
tibco.env.CUSTOM_EXT_APPEND_CP=<EMS_HOME>/lib%PSP%SMBW_HOME/lib
●
java.property.aspectPath=<SMBW_HOME>/lib
●
tibco.env.STD_EXT_CP=<SMBW_HOME>/lib;<SMBW_HOME>/lib/bwaa;<SMBW_HOME>/lib/
ext;<SMBW_HOME>/lib/spm;<EMS_HOME>/lib
For STD_EXT_CP and CUSTOM_EXT_PREPEND_CP add the required values to
the existing properties in the BW Application Tra file.
●
ServiceAgent.builtinResource.serviceagent.Class=com.tibco.plugin.brp.BRPServiceA
gent
●
ServiceAgent.probe.serviceagent.Class=com.tibco.rta.probe.bw.core.SPMServiceAgent
●
ServiceAgent.poa.serviceagent.Class=com.tibco.bw5.poa.core.runtime.DefaultBw5Asp
ectServiceAgentImpl
●
spm.probe.config.dir=<SMBW_HOME>/config
b) Restart the ActiveMatrix BusinessWorks application from TIBCO Administrator.
3. Navigate to the <SPM_HOME>/smbw-agent/config directory and update the admin config file - bwadmin-probe.properties as follows:
: Change to the appropriate TIBCO Hawk® domain where the BW
engines to be monitored through TIBCO Administrator reside.
●
spm.bw.probe.hawk.domain
●
spm.bw.probe.hawk.rv.service:
●
spm.bw.probe.hawk.rv.network
●
spm.bw.probe.hawk.rv.daemon
●
rta.client.jms.jndi.url
RV service (Refer RV parameters)
: RV network (Refer RV parameters).
: RV daemon (Refer RV parameters).
: Client JNDI URL for EMS, to which the SPM server is connected.
4. Navigate to <SMBW_HOME>/bin and enable the SPM agent.
a) Open the start-admin-probe.bat or start-admin-probe.sh file and set the following
properties:
●
tibco.env.RV_HOME=<installation
path for TIBCO Rendezvous 8.x or above>
●
tibco.env.HAWK_HOME=<installation
path for TIBCO Hawk 4.9 or above>
●
tibco.env.EMS_HOME=<installation path for TIBCO Enterprise Message Service 6.0 or above>
b) Start start-admin-probe.bat (for Windows) or start-admin-probe.sh (for UNIX).
Result
The SPM agent for ActiveMatrix BusinessWorks 5.x is now started. The agent now publishes events
generated by the activities executed in ActiveMatrix BusinessWorks 5.x to the SPM server.
TIBCO® Service Performance Manager Agent for ActiveMatrix BusinessWorks™ User's Guide
11
Admin Agent for Rules and Alerts
You can create rules and alerts based on the aggregated data for SLA management using the Admin
agent.
The Operator view of the SPM Admin agent shows up all the hierarchies in the ActiveMatrix
BusinessWorks 5.x schema hosted by the SPM server. You can create rules for ActiveMatrix
BusinessWorks 5.x hierarchies, and also receive alerts on the Alerts card in the Operator view. For more
details about creating rules and alerts, see TIBCO Service Performance Manager Admin Agent Guide.
LiveView Desktop for ActiveMatrix BusinessWorks 5.x
You can use any visualization tool to view SPM dashboards for ActiveMatrix BusinessWorks 5.x. For
example, TIBCO StreamBase LiveView® Desktop.
Starting LiveView Server for ActiveMatrix BusinessWorks 5.x Monitoring
Configure the ActiveMatrix BusinessWorks LiveView project and then start the LiveView server to
visualize realtime computed data on the SPM server.
Prerequisites
Ensure that all the configuration for the SPM agent for ActiveMatrix BusinessWorks 5.x is done and the
SPM server is started with the ActiveMatrix BusinessWorks 5 schema. See Configuring the SPM Agent
for ActiveMatrix BusinessWorks 5.x for more details.
Procedure
1. Make sure that TIBCO StreamBase LiveView® is installed.
a) Navigate to <SMBW_HOME>/liveview/lv-dashboard and replace the variables in sbd.sbconf
with actual values:
●
%TIBCO_JAVA_HOME_ESC%:
Replace it with TIBCO JRE path, which is included with the
Service Performance Manager installation.
●
%TIBCO_SPM_HOME_ESC%:
Replace it with <SPM_HOME> path.
%TIBCO_EMS_HOME_ESC%: Replace it with <EMS_HOME> path.
b) Replace the ${STREAMBASE_HOME} variable to point to the JAR files:
●
●
<jar file="C:\Program Files (x86)\StreamBase Systems\StreamBase.7.3/lib/adapter/sb-lvadapter.jar"/>
<jar file="C:\Program Files (x86)\StreamBase Systems\StreamBase.7.3/lib/ext/sb-adaptercommon.jar"/>
For information on using TIBCO StreamBase LiveView with Service Performance Manager, refer to
TIBCO Service Performance Manager User's Guide.
●
2. Run the LiveView server, LiveView Desktop, and connect to the LiveView server.
a) Run the LiveView server from the command propmt as follows:
<SMBW_HOME>/liveview > run-lvserver lv-dashboard
b) Start LiveView Desktop.
The Connect to LiveView dialog is displayed.
c) In the Connect to LiveView dialog, connect to the LiveView server using the same host and port
as specified in the sbd.sbconf file.
The LiveView Desktop shows all the ActiveMatrix BusinessWorks artifacts configured to be
monitored.
TIBCO® Service Performance Manager Agent for ActiveMatrix BusinessWorks™ User's Guide
12
Monitor ActiveMatrix BusinessWorks 5.x Artifacts
The LiveView Desktop shows various dashboards for the ActiveMatrix BusinessWorks 5.x
environment.
You can configure the dashboards to display the data as per your requirement.
Health Summary
By default, the Health Summary dashboard shows the status of the web services, process starters, and
engines.
The WebServiceStatus pane shows the status (active/inactive) of the services in a heat map. For the
exact status of a service, you can select the domain, host, project, engine, process starter, and service
name in the pickers above the heatmap. The ProcessStarterStatus pane shows the status (active/
inactive) of the process starters in a heat map. For the exact status of a process starter, you can select the
domain, host, engine, project, and process in the pickers above the heatmap. The EngineStatus pane
shows the status (active/inactive) of the engines in a heat map. You can see the exact status of the
engines by selecting the domain, host, and project from the pickers above the heatmap.
Health Summary Dashboard
Services
The Services dashboard shows details of the total number of hits for a service, their trend, successful
responses from the service, faults encountered by the service, and so on.
The Services dashboard shows the following graphs and tables:
●
ServiceHitsTrend: shows the trend of the total number of hits for the service
●
ServiceSuccessTimeSeries: shows the time series chart of the number of successful responses for the
service
●
ServiceResponseTimeTrends: shows the trend of the average response time of the service
●
ServiceFaultsTimeSeries: shows the time series chart of the number of faults encountered by the
service
●
Services-WeeklyView: shows the weekly view of the service
●
GrpBy_ServiceInst: shows the services grouped by service instances
TIBCO® Service Performance Manager Agent for ActiveMatrix BusinessWorks™ User's Guide
13
Services Dashboard
Service Operations
The Service Operations dashboard shows details of the total number of hits for a service operation,
their trend, successful responses from the service operation, faults encountered by the service
operation, and so on.
The Service Operations dashboard shows the following graphs and tables:
●
ServiceOperations-WeeklyView: shows the weekly view of the service operations
●
ServiceOp-AvgResponseTrends: shows the trend of the average response time of the service
operation
●
ServiceOp-HitsTrend: shows the trend of the total number of hits for the service operation
●
ServiceOp-SuccessTrends: shows the trends of the number of successful responses for the service
operation
●
ServiceOp-FaultsTrends: shows the trends of the number of faults encountered by the service
operation
TIBCO® Service Performance Manager Agent for ActiveMatrix BusinessWorks™ User's Guide
14
Service Operations Dashboard
Process View
The Process View dashboard shows details of the process instances, activities, and process starter
status.
The Process View dashboard shows the following graphs and tables:
●
ProcessInstances: shows the number of process instances per process. You can filter them by
selecting the domain, host, engine, project, and process from the pickers above the graph.
●
Activities-WeeklyView: shows the number of each activity per week. You can filter them by
selecting the project, process, and activity name from the pickers above the graph.
●
ProcessStarterStatus: shows the status of each process starter, along with other details such as the
domain, host, engine, project, process, status, and so on.
Process View Dashboard
TIBCO® Service Performance Manager Agent for ActiveMatrix BusinessWorks™ User's Guide
15
Shared Resources
The shared resources dashboard shows details of the HTTP or JDBC requests, such as the trend of the
total requests, active sessions, errors, and request bytes.
The shared resource dashboard shows the following graphs:
●
HTTP/JDBC Requests: shows the trend of the total HTTP/JDBC requests. You can filter them by
selecting the domain, host, engine, project, and shared resource name from the pickers above the
graph.
●
HTTP/JDBC ActiveSessions: shows the trend of the HTTP/JDBC bytes sent in a session. You can
filter them by selecting the domain, host, engine, project, and shared resource name from the
pickers above the graph.
●
HTTP/JDBC Errors: shows the trend of HTTP/JDBC errors. You can filter them by selecting the
domain, host, engine, project, and shared resource name from the pickers above the graph.
●
HTTP/JDBC BytesReceived: shows the total number of HTTP/JDBC bytes received. You can filter
them by selecting the domain, host, engine, project, and shared resource name from the pickers
above the graph.
HTTP Requests Dashboard
The Main Dashboard
The main dashboard displays details of the selected LiveView tables.
The TIBCO Service Performance Manager hierarchy tables contain aggregated data across dimensions.
The aggregated data are measurements calculated across time dimensions. Selecting a LiveView table
from the left pane displays the details of that table in the right pane.
For detailed information on querying, refer to the StreamBase and LiveView documentation.
TIBCO® Service Performance Manager Agent for ActiveMatrix BusinessWorks™ User's Guide
16
The Main Dashboard
TIBCO® Service Performance Manager Agent for ActiveMatrix BusinessWorks™ User's Guide
17
TIBCO Service Performance Manager Agent for
ActiveMatrix BusinessWorks 6.x
TIBCO Service Performance Manager Agent for ActiveMatrix BusinessWorks 6.x is implemented as an
event subscriber for ActiveMatrix BusinessWorks 6.x. This agent is a part of the governance library for
ActiveMatrix BusinessWorks 6.x.
The SPM agent for ActiveMatrix BusinessWorks 6.x needs TIBCO ActiveMatrix BusinessWorks 6.2
along with the latest hotfix to be installed. The SPM agent is installed as a plugin, as part of the
installation of TIBCO ActiveMatrix BusinessWorks 6.2 latest hotfix.
Running the SPM agent for ActiveMatrix BusinessWorks 6.x involves the following activities:
●
Enable the SPM agent from ActiveMatrix BusinessWorks 6.x and restart the AppSpace. See
Configuring the SPM Agent for ActiveMatrix BusinessWorks 6.x.
●
Generate the database schema using the DDL generator and start the SPM server. See Configuring
the SPM Agent for ActiveMatrix BusinessWorks 6.x.
The SPM agent then starts and keeps listening to the activities executed for ActiveMatrix
BusinessWorks 6.x.
●
You can configure rules and alerts for SLA management in the SPM Admin agent. See Admin Agent
for Rules and Alerts.
●
Additionally, you can also view the aggregated data using a visualization tool, such as TIBCO
StreamBase LiveView® Desktop. See LiveView Desktop for ActiveMatrix BusinessWorks 6.x.
Assets Monitored for ActiveMatrix BusinessWorks 6.x
The SPM agent performs the infrastructure monitoring of ActiveMatrix BusinessWorks 6.x artifacts.
Assets Monitored
The following assets in ActiveMatrix BusinessWorks 6.x are monitored by Service Performance
Manager:
●
Domain
●
Application
●
AppSpace
●
AppNode
●
Component
●
Process (including sub processes)
●
Activity
For more conceptual information on each asset, refer TIBCO ActiveMatrix BusinessWorks Concepts Guide.
Key Performance Indicators (KPI)
SPM uses the following measurement criteria for computing and displaying the details for the assets of
ActiveMatrix BusinessWorks 6.x:
●
Total hits
●
Total successes
●
Total faults
TIBCO® Service Performance Manager Agent for ActiveMatrix BusinessWorks™ User's Guide
18
●
AverageExecutionTime
Dimension Hierarchies
Service Performance Manager aggregates the KPIs recorded for each ActiveMatrix BusinessWorks asset
and groups them at the following level:
●
GroupBy Applications
Total Hits, total successes, total faults, and average execution time are aggregated at the application
level across weeks, days, hours, and minutes.
●
GroupBy Processes
Total Hits, total successes, total faults, and average execution time are aggregated at the process
level across weeks, days, hours, and minutes
●
GroupBy Activities
Total Hits, total successes, total faults, and average execution time are aggregated at the activities
level across weeks, days, hours, and minutes
●
ProcessFlow (ProcessInstances)
Execution time and execution path for each activity in the process execution instance (for each job)
Configuring the SPM Agent for ActiveMatrix BusinessWorks 6.x
To monitor the ActiveMatrix BusinessWorks 6.x assets, enable the SPM agent for ActiveMatrix
BusinessWorks 6.x and start the SPM server using the ActiveMatrix BusinessWorks 6.x schema.
TIBCO Service Performance Manager Agent for ActiveMatrix BusinessWorks 6.x needs TIBCO
ActiveMatrix BusinessWorks 6.2 along with the latest hotfix to be installed. The Agent is installed as a
plugin, as part of the installation of TIBCO ActiveMatrix BusinessWorks 6.2 latest hotfix.
Procedure
1. Create the SPM schema for ActiveMatrix BusinessWorks 6.x as follows:
a) Copy the BW_6_Schema.xml file from the <SPM_HOME>/adapters/liveview/lv-examples/
BW_6.2 folder to <SPM_HOME>/config.
b) Generate the database scripts using the DDL generator for the above schema and create tables in
database.
See the section 'Generating Service Performance Manager Database Schema' in TIBCO® Service
Performance Manager Installation and Configuration .
c) Start the Service Performance Manager Server.
d) Start the database.
e) Start Service Performance Manager Dashboard.
2. Enable the SPM agent for AMX BW 6 at the AppSpace or AppNode level from the TIBCO_HOME of
the ActiveMatrix BusinessWorks 6.x:
a) Copy the existing AppSpace config.ini file (located in the root of the AppSpace folder), or the
AppSpace config.ini template file appspace_config.ini_template (located in
TIBCO_HOME/bw/6.x/config/) to a temporary location (for example, C:\temp\config.ini).
This is a common configuration properties file for the governance library available in the
ActiveMatrix BusinessWorks 6.x AppSpace.
b) Edit the bw.governance.spm.enabled property to true in the file to enable the SPM agent for
ActiveMatrix BusinessWorks 6.x.
Default value is false. The property can be set at the AppSpace as well as AppNode level.
bw.governance.spm.enabled=true
TIBCO® Service Performance Manager Agent for ActiveMatrix BusinessWorks™ User's Guide
19
c) Configure other Service Performance Manager related properties in the config.ini file (if
required). Each property has a default value and needs configuration, only if the fine tuning is
required.
See The SPM Agent for ActiveMatrix BusinessWorks 6.x Configuration Properties for more
details on the properties.
d) Use one of the following config admin command to push the configuration to the AppSpace or
the AppNode:
●
AppSpace:
bwadmin[admin] > config -d myDomain -a myAppSpace -cf
<temporaryLocation>/config.ini
●
AppNode:
bwadmin[admin] > config -d myDomain -a myAppNode -cf
<temporaryLocation>/config.ini
Restart the AppSpace or AppNode after applying the configuration to the AppSpace or AppNode
respectively.
Result
The SPM agent for ActiveMatrix BusinessWorks 6.x is now started. The agent now publishes events
generated by the activities executed in ActiveMatrix BusinessWorks 6.x to the SPM server.
The SPM Agent for ActiveMatrix BusinessWorks 6.x Configuration
Properties
The SPM agent related properties can be configured in the config.ini configuration file of AppSpace or
AppNode of ActiveMatrix BusinessWorks 6.x.
Properties
Description
bw.governance.jms.server.url
ActiveMatrix BusinessWorks Governance Agent
JMS URL. This property is optional and it is
used to specify the JMS server URL used to
communicate with the TIBCO ActiveMatrix®
Policy Director Administrator. If this property is
not set, then the ActiveMatrix BusinessWorks
Governance agent does not attempt to connect to
the JMS server. The URL is expected to start with
'tcp://' or 'ssl://' and the failover URLs can be
specified as a ',' or '+' separated list.
bw.governance.jms.server.username
TIBCO ActiveMatrix BusinessWorks
Governance Agent JMS User Name. This
property is required if the Governance Agent
JMS URL is specified.
bw.governance.jms.server.password
TIBCO ActiveMatrix BusinessWorks
Governance Agent JMS User Password. This
property is required if the Governance Agent
JMS URL is specified.
TIBCO® Service Performance Manager Agent for ActiveMatrix BusinessWorks™ User's Guide
20
Properties
Description
bw.governance.spm.enabled
Enable or disable the SPM agent. This property
is optional and it specifies whether the SPM
agent should be enabled or disabled in the
AppNode. The supported values are: true or
false. The default value is “false”.
bw.governance.spm.fact.batch.size
The SPM agent batch count. This property is
optional and it specifies the number of facts to
batch before publishing to the SPM server. The
default value is "1" and the supported value for
this property is an integer, which must be
greater than zero.
bw.governance.spm.jms.jndi.contextfactory
TIBCO ActiveMatrix BusinessWorks SPM Event
Subscriber JMS JNDI Initial Context Factory.
This property is optional and it provides the
ability to specify the JMS Transport JNDI context
factory. The default value is
"com.tibco.tibjms.naming.TibjmsInitialContextFa
ctory".
bw.governance.spm.jms.queueconnectionfactory
TIBCO ActiveMatrix BusinessWorks SPM Event
Subscriber JMS Queue Connection Factory. This
property is optional and it provides the ability to
specify the JMS queue connection factory. The
default value is "SPMQueueConnectionFactory".
bw.governance.spm.jms.inbound.queue
TIBCO ActiveMatrix BusinessWorks SPM Event
Subscriber JMS QName for sync/async
operations. This property is optional and it
provides the ability to specify the Queue name
on JMS to perform sync/async operations. The
default value is "spm.inbound.queue".
bw.governance.spm.jms.outbound.queue
TIBCO ActiveMatrix BusinessWorks SPM Event
Subscriber JMS QName for Outbound Client.
This property is optional and it provides the
ability to specify the JMS outbound queue name
for the client to receive notifications from SPM
server. The default value is
"spm.outbound.queue".
bw.governance.spm.taskmgr.threadpool.size
TIBCO ActiveMatrix BusinessWorks SPM Event
Subscriber Threads for Fact Publishing. This
property is optional and it provides the ability to
specify the number of threads to be used for fact
publishing per session. The default value is "5".
TIBCO® Service Performance Manager Agent for ActiveMatrix BusinessWorks™ User's Guide
21
Properties
Description
bw.governance.spm.taskmgr.threadpool.keepali
ve.time
TIBCO ActiveMatrix BusinessWorks SPM Event
Subscriber Timeout for Task Manager Threads.
This property is optional and it provides the
ability to specify the time(in seconds) to keep
alive the task manager threads. When this time
elapses, idle threads will be timed out. The
default value is "60" seconds.
bw.governance.spm.fact.queue.depth
TIBCO ActiveMatrix BusinessWorks SPM Event
Subscriber Queue Depth for Internal Queue.
This property is optional and it provides the
ability to specify the queue depth for the internal
queue for batching facts. The default value is
"100".
bw.governance.spm.fact.eviction.enabled
TIBCO ActiveMatrix BusinessWorks SPM Event
Subscriber Enable or disable Async Eviction
Facts. This property is optional and it provides
the ability to enable or disable async eviction of
facts once depth is full. Disabling it may result in
more facts being lost if fact batch size is on the
higher side and put rate is much more than the
consumption rate. The default value is "true".
bw.governance.spm.fact.eviction.frequency
TIBCO ActiveMatrix BusinessWorks SPM Event
Subscriber Enable or disable Async Eviction
Frequency. This property is optional and only
applicable if the property
"bw.governance.spm.fact.eviction.enabled"
value is "true". The default value is "100".
bw.governance.spm.fact.batch.expiry
TIBCO ActiveMatrix BusinessWorks SPM Event
Subscriber Time to Flush Residual Facts. This
property is optional and it provides the ability to
specify the amount of time in seconds to wait to
flush residual facts if batch size condition is not
met. The default value is "5".
bw.governance.spm.ping.interval
TIBCO ActiveMatrix BusinessWorks SPM Event
Subscriber Time Interval for Server Ping. This
property is optional and it provides the ability to
specify time interval in milliseconds used for
ping with the server. The default value is "1000".
bw.governance.spm.retry.count
TIBCO ActiveMatrix BusinessWorks SPM Event
Subscriber Maximum Retries for an operation.
This property is optional and it provides the
ability to specify maximum retries for an
operation in case it fails. The default value is "3".
TIBCO® Service Performance Manager Agent for ActiveMatrix BusinessWorks™ User's Guide
22
Properties
Description
bw.governance.spm.retry.wait
TIBCO ActiveMatrix BusinessWorks SPM Event
Subscriber Time to Wait Before Retry. This
property is optional and it provides the ability to
specify time in milliseconds to wait before
retrying operation. The default value is "10000"
milliseconds.
bw.governance.spm.sync.response.timeout
TIBCO ActiveMatrix BusinessWorks SPM Event
Subscriber Client Wait Time for Server. This
property is optional and it provides the ability to
specify time in milliseconds by client to wait for
server to send response for a sync operation like
query registration. The default value is "10000"
milliseconds.
bw.governance.spm.sync.jms.msg.expiry
TIBCO ActiveMatrix BusinessWorks SPM Event
Subscriber JMS Provider Message Keep Time.
This property is optional and it provides the
ability to specify time in milliseconds for JMS
provider to keep message before it expires. The
default value is "300000" milliseconds.
Admin Agent for Rules and Alerts
You can specify rules and alerts based on the aggregated data for SLA management, however you can
do that using the Admin Agent.
The Operator view in SPM Admin Agent shows up all the hierarchies in the ActiveMatrix
BusinessWorks 6 schema hosted by the SPM server. You can create rules for ActiveMatrix
BusinessWorks 6 hierarchies and also receive alerts on the Operator view Alerts dashboard. For more
details about setting rules and alerts, see TIBCO Service Performance Manager Admin Agent Guide.
LiveView Desktop for ActiveMatrix BusinessWorks 6.x
You can also use any visualization tool to view SPM dashboards for ActiveMatrix BusinessWorks 6.x.
For example, TIBCO StreamBase LiveView® Desktop.
Starting LiveView Server for Monitoring ActiveMatrix BusinessWorks 6.x
Configure the ActiveMatrix BusinessWorks LiveView project and then start the LiveView server to
visualize data recorded using the SPM agent for ActiveMatrix BusinessWorks 6.x.
Prerequisites
Ensure that the SPM agent for ActiveMatric BusinessWorks is enabled and the SPM server is started
with ActiveMatrix BusinessWorks 6 schema. See Configuring the SPM Agent for ActiveMatrix
BusinessWorks 6.x for more details.
Procedure
1. Ensure that the correct installation paths are defined in the configuration file of the LiveView
project for ActiveMatrix BusinessWorks 6.x. Edit and modify the sbd.sbconf configuration file at
SPM_HOME/adapters/liveview/lv-examples/BW_6/ and configure the following filepaths.
TIBCO® Service Performance Manager Agent for ActiveMatrix BusinessWorks™ User's Guide
23
a) If TIBCO Enterprise Message Service is installed after installing TIBCO Service Performance
Manager, then replace the %TIBCO_EMS_HOME_ESC% variable with correct installation path
for Enterprise Message Service 6.0 or above.
<jar file="%TIBCO_EMS_HOME_ESC%/lib/tibjms.jar"/>
In case of Enterprise Message Service 8.x or above, add the filepath of jms-2.0.jar
archive file.
<jar file="<EMS_HOME>/lib/jms-2.0.jar"/>
b) Replace the %TIBCO_SPM_HOME_ESC% variable with the correct installation path of Service
Performance Manager.
c) Replace the %TIBCO_JAVA_HOME_ESC% variable with the correct installation path of TIBCO
JRE, which is included with the Service Performance Manager installation.
2. Edit and modify the run-lvserver.bat file at SPM_HOME/smbw-agent/liveview and set the
correct installation path for TIBCO StreamBase LiveView in the STREAMBASE_HOME property.
3. Run the LiveView server, LiveView Desktop, and connect to the LiveView server.
a) Run the LiveView server from the command prompt as follows:
<SMBW_HOME>/liveview > run-lvserver <BW6_liveview_project_path>
b) Start LiveView Desktop.
The Connect to LiveView dialog is displayed.
c) In the Connect to LiveView dialog, connect to the LiveView server using the same host and port
as specified in the sbd.sbconf file.
The LiveView Desktop shows all the ActiveMatrix BusinessWorks artifacts configured to be
monitored.
LiveView Dashboards for ActiveMatrix BusinessWorks 6.x
LiveView Desktop shows various dashboards for the ActiveMatrix BusinessWorks 6.x environment.
These dashboards use the aggregated data processed by the SPM agent for ActiveMatrix
BusinessWorks 6.x.
See Assets Monitored for ActiveMatrix BusinessWorks 6.x for more details on the assets monitored,
measurement criteria used, and grouping hierarchies for the data.
The following sections show the default dashboards in the LiveView Desktop for ActiveMatrix
BusinessWorks 6.x. You can configure the dashboards to display the data as per your requirement.
Applications
By default, the Applications dashboard shows trend for average execution time, hit count, and total hits
for each application. For the exact status of a application, you can select the domain, appspace, and
application in the pickers above the charts.
TIBCO® Service Performance Manager Agent for ActiveMatrix BusinessWorks™ User's Guide
24
Applications Dashboard
Processes
By default, the Processes dashboard shows trend for average execution time, hit count, and total hits (as
a heatmap) for each process. For the exact status of a process, you can select the domain, appspace,
application, and process in the pickers above the charts and heatmaps.
Process Dashboard
Activities
By default, the Activities dashboard shows average execution time for each activity. For the exact status
of a activity, you can select the domain, appspace, application, process, and activity_name in the
pickers above the chart.
TIBCO® Service Performance Manager Agent for ActiveMatrix BusinessWorks™ User's Guide
25
Activities Dashboard
ProcessInstances
By default, the ProcessInstances dashboard lists all the process instances and activities associated with
each process instances. For the exact status of a process instance, you can select the domain, appspace,
application, process, process_id, and activity_name in the pickers above the charts.
Process Instances Dashboard
Main Dashboard
The main dashboard displays details of the selected LiveView tables.
The TIBCO Service Performance Manager hierarchy tables contain aggregated data across dimensions.
The aggregated data are measurements calculated across time dimensions. Selecting a LiveView table
from the left pane displays the details of that table in the bottom pane.
For detailed information on querying, refer to the TIBCO StreamBase LiveView documentation.
TIBCO® Service Performance Manager Agent for ActiveMatrix BusinessWorks™ User's Guide
26
Main Dashboard
TIBCO® Service Performance Manager Agent for ActiveMatrix BusinessWorks™ User's Guide
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