installation and configuration addendum - tibco …...tibco activematrix installation and...

Two-Second Adv

TIBCO ActiveMatrix®

Installation and Configuration AddendumSoftware Release 3.3.0 HotfixMay 2014

antage®

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, Two-Second Advantage, The Power of Now, TIBCO ActiveMatrix, and TIBCO Enterprise Message Service 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 © 2005 - 2014 TIBCO Software Inc. ALL RIGHTS RESERVED.TIBCO Software Inc. Confidential Information

| iii

Contents

Supplement: ActiveMatrix Installation and Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1

Service Probe Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Installation Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Disabling Monitoring Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Enabling the Service Probe on ActiveMatrix Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Disabling the Service Probe on ActiveMatrix Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Client Properties of the ActiveMatrix Service Performance Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Known Issues. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

TIBCO ActiveMatrix Installation and Configuration Addendum

iv | Contents


| 1

Supplement: ActiveMatrix Installation and Configuration

The supplementary document explains how to configure the TIBCO ActiveMatrix® Service Performance Manager service probe for use with the following products:

• TIBCO ActiveMatrix Service Bus

• TIBCO ActiveMatrix Service Grid

• TIBCO ActiveMatrix BPM

• TIBCO ActiveMatrix Service Performance Manager

TIBCO ActiveMatrix Service Performance Manager service probe is referred to as the service probe throughout the rest of this document.


2 | Supplement: ActiveMatrix Installation and Configuration

Service Probe Overview

TIBCO ActiveMatrix offers a service probe that publishes service statistics and life-cycle events to TIBCO ActiveMatrix Service Performance Manager.

The ActiveMatrix Administrator node publishes information about life-cycle events of ActiveMatrix assets such as nodes, applications, services, and certain shared resource instance types to ActiveMatrix Service Performance Manager. Additionally, it also publishes the availability details of the ActiveMatrix assets on an hourly basis.

All TIBCO ActiveMatrix runtime nodes, where the service probe has been enabled, publish statistical information to the ActiveMatrix Service Performance Manager over a TIBCO Enterprise Messaging Server queue. The following information is published:

• Service and Reference statistics

• Node JVM statistics

• Resource instance statistics for HTTP Connectors and JDBC


Service Probe Overview | 3

Figure 1 Service Probe Architecture

After the service probe is enabled on any ActiveMatrix node, statistics are emitted periodically to the SPM server asynchronously via EMS. Additionally, the ActiveMatrix Administrator node also emits asset status.

The SPM server receives the statistics from all the ActiveMatrix nodes that have the service probe enabled. The SPM server then applies some statistical computations on the received data in real-time, stores it, and renders it via the TIBCO ActiveMatrix Dashboard, a presentation UI that is separate from ActiveMatrix Administrator.



Installation Prerequisites

Before enabling the TIBCO ActiveMatrix installation with the service probe, you will need an installation having the following products:

• One of the base products from:

— TIBCO ActiveMatrix Service Grid 3.3.0

— TIBCO ActiveMatrix Service Bus 3.3.0

— TIBCO ActiveMatrix BPM 2.2.0

— TIBCO ActiveMatrix BPM 3.0.0

• TIBCO ActiveMatrix Platform 3.3.0-Hotfix-004

• TIBCO ActiveMatrix Service Performance Manager 2.2.0

Refer to the Installation and Configuration guides of the above products to decide on the machine topology and recommendations on configuring these products.

This document describes how to enable the service probe for your ActiveMatrix installation.

Existing TIBCO ActiveMatrix 3.3.0 customers who have been using TIBCO ActiveMatrix with TIBCO Service Performance Manager 2.1.0 are affected by Hotfix 004. After Hotfix 004 is applied to your TIBCO ActiveMatrix 3.3.0 installation, it is required that you upgrade to TIBCO Service Performance Manager 2.2.0.


Disabling Monitoring Services | 5

Disabling Monitoring Services

To enable a service probe on an ActiveMatrix node, ensure that the monitoring services are disabled.There are two scenarios for disabling the monitoring services.

• Monitoring service not deployed.

Use the TCT Administrator Server wizard to clear the Deploy Monitoring Service option. This ensures that the MCR Aggregator application is not deployed on system nodes. Refer to the TCT Configuration Summary Screen, page 5.

• Monitoring service already deployed.

a. On the ActiveMatrix Administrator node, stop the amx.governance.mcr.aggregator application. As a result, the monitoring service stops processing messages coming from other nodes. Refer to ActiveMatrix Administrator: Stopping the MCR Aggregated Application, page 6.

b. Restart the node(s).

Figure 2 TCT Configuration Summary Screen

Note that the Deploy Monitoring Service and Deploy Log Service check boxes are not selected by default.



Figure 3 ActiveMatrix Administrator: Stopping the MCR Aggregated Application


Enabling the Service Probe on ActiveMatrix Nodes | 7

Enabling the Service Probe on ActiveMatrix Nodes

You can enable the ActiveMatrix service probe from ActiveMatrix Administrator UI or CLI.

Enabling the service probe on the SystemNode (that serves the TIBCO ActiveMatrix Administration application) is mandatory when TIBCO Service Performance Manager is being used. Additionally, the service probe should be enabled on the runtime nodes that need to be monitored.

While enabling the service probe on the runtime nodes is optional, it is recommended that the service probe be enabled on all nodes in an environment that needs to be monitored.

Enabling the service probe using the ActiveMatrix Administrator UI Enable the service probes on ActiveMatrix nodes.

1. Login to TIBCO ActiveMatrix Administrator.

2. Click Infrastructure>Nodes. The Node details are displayed.

3. Select a node and from the bottom pane, click Configuration.

4. Click JVM Configuration.

5. Add the property:

— Property: spm.probe

— Value: on

6. Click Save and then Install or Sync to synchronize node configuration.

7. Restart the Node using the ActiveMatrix Administrator to reflect the changes.

If ActiveMatrix administrator is replicated (or running in a replicated setup), enable the ActiveMatrix Service Performance Manager probe on all replicated Administrator instances.

Use the same steps to configure other ActiveMatrix Service Performance Manager Client properties.

When you start a new administration setup using ActiveMatrix Service Performance Manager, ensure that the ActiveMatrix Service Performance Manager, server database is cleaned up. The ActiveMatrix Service Performance Manager displays data on the dashboard by querying the database. If old data is retained in the database, then it gets displayed on the dashboard.



Enabling the service probe using the ActiveMatrix Administrator CLITIBCO ActiveMatrix Administrator Command-Line Interface (CLI) can help configure or update node JVM properties. You can use Administrator CLI scripts to enable Service Probe and to set SPM Client properties on ActiveMatrix nodes.

Samples scripts can be found in <CONFIG_HOME>\admin\<enterprise name>\samples\spm.

For more information on Administrator Command-Line interface, refer to the section Command-Line Interface in the chapter Administrator Interfaces of the TIBCO ActiveMatrix Service Grid 3.3.0 Administration guide.

1. On nodes you want to enable the probe, open <CONFIG_HOME>\admin\<enterprise

name>\samples\spm\spm_probe.properties and set the following:

set spm_probe=on

2. Go to <CONFIG_HOME>\admin\<enterprise name>\samples\spm\spm_probe_data.xml. Update the Environment, Node, and Host names.

3. Ensure that the correct information is specified in the spm_probe.properties file.

4. Ensure that the node is running before you execute the these steps:

a. Run ant -f spm_probe_build.xml.b. Restart the affected nodes.

If ActiveMatrix administrator is replicated (or running in a replicated setup), enable the ActiveMatrix Service Performance Manager probe on all replicated Administrator instances.

Ensure that the values of the following properties match the values specified on ActiveMatrix Service Performance Manger:

• spm_client_jms_jndi_url

• spm_client_connection_username

• spm_client_connection_password

• spm_client_jms_jndi_contextfactory

• spm_client_schema_name


Enabling the Service Probe on ActiveMatrix Nodes | 9

• To enable a service probe on a node, you must disable monitoring services. For more information, refer to Known Issues, page 16.

• To receive timely updates from the ActiveMatrix Service Performance Manager server, ensure that the service probe is enabled.



Disabling the Service Probe on ActiveMatrix Nodes

You can disable the ActiveMatrix service probe from ActiveMatrix Administrator GUI or CLI.

You must start by disabling the service probe on all the ActiveMatrix Administrator nodes (including the replicated nodes) followed by the ActiveMatrix runtime nodes.

Disabling the service probe using the ActiveMatrix Administrator UI1. Login to TIBCO ActiveMatrix Administrator.

2. Click Infrastructure>Nodes. The Node details are displayed.

3. Select a node and from the bottom pane, click Configuration.

4. Click JVM Configuration.

5. Add the property:

— Property: spm.probe

— Value: off

6. Click Save and then Install or Sync to synchronize the node configuration.

7. Restart the Node using the ActiveMatrix Administrator to reflect the changes.

Disabling the service probe using ActiveMatrix Administrator CLI1. On nodes you want to disable the probe, open

<CONFIG_HOME>\admin\<enterprise

name>\samples\spm\spm_probe.properties and set the following:

set spm_probe=off

2. Go to <CONFIG_HOME>\admin\<enterprise name>\samples\spm\spm_probe_data.xml. Update the Environment, Node, and Host names.

3. Ensure that the node is running before you execute the these steps:a. Run ant -f spm_probe_build.xml.

b. Restart the affected nodes.


Client Properties of the ActiveMatrix Service Performance Manager | 11

Client Properties of the ActiveMatrix Service Performance Manager

Client properties of the ActiveMatrix Service performance manager are listed.

Property Mandatory

Default Value Description

spm.probe Yes off Property to enable or disable a service probe on ActiveMatrix nodes.

spm.client.connection.username

Yes admin Specifies username of metric engine.

spm.client.connection.password

Yes Specifies password for metric engine.

This is obfuscated using the obfuscation utility shipped with the product.

spm.client.jms.jndi.url

Yes tibjmsnaming://localhost:7222 Specifies JMS JNDI URL.

spm.client.amx.schema.name

No AMX_3_0 The value of the name attribute of the Schema file. This Schema file is given as an input to ActiveMatrix Service Performance Manager.

spm.client.jvm.stat.interval.minutes

No 1 Interval in minutes that a service uses to publish the JVM information of a node to ActiveMatrix Service Performance Manager.

spm.client.jms.jndi.contextfactory

No com.tibco.tibjms.naming.TibjmsInitialContextFactory

Specifies context factory class for the JMS provider.

spm.client.jms.queueconnectionfactory

No SPMQueueConnectionFactory Queue connection factory name. Needs to be pre-created.

spm.client.abound.queue

No spm.inbound.queue Queue name on JMS to perform sync/async operations.



spm.client.jms.inbound.query.queue

No spm.inbound.query.queue Queue name on JMS to perform snapshot query operations.

spm.client.jms.outbound.queue

No spm.outbound.queue Queue name on JMS for client to receive notifications from metric engine.

spm.client.taskmgr.threadpool.size

No 5 Number of threads to be used for fact publishing per session.

spm.client.taskmgr.threadpool.

keepalive.time

No 60 Specifies the time (in seconds) to keep alive the task manager threads. When this time elapses, idle threads time out.

spm.client.fact.queue.depth

No 1000 Defines the queue depth for the internal queue for creating a batch of facts.

spm.client.fact.batch.size

No 1 Number of facts to batch before publishing to the ActiveMatrix Service Performance Manager server. For ActiveMatrix Administrator nodes which publishes lifecycle events, this value can be one. Having the value as one ensures that such events are published immediately. For ActiveMatrix non-Administrator nodes the value can be different, say 100.

spm.client.facts.retry.count

No INT_MAX Maximum retries for a synchronous operation if it fails as a result of EMS disconnect.

Property Mandatory




spm.client.fact.eviction.enabled

No true Enable or disable asynchronous 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.

spm.client.fact.eviction.frequency

No 100 You can set this property only if spm.client.fact.eviction.enabled is set to true.

spm.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.

spm.client.heartbeat.interval

No 60 * 1000 Specifies time interval in milliseconds used by named client sessions to send heartbeat.

spm.client.sync.operation.retry.count

No 3 Maximum retries for an operation in case it fails.

spm.client.retry.count

No INT_MAX Maximum retries for establishing connection to a transport provider.

spm.client.retry.wait No 1000 Time in milliseconds to wait before retrying the operation.

spm.client.sync.response.timeout

No 10000 Time in milliseconds to wait for the ActiveMatrix Service Performance Manager to wait for the server to send a response for a sync operation like query registration.

spm.client.sync.jms.msg.expiry

No 5 * 60000 = 30000 Time in milliseconds for the JMS provider to keep a message before it expires.

Property Mandatory




spm.client.session.init.timeout

No LONG_MAX Time to wait for the client session to complete.

spm.client.session.init.timeout.timeunit

No TimeUnit.DAYS The time unit for the wait for the spm.client.session.init.timeout property.

spm.amx.events.queue.depth

No 1000 Defines the queue depth for the internal ActiveMatrix queue for creating a batch of ActiveMatrix Service Performance Manager events.

spm.amx.events.thread.pool.size

No Number of processes +1. Defines the minimum number of threads to be used for publishing ActiveMatrix events to the ActiveMatrix Service Performance Manager fact queue.

spm.amx.resource.stat.interval.minutes

No 1 minute The ActiveMatrix node publishes statistical information of a Shared Resource instance over the interval specified in this property.

For shared resources, the fact emission interval is one minute. For an application service hit, it is real time.

Property Mandatory




spm.amx.app.name.filter

No amx.artifactserver.ap, amx.logservice.app, amx.payloadservice.app, amx.dashboard-app, amx.platform-app, amx.governance.mcr.aggregator, com.tibco.amx.it, com.tibco.amx.bt, com.tibco.amx.platform, com.tibco.amx.mcr.aggregator, com.tibco.amx.commonlogging, GovernanceControlDistribution

NOTE: To filter additional application names, keeping the default intact, use the following format:

spm.amx.app.name.filter = default,<APPLICATION_NAME>

List of comma-separated application names for which life cycle and statistical information is not sent to ActiveMatrix Service Performance Manager.

NOTE: All application names which exactly match or start with the specified names are filtered.

spm.amx.resource.name.filter

No tibco.admin.http.connector.internal,amxAdminDefaultHttpConnector,tibco.admin.appdb.jdbc

NOTE: To filter additional resource names, keeping the default intact, use the following format:

spm.amx.resource.name.filter = default,<USER_SPECIFIED_RESOURCE_NAME>

List of comma-separated resource names for which life cycle and statistical information is not sent to ActiveMatrix Service Performance Manager.

NOTE: All application names which exactly match or start with the specified names are filtered.

Property Mandatory




Known Issues

The table lists known issues in this release.

Key Summary/Workaround

SVCP-190 Summary: Click Applications on the dashboard UI. The UI hangs.

This can occur if you have applications with spaces in the names in the ActiveMatrix 3.1.5 installation and you:

1. upgrade to ActiveMatrix 3.3.0 Hotfix 004,

2. configure ActiveMatrix Service Performance Manager functionality, and

3. navigate to the dashboard.

Workaround: After the upgrade to ActiveMatrix 3.3.0:

1. Undeploy, and then delete the existing applications with spaces in their names. An application shipped with the product is named as "TIBCO ActiveMatrix Mediation Implementation Type" and it has the same issue.

2. Cleanup SPM database.

3. Create the application with the same original name, distribute it to the same nodes as before and deploy it.

NOTE: TIBCO ActiveMatrix BPM user applications must not be undeployed if they have active process instances and work items. SOA applications generally do not maintain any deployment state and hence can be undeployed and redeployed without loss of the state.

SVCP-191 Summary: If an application resides in nested folders, application statistics are not emitted by the probe on clicking Refresh.

Workaround: Expand the folders, select the application, and click Refresh.


installation and configuration addendum - tibco …...tibco activematrix installation and...

Documents