Configuring TIBCO Enterprise Message Service, Version 5.3 (Draft)

This section describes how to collect data from the EMS Servers you want to monitor.

The EMS Monitor configuration is mandatory for EMS Servers monitoring.

By default, the EMS Servers that are routed to by the EMS Servers (defined in the RTView Configuration Application) are auto-discovered and subsequently monitored by EMS Monitor.

The auto-discovery option is ON, by default, but it can be turned OFF at any time. 

Configuring Data Collection

 For additional information on creating secure connections for TIBCO Enterprise Message Service refer to Creating Secure Connections.
  1. Navigate to the Solution Package Configuration > TIBCO Enterprise Message Service > CONNECTIONS tab.
  2. On the CONNECTIONS tab, provide the correct full path to the directory containing the TIBCO Enterprise Message Service .jar files in the Classpath field.

3. Click the  icon to Add Connection.  

  • Specify the connection information and click SAVE where:

URL: Enter the complete URL for the EMS Server. A comma-separated list of URLs is used to designate fault tolerant server pairs.

Username: The username is used when creating the connection to the EMS Server. This field is optional.

Password: This password is used when creating the connection to the EMS Server. This field is optional. By default, the password entered is hidden. Click the icon to view the password text.

4. Repeat the last two steps for each EMS Server to be monitored.

By default, servers that are routed to by the servers defined in this file are automatically discovered. See the steps below to turn OFF auto-discovery.
By default, collecting connections, producers, consumers, queues, and topics data is disabled.

To enable collecting connections, producers, consumers, queues, and topics data, navigate to the Solution Package Configuration > TIBCO Enterprise Message Service > DATA COLLECTION tab > Metric Selection section and enable the metrics for which you want to collect data.

When enabling topics and queues, if you want to limit specific topics and queues monitored (rather than monitoring all topics and queues for all defined and auto-discovered servers), click the Select option, specify the queues and topics that you want to monitor in the associated text entry box, and click Add. Repeat the process for each queue/topic you want to monitor.

Newly added queues and topics are listed beneath the text entry field. Click the x next to the queue/topic to remove the queue/topic.

Enabling EMS Queues and EMS Topics might cause performance issues due to the potentially large number of associated destinations, hence, the collection of metric data has been limited to 2000 rows per Data Server by default. To modify this limit, click the Maximum Metric Count Per Server field and enter the desired limit.

If you want to modify the default values for the update rates for various server-related caches, you can update the default polling rates in Solution Package Configuration > TIBCO Enterprise Message Service > DATA COLLECTION > Poll Rates.

Connection, Consumer, and Producer Caches

Update the polling rates for the Connection, Producer, and Consumer fields to modify the default polling values for the EmsProducers, EmsConsumers, and EmsConnections caches:

Queues and Topics Caches

Update the polling rate for the Queue and Topic fields to modify the default polling rates for the EmsQueues and EmsTopics caches:

Server-Related Caches

Update the polling rate for the Server field to modify the default polling rate for the EmsServerInfo, EmsAdmStats, EmsBridges, EmsDurables, EmsRoutes, EmsFTServerTable, EmsListenPorts, EmsServerRouteTable, EmsServerTable, EmsUsers, and EmsDestinations caches:

When modifying your update rates, you should take into account your system architecture and number of elements per cache  to make sure you are not changing your update rates to values that might negatively impact system performance.

Even when enabled, some Connection, Consumer, Destination, Producer, Queue, and Topic metrics are not collected by default. To modify the defaults, navigate to the Solution Package Configuration > TIBCO Enterprise Message Service > DATA COLLECTION > Metric Filters section.

Each metric has a default regex pattern defined to prevent metrics with the defined patterns from being collected. To edit the default:

a. Click on the desired field.

The Copy default text to clipboard link displays beneath the line.

b. Click the Copy default text to clipboard link to copy the text.  Click on the field, and paste (Ctrl-v) the text into the line.

c. Edit the regex pattern as desired.

If you want to turn OFF the auto-discovery of servers found via route definitions, navigate to Solution Package Configuration > TIBCO Enterprise Message Service > DATA COLLECTION tab > Connection Discovery and deselect the Discover Servers Via Route option.

Optionally,,  enter the Username and Password in the Connection Credentials section.

The defined Username and Password will be used for all connections defined on the Connections tab when a user name and password are not defined. This user name and password will also be used when making topic and queue browser connections.

You can edit the Username field by clicking in the field and entering the desired user name. You can enter the password by clicking the Set Password button, which opens the Connections Credentials Password dialog, and entering the desired password. By default, the password entered is hidden. Click the icon to view the password text.

Configuring Collection of Historical Data for TIBCO Enterprise Message Service (Optional)

You can specify:

  • number of history rows to store in memory
  • compaction rules
  • duration before metrics are expired and deleted
  • different types of metrics ( that the Historian will store in the DATA STORAGE tab in the RTView Configuration Application) 

These parameters already contain default values and therefore modifications to these configurations are optional.

Defining the Storage of EMSMON In Memory History

You can modify the maximum number of history rows to store in memory in the DATA STORAGE tab. The History Rows property defines the maximum number of rows to store for the EmsAdmStats, EmsQueuesExt, EmsServerInfo, EmsTopicsExt, EmsProducers, EmsConsumers, EmsRoutes, and EmsDurables caches.

The History Rows Large property defines the maximum number of rows to store for the EmsQueues, EmsQueueTotalsByServer, EmsTopics, and EmsTopicTotalsByServer caches.

The default setting for History Rows is 50,000 and the default setting for History Rows Large is 200,000.

To update the default settings:

  1. Navigate to the Solution Package Configuration > TIBCO Enterprise Message Service > DATA STORAGE tab.
  2. In the Size tab, click the History Rows and History Rows Large fields and specify the desired number of rows.

Defining Compaction Rules for EMSMON

Data compaction, essentially, is taking large quantities of data and condensing it using a defined rule, in such a way that a reasonably sized sample of data is stored, instead of all of the data, thus preventing a potentially overloaded database.


The available fields are:

  • Condense Interval -- The time interval at which the cache history is condensed for the following caches: EmsAdmStats, EmsCompdestTotals, EmsQueues, EmsQueueTotalsByServer, EmsQueuesExt, EmsServerInfo, EmsProducers, EmsConsumers, EmsRoutes, EmsDurables, EmsConnections, EmsRouteCountsByServer, EmsServerInfoExt, EmsTopics, EmsTopicTotalsByServer, and EmsTopicsExt. The default is 60 seconds.


  • Condense Raw Time -- The time span of raw data kept in the cache history table for the following caches: EmsAdmStats, EmsCompdestTotals, EmsQueues, EmsQueueTotalsByServer, EmsQueuesExt, EmsServerInfo, EmsProducers, EmsConsumers, EmsRoutes, EmsDurables, EmsConnections, EmsRouteCountsByServer, EmsServerInfoExt, EmsTopics, EmsTopicTotalsByServer, and EmsTopicsExt. The default is 1200 seconds.


  • Compaction Rules -- This field defines the rules used to condense your historical data in the database for the following caches: EmsAdmStats, EmsCompdestTotals, EmsQueues, EmsQueueTotalsByServer, EmsQueuesExt, EmsServerInfo, EmsProducers, EmsConsumers, EmsRoutes, EmsDurables, EmsFTServerTable, EmsServerRouteTable, EmsServerTable, EmsConnections, EmsTopics, EmsTopicTotalsByServer, EmsTopicsExt, EmsRouteCountsByServer, and EmsServerInfoExt.


By default, the columns kept in history will be aggregated by averaging rows with the following rule: 1h -;1d 5m;2w 15m, which means the data from 1 hour will not be aggregated (1h - rule), the data over a period of 1 day will be aggregated every 5 minutes (1d 5m rule), and the data over a period of 2 weeks old will be aggregated every 15 minutes (2w 15m rule).


  1. Navigate to the Solution Package Configuration > TIBCO Enterprise Message Service > DATA STORAGE tab.
  2. In the Compaction tab, click the Condense Interval, Condense Raw Time, and Compaction Rules fields and specify the desired settings.

When you click in the Compaction Rules field, the Copy default text to clipboard link appears, which allows you to copy the default text (that appears in the field) and paste it into the field. This allows you to easily edit the string, rather than creating the string from scratch.

Defining Expiration and Deletion Duration for EMSMON Metrics

The data for each metric is stored in a specific cache. When the data is not updated in a certain period of time, that data will either be marked as expired or, if it has been an extended period of time, it will be deleted from the cache altogether.

By default, metric data will be set to expired when the data in the cache has not been updated within 45 seconds. Also, by default, if the data has not been updated in the cache within 3600 seconds, it will be removed from the cache.


The Expire Time field applies to the following cache: EmsCompdestTotals.

The Delete Time field applies to the following caches: EmsJmsAdminMetrics, EmsQueues, EmsQueueTotalsByServer, EmsQueueInActivityTime, EmsQueuesExt, EmsQueueOutActivityTime, EmsBridges, EmsProducers, EmsConsumers, EmsDurables, EmsDestinations, EmsUsers, EmsConnections, EmsTopics, EmsTopicTotalsByServer, EmsTopicInActivityTime, EmsTopicsExt, and EmsTopicOutActivityTime.

To modify these default parameters:

  1. Navigate to the Solution Package Configuration > TIBCO Enterprise Message Service > DATA STORAGE tab.
  2. In the Duration tab, click the Expire Time and Delete Time fields and specify the desired settings.

Enabling/Disabling Storage of EMSMON Historical Data

The History Storage section allows you to select which metrics you want the Historian to store in the history database. By default, historical EMS Connections, Producers, and Consumers data is not saved to the database. All other metrics are saved by default.

To enable the collection of historical data, perform the following steps:

  1. Navigate to the Solution Package Configuration > TIBCO Enterprise Message Service > DATA STORAGE tab.
  2. In the History Storage tab, select the toggles for the various metrics that you want to collect. Blue is ENABLED, gray is DISABLED.

Defining a Prefix for All History Table Names for EMSMON Metrics

The History Table Name Prefix field allows you to define a prefix that will be added to the database table names, so that the Monitor can differentiate history data across data servers when you have multiple data servers with corresponding Historians using the same solution package(s) and database(s).

In this case, each Historian needs to save data to a different table, otherwise on startup, the corresponding data server will load metrics from both Historians.

Once you have defined the History Table Name Prefix, you will need to create the corresponding tables in your database as follows:

  1. Locate the .sql template for your database under RTVAPM_HOME/emsmon/dbconfig and make a copy of it
  2. Add the value you entered for the History Table Name Prefix to the beginning of all table names in the copied .sql template
  3. Use the copied .sql template to create the tables in your database
If you are using Oracle for your Historian Database, you must limit the History Table Name Prefix to 2 characters because Oracle does not allow table names greater than 30 characters (and the longest table name for the solution package is 28 characters).

To add the prefix:

  1. Navigate to the Solution Package Configuration > TIBCO Enterprise Message Service > DATA STORAGE tab.
  2. Click on the History Table Name Prefix field and enter the desired prefix name.