TIBCO EMS Administration Data Source

 To properly create applications that monitor and manage the health of a JMS implementation you need to know the status of the JMS servers. Realizing the status of JMS servers involves metrics analysis (i.e.: number of consumers, producers, topics and queues), as well as message information (i.e.: rate and queue depth). Access to JMS server metrics is not part of the JMS standard, so a special data source must be provided with each commercial JMS offering.

The TIBCO® EMS Administration data source connects to TIBCO® Enterprise Message Service™ servers. Place raw metrics into RTView functions to calculate SLAs and then present data in dashboards, reports and automated alerts or archive data in the Enterprise RTView Historian for trend analysis on application performance.

 In addition to metrics this data source also provides the capability to perform actions on the server, which includes the ability to create and delete topics, queues, routes and durables. It is also possible to automatically discover TIBCO® Enterprise Message Service™ servers by using defined server routes.

This section includes:

§        “TIBCO EMS Administration System Requirements and Setup” on page 702

§        “Attach to TIBCO EMS Administration Data” on page 703

§        “Define TIBCO EMS Administration Command” on page 708

§        “Application Options - TIBCO EMS” on page 711

§        “RTView Deployment - TIBCO EMS Administration” on page 718

§        “TIBCO EMS Administration Data Source Command Line Options” on page 719

 

TIBCO EMS Administration System Requirements and Setup

System Requirements

In addition to basic “System Requirements”, the TIBCO EMS Administration data source requires TIBCO EMS. See the README_sysreq.txt file in your installation’s home directory for the current version(s) supported.

Setup

In addition to general environment variables (see “Setup”), you must set TIBJMS_ROOT. If you will be using SSL, you must set both TIBJMS_ROOT and RTV_USERPATH:

Name

Description

Example

TIBJMS_ROOT

TIBCO EMS installation directory. If you installed RTView using the Windows installer, this variable may already be set globally on your system.

C:\TIBCO\ems

RTV_USERPATH

TIBCO EMS SSL support jars.

Note: If this variable already exists, append the TIBCO EMS jars to it.

If you are using SSL, also include the following, which are located in the EMS_HOME\lib directory:

tibcrypt.jar

slf4j-api-1.4.2.jar

slf4j-simple-1.4.2.jar

Attach to TIBCO EMS Administration Data

Note: The TIBCO EMS Administration data source may not be licensed in your RTView installation.

The Attach to TIBCO EMS Administration Data dialog, which is used to connect an object property to a TIBCO EMS Administration metric (see “TIBCO EMS Metrics”), can be accessed from the Object Properties window. Once a property has been attached to a metric, it receives continuous updates.

When an object property is attached to data, the Property Name and Value in the Object Properties window will be displayed in green. This indicates that editing this value from the Object Properties window is no longer possible. To remove the data attachment, and resume editing capability in the Object Properties window, right-click on the Property Name and select Detach from Data. You will recognize that an object property has been detached from the data source when the Property Name and Value are no longer green.

Right-click on the Property Name from the Object Properties window and select Attach to Data>JMSADM to display the Attach to TIBCO EMS Administration Data dialog. The Attach to TIBCO EMS Administration Data dialog provides drop down menus that allow you to specify information regarding the EMS Administration metric to display.

ems_atd.gif

 

Field Name

Description

Server URL

Select the name of a Server URL from the drop down menu of all available EMS servers. When * is entered, the table returned will contain rows with information from metrics tables for each EMS Server that is being monitored.

The Server URL drop down menu lists all available EMS servers. Drop down menus for Metrics Table, Field(s), and Filter Name populate based on the selected EMS Server. If the item you require is not listed, type your selection into the field. For information on adding EMS Servers, see “Application Options - TIBCO EMS”.

Metrics Table

Select a Metric from the drop down menu. See “TIBCO EMS Metrics” for more information.

Pattern

This field is only available if Queues, Topics, Producers, or Consumers is selected from the Metrics Table drop down list. If the Pattern field is left empty, all queues, topics, producers, or consumers are returned. If a string is entered in this field, only those queues, topics, producers, or consumers that match the pattern are returned. The pattern may contain the wildcards * and >. For example, a pattern of test1.> or test1.*.test. See the TIBCO documentation for more information on how wildcards work in topic names.

Field(s)

Select the Field(s) to update the attached object.

Filter

Select to filter the fields of the selected metric.

Filter Field Name

Name of the field to use as a filter.

Filter Field Value

Value that the filter field must equal. Single or multiple values may be listed. Enter * to display all rows in the table. Enter "*" to use * as a literal comparative value. To list multiple values, separate with a semicolon. For example: value1;value2;value3. If your value contains a semicolon, enclose it in single quotes.

Update Mode

This drop down list contains two options:

Metrics Period: (default) queries data attachments at the same interval as defined by the collector.sl.rtview.jmsadm.metrics_period property in the emsmon/conf/rtvapm.emsmon.properties file. The default value is 15000 milliseconds (15 seconds).

Update Query: Selecting this option enables the Query Interval field (see below).

Query Interval (seconds)

Allows you to specify a query interval for the field that is different from the default interval (metrics_period).

The Query Interval is evaluated during each update pass, so the amount of time elapsed between queries may be longer than the value entered. Typically, the Query Interval will be set to an even multiple of the metrics_period but, for explanation purposes, let’s say that the metrics_period is set to 15 seconds and Query Interval is set to 20 seconds:

metrics_period (seconds):...15...30...45...60

Query Interval (seconds): ....20....40....60

At 15 seconds, no update will occur since Query Interval is set to 20 (it has not been more than 20 seconds since the last update). When metrics_period reaches 30 seconds, the update occurs because it has been more than 20 seconds since the last update. When metrics_period reaches 45 seconds, the update will not occur because only 15 seconds have passed since the last update. When metrics_period reaches 60 seconds, it will have been 30 seconds since the last update (and, hence, greater than the defined 20 second Query Interval) and the update will occur.

If Query Interval was set as a multiple of the metrics_period in the above example, say 60 seconds, then updates would be skipped at 15 seconds, 30 seconds, and 45 seconds, but would be run at 60 seconds. Then, updates would be skipped at 75 seconds, 90 seconds, and 105 seconds, but would be run at 120 seconds since it would have been 60 seconds since the last update.

Data Server

Select to read data through your configured Data Server and not directly from the data source.

Default - Select the default Data Server you configured in Application Options>“Data Server Tab”.

None - Bypass data being redirected through the specified data server(s) for this attachment and instead attach directly to the data source.

Named Data Servers - Select a Named Data Server that you configured in Application Options>“Data Server Tab”.

 

Multi-Server Attachment - To configure multiple data servers, enter a semicolon (;) delimited list containing two or more Named Data Servers (e.g. ds101;ds102). Each name specified must correspond with a Named Data Server that you configured in Application Options>“Data Server Tab”. It is also possible to specify __default and __none (e.g. __default;ds101;ds102).

The values __default and __none begin with two underscore characters.

 

Alternatively, a value of * can be entered to specify all data servers, including __default and __none.

 

When multiple data servers are specified, the data attachment will be directed to each data server in the list. For tabular data attachments, a column named DataServerName will be added as the first column of the table and contain the name of the server from which the data was received.

 

A multi-server attachment will receive data independently from each of the servers it specifies, so in most cases it will be necessary to combine the tables received into a single table. This can be accomplished in two ways:

 

1.     The multi-server attachment can be applied to a local cache that has the DataServerName column specified as an index column. The current table of that cache will contain the combination of the tables received from all servers. Note: It may also be necessary to configure cache row expiration settings to remove defunct rows.

The multi-server attachment can be applied as the Table argument of the RTView function named Combine Multi-Server Tables. See “Tabular Functions” for more information.

Substitutions

Substitutions allow you to build open-ended displays in which data attachments depend on values defined at the time the display is run. Generic names, such as $server1 and $server2, are used instead of values for specific servers, metrics tables, or fields. Later when the display is running, these generic values are defined by the actual names. In this way, a single display can be reused to show data from a number of different sources. For more information on creating displays using substitution values, see “Substitutions”.

Select Table Columns

From the Attach to TIBCO EMS Administration Data dialog you can specify which table columns to display and in what order they will appear. In order to populate the listing of available columns, you must first select a valid Server URL and Metrics Table. 

To bring up the Select Columns dialog, click on the ellipses button ellipse_button00037.gif in the Field(s) field (or right-click in the Field(s) field and click on Select Columns). The dialog should contain a list of Available Columns that you can add to your table.

To add a column, select an item from the Available Columns list and click on the Add button. If the item you require is not listed, type your selection into the Enter Column Name field. Click the Remove button to delete an item previously added to the Selected Columns list. You can control the order of columns in a table by arranging the items in the Selected Columns list with the Move Up and Move Down buttons.

If no data is available for a table row within a selected column, the table cell will display one the following values: N/A, false, 0, or 0.0.

ems_atd_select.gif

 

The following describes the Attach to TIBCO EMS Administration Data dialog commands:

Command

Description

OK

Applies values and closes the dialog.

Apply

Applies values without closing the dialog.

Reset

Resets all fields to last values applied.

Clear

Clears all fields. Detaches object from data source (once Apply or OK is selected).

Cancel

Closes the dialog with last values applied.

TIBCO EMS Metrics

RTView maintains server metrics tables for each EMS Server that is being monitored. The following pre-defined substitutions are recognized:

$server - Name of the selected server

$conn - Name of the admin connection to the selected server

$agent - Name of the TIBCO Hawk Agent associated with the selected server

The metrics for each EMS Server includes a table named ServerTable that contains information (e.g. Name, URL, Agent Name, etc.) for each server being monitored, in addition to a table for each of the following com.tibco.tibjms.admin classes:

Table Name

TibjmsAdmin Class

ServerInfo

com.tibco.tibjms.admin.ServerInfo

Users

com.tibco.tibjms.admin.UserInfo

ListenPorts

com.tibco.tibjms.admin.ServerInfo getListenPorts( ) method

Connections

com.tibco.tibjms.admin.ConnectionInfo

Consumers

com.tibco.tibjms.admin.ConsumerInfo

Producers

com.tibco.tibjms.admin.ProducerInfo

Durables

com.tibco.tibjms.admin.DurableInfo

Queues

com.tibco.tibjms.admin.QueueInfo

Topics

com.tibco.tibjms.admin.TopicInfo

Routes

com.tibco.tibjms.admin.RouteInfo

Note: When * is entered in the Server URL field of the   “Attach to TIBCO EMS Administration Data” dialog, the table returned will contain rows with information from the metrics tables listed above for each EMS Server that is being monitored.

Define TIBCO EMS Administration Command

Note: The TIBCO EMS Administration data source may not be licensed in your RTView installation.

You can access the Define TIBCO EMS Administration dialog from the Object Properties window. This dialog is used to assign a TIBCO EMS Administration command to an object's command property, giving you the ability to execute administrative commands on your EMS Server from within an RTView display. If you execute a TIBCO EMS Administration command from a Thin Client with Direct Data Connection or any Served Data deployment, the command will execute on the server.

Right-click on the appropriate command property in the Object Properties window and select Define Command>JMSADM to display the Define TIBCO EMS Administration dialog. See the “Define/Execute Command” section for information on how to execute a command.

command_dialog_ems.gif

 

Field Name

Description

Command

Enter a command.

Data Server

Select to read data through your configured Data Server and not directly from the TIBCO EMS Administration data source.

 

Default - Select the default Data Server you configured in Application Options>“Data Server Tab”.

 

None - Bypass data being redirected through the specified data server(s) for this attachment and instead attach directly to the data source.

 

Named Data Servers - Select a Named Data Server that you configured in Application Options>“Data Server Tab”.

 

Multi-Server Command - When multiple data servers are specified, the command will be executed on each data server in the list.

 

To configure multiple data servers, enter a semicolon (;) delimited list containing two or more Named Data Servers (e.g. ds101;ds102). Each name specified must correspond with a Named Data Server that you configured in Application Options>Data Server. It is also possible to specify __default and __none (e.g. __default;ds101;ds102).

Note: The values __default and __none begin with two underscore characters.

 

Alternatively, a value of * can be entered to specify all data servers, including __default and __none.

Command Format

TIBCO EMS Administration uses the following command format.

Format

Example / Description

Server_URL Command Argument1 Argument2 Argument3 Argument4

www.sl.com create_topic 'Sales 2005' true true 3200 

§        The first token in the command is always the server URL.

§        Depending on the command, one to six arguments may be used (the example above has four).

§        Single quotes must be used if a token contains a space. For example, 'Sales 2005'.

Command line parameters for TIBCO EMS Administration include:

Command

Description

Argument

Description

Example

delete_connection

Deletes a connection.

Server URL

URL of your local EMS server.

tcp://emsserver1:7222 delete_connection 555

Connection ID

ID of connection to delete.

create_topic

Creates a topic.

Topic name

Name of the topic to create.

tcp://emsserver1:7222  create_topic Q4Results true true 3200

Global flag

Set global property of this topic. True / false.

Failsafe

Set failsafe property of this topic. True / false.

Maximum bytes

A numeric value for the maximum topic size.

delete_topic

Deletes a topic.

Topic name

Name of the topic to delete.

tcp://emsserver1:7222 delete_topic Q4Results

purge_topic

Purges a topic.

Topic name

Name of the topic to purge.

tcp://emsserver1:7222  purge_topic Q4Results

create_queue

Creates a queue.

Queue name

Name of the queue to create.

tcp://emsserver1:7222  create_queue Sales true true 3200

Global flag

Set global property of this queue. True / false.

Failsafe

Set failsafe property of this queue. True / false.

Maximum bytes

A numeric value for the maximum queue size.

delete_queue

Deletes a queue.

Queue Name

Name of the queue to delete.

tcp://emsserver1:7222  delete_queue Sales

purge_queue

Purges a queue.

Queue Name

Name of the queue to purge.

tcp://emsserver1:7222  purge_queue Sales

create_durable

Creates a durable.

Durable Name

Name of the durable to create.

tcp://emsserver1:7222  create_durable Durable1 Sales jsmith selector1 true true

Topic Name

Name of topic on which to create durable.

Client ID

Client ID associated with the durable.

Selector

The selector associated with the durable.

No local

Prevents reception of messages sent on this session. True / False

Route

Designates this as a durable for another server. True / False

delete_durable

Deletes a durable.

Durable Name

Name of the durable to delete.

tcp://emsserver1:7222  delete_durable Durable1 jsmith

Client ID

Client ID associated with the durable (can be null).

purge_durable

Purges a durable.

Durable Name

Name of the durable to purge.

tcp://emsserver1:7222  purge_durable Durable1 jsmith

Client ID

Client ID associated with the durable (can be null).

create_route

Creates a route to another server.

Route Name

Name of the route to create. This must be the same as the destination server URL.

tcp://emsserver1:7222  create_route tcp://emsserver2:7222  tcp://emsserver2:7222 zone1 MHOP

Destination Server

URL of the destination server.

Zone Name

Name of the zone to create this route in.

Zone Type

The type of zone to create this route in.

delete_route

Deletes a route.

Route Name

Name of the route to delete.

tcp://emsserver1:7222  delete_route tcp://emsserver2:7222

Substitutions

The Substitutions feature allows you to build open-ended displays in which commands depend on values defined at the time the display is run. Substitutions can be used in place of any token in a command. For example, a generic server URL such as $server is used instead of a specific server URL. Later when the display is running, this generic value is defined by the actual name of a specific server. In this way, a single display can be reused to execute commands on a number of different servers. For more information on creating displays using substitution values, see “Substitutions”.

Special Values

$value

When an actionCommand is executed $value is replaced with the value from the control. This value may be used in any token in the Define TIBCO EMS Administration dialog.

Note: This value may only be used for Action Commands. See “Define/Execute Command” for more information.

The following describes Define TIBCO EMS Administration dialog commands:

Command

Description

OK

Applies values and closes the dialog.

Apply

Applies values without closing the dialog.

Reset

Resets all fields to last values applied.

Clear

Clears all fields. Detaches object from assigned message subject (once Apply or OK is selected).

Cancel

Closes the dialog with last values applied.

Application Options - TIBCO EMS

Select Tools>Options in the Display Builder to access the Application Options dialog.

Options specified in TIBCO EMS tabs can be saved in an initialization file (JMSADMOPTIONS.ini). On startup, the initialization file is read by the Display Builder, Display Viewer, Display Server, Data Server and Historian to set initial values. If no directory has been specified for your initialization files and JMSADMOPTIONS.ini is not found in the directory where you started the application, then RTView will search under lib in your installation directory. See “RTV_JAVAOPTS” for more information.

Note: Options specified using command line arguments will override values set in initialization files. See “TIBCO EMS Administration Data Source Command Line Options” for more information.

There are two Application Options tabs for TIBCO EMS: “TIBCO EMS Administration Tab” and “TIBCO EMS Servers Tab”.

TIBCO EMS Administration Tab

This tab allows you to administer connection settings for your TIBCO EMS servers. After configuring TIBCO EMS server options, click OK, Apply, or Save.

app_opt_emsadmin.gif

 

Field Name

Description

Enable Server Monitoring

Enables the maintenance of TIBCO EMS Administration metrics for each server listed in the specified Servers File. This option is enabled by default. See “TIBCO EMS Metrics” for more information.

Discover Servers using Routes

Uses the Routes server metrics table (“TIBCO EMS Metrics”) to enable automatic discovery of EMS servers. A new server is added to the table only if the route to that server is active and connected. This option is enabled by default. To connect to only those servers listed in the specified Servers File, you must deselect both this option and Discover Servers using TIBCO Hawk. See “Discovering EMS Servers” for more information.

Discover Servers using TIBCO Hawk

Uses the TIBCO Hawk JMS_Controller microagent to enable automatic discovery of EMS servers. This option is enabled by default. To connect to only those servers listed in the specified Servers File, you must deselect both this option and Discover Servers using Routes. See “Discovering EMS Servers” for more information.

Note: If this check box is deselected, the EMS Monitoring Host Details display will not be visible. See “EMS Monitoring” for more information.

Enable Monitor Messages

Enables the creation of an admin connection to each EMS Server that will be used to receive Monitor Messages. This option is disabled by default. See “EMS Monitoring” for more information.

Note: Because the TIBCO EMS server publishes message monitor topics when events (connect, disconnect, produce, consume, etc.) occur, enabling Monitor Messages in production systems may have an adverse effect on system performance. If it will be used in production, the Monitor Messages display should be modified to narrow down the number of messages. Refer to Monitoring Server Events in TIBCO's EMS documentation for more information.

Default Admin User Name

Specify a user name to connect to TIBCO EMS servers. Default is admin.

Default Admin Password

Specify a password to connect to TIBCO EMS servers. Default is no password.

If you need to provide an encrypted password (rather than expose server password names in a clear text file, use the encode_string command line option with the following syntax:

encode_string type mypassword

where type is the key for the data source and mypassword is your plain text password.

Note: The type argument is only required when you encrypt a string for a data source.

For example, enter the following in an initialized command window (see “Initializing a Command Prompt or Terminal Window”):

encode_string jmsadm mypassword

and you will receive an encrypted password:

encrypted value: 013430135501346013310134901353013450134801334

Copy the encrypted value, paste it into the password field and click Save to save this value to the initialization (*.ini) file. Or, if necessary, manually edit the (*.ini) file to include the encrypted value.

Note: If you need to manually edit a configuration (*.ini) file, contact SL Technical Support at support@sl.com for information about supported syntax.

Servers File Name

Enter the name of the file (including path, if necessary) that RTView will read to determine which servers to monitor. Default file name is servers.xml, which is located in the directory where you started RTView.

Note: The Servers File is created when you click Apply and Save Servers File on the TIBCO EMS Servers tab. To only monitor those servers specified in the Servers File and disable automatic discovery, deselect both Discover Servers check boxes.

Metrics Update Period

Enter the time in milliseconds to control how often EMS Server metrics will be queried. Default is 0, which queries according to the update period specified on the Application Options General tab.

Note: Because the Metrics Update Period is superseded by the General Update Period, the amount of time elapsed between queries may be longer than the value entered. For example, if the General Update Period is 2000 milliseconds and the Metrics Update Period is 5000 milliseconds, EMS Server metrics will be queried every six seconds.

TIBCO EMS Servers Tab

This tab allows you to add and remove EMS servers. After adding or removing EMS servers, or applying and saving an EMS server file, click OK, Apply, or Save.

Note: Additional setup is required to connect to your EMS Server using SSL. See “TIBCO EMS Administration SSL Parameters” for more information.

app_opt_emsservers.gif

 

Field Name

Description

Add Server

Click to open the Add EMS Server dialog. If TIBCO Hawk is available but the JMS_controller microagent is not running, the Agent is used to tell RTView the name of the TIBCO Hawk agent that is running on the host machine that contains the server. The information in the Host Details page will be updated using data collected from that TIBCO Hawk microagent. If both the TIBCO Hawk agent and JMS_controller microagent are running on the server's host machine, then TIBCO Hawk will discover the server running on that machine. In this case, the name of the agent does not need to be provided in the servers file as RTView will make the association automatically.

app_opt_emsadd.gif

 

 

Server URL - The complete URL for your EMS server.

 

Server Name - The name of your EMS server.

 

Agent Name - Name of the agent containing the microagent method to subscribe. This field is optional. If TIBCO Hawk is available but the JMS_controller microagent is not running, this value is used to tell RTView the name of the TIBCO Hawk agent that is running on the host machine that contains the server. The information in the Host Details page will be updated using data collected from that TIBCO Hawk microagent. If both the TIBCO Hawk agent and JMS_controller microagent are running on the server's host machine, then TIBCO Hawk will discover the server running on that machine. In this case, the name of the agent does not need to be provided here as RTView will make the association automatically.

 

User Name - The user name to use when creating this connection. This field is optional.

 

Password - The password to use when creating this connection. This field is optional.

Remove Server

Click to remove an EMS server selected in the Servers field.

Remove All Servers

Click to remove all EMS servers from the Servers field.

Note: You must deselect both Discover Servers check boxes on the TIBCO EMS Administration tab or the Servers field will immediately repopulate. The Discover Servers check boxes are selected by default.

Apply and Save Servers File

Click to apply all options, from all tabs, and save your EMS servers file.

Discovering EMS Servers

The All Servers display in the navigation tree allows you to monitor EMS servers. The TIBCO EMS Manager application can automatically discover EMS Servers using the TIBCO Hawk JMS_Controller microagent and the Routes server metrics table or you can specify which servers the EMS Manager will monitor via XML file.

Automatically Discover Servers

Using TIBCO Hawk 

If you are running the TIBCO Hawk JMS_Controller microagent, the list of TIBCO EMS Servers will automatically populate. In order to use the TIBCO Hawk JMS_Controller microagent, it must be installed as a TIBCO Hawk plugin on each system you want to monitor and configured with administrative privileges for the TIBCO EMS Server. Refer to TIBCO's EMS documentation for instructions. By default, this microagent will be accessed using TIBCO default domain, service, network and daemon parameters. See “Application Options - TIBCO Hawk” for information on changing these settings.

Note: The EMS Monitoring Host Details display will only contain data if you are running the TIBCO Hawk JMS_Controller microagent. See “Built-In Displays” for more information.

Using Routes Table 

The list of TIBCO EMS Servers will automatically populate based on data contained in the Routes server metrics table. New servers are added to the table only if routes to those servers are active and connected. See “TIBCO EMS Metrics” for more information.

Manually Specify Servers

The TIBCO EMS Manager also determines which servers to monitor by reading the Servers File. Select Save Server File from the popup menu to save your Servers File.

Note: Save Server File is only available if login is disabled or if you are logged in with the admin role.

In the Display Builder, go to Application Options>“TIBCO EMS Servers Tab” to add or remove EMS servers from the Servers File. To enter the name of your own Servers File, disable automatic discovery, or specify a default user name and password, go to Application Options>“TIBCO EMS Administration Tab”.

Built-In Displays

The following displays are supplied with the TIBCO EMS Manager application and are accessible from the navigation tree.

Note: If your login doesn't allow you to view a particular display, it will not be accessible from the navigation tree.

EMS Administration

Manage Topics (manage_topics.rtv)

Create new topics from selected servers and delete existing topics.

Manage Queues (manage_queues.rtv)

Create queues from selected servers and purge existing queues.

Manage Durables (manage_durables.rtv)

Create durables from selected servers and purge existing durables.

Manage Routes (manage_routes.rtv)

Add and delete routes between servers.

Manage Bridges (manage_bridges.rtv)

Create and delete bridges between destinations.   

Manage Connections (manage_connections.rtv)

View and delete connections from selected servers.

EMS Monitoring

EMS Server Topology (ems_server_topology.rtv)

Topology of EMS Servers and Routes. Active server icons are displayed in green, inactive server icons are red. Arrows indicate the direction of active routes.

All EMS Servers

Overview of all EMS Servers. Active server icons are displayed in green, inactive server icons are red. An EMS Server entry appears for each server you are monitoring. For each server, the following displays are generated:

Host Details (host_details.rtv) - Server Host details, including Agent, IP, Platform, Time Range, and Top Processes.

Note: This display will only contain data if you are running TIBCO Hawk. To remove this display, see Application Options>“TIBCO EMS Administration Tab”.

Topics (ems_topics_api.rtv) - Topic details, including Total Inbound, Outbound, Pending, Rate In, and Out. Also supports browsing message content.

Queues (ems_queues_api.rtv) - Queue details, including Total Inbound, Outbound, Pending, Rate In, and Out. Also supports browsing queue content.

Producers (ems_producers_api.rtv) - Details about Producers, including Total Messages, Total KB, Message Rate and KB.

Consumers (ems_consumers_api.rtv) - Details about Consumers, including Total Messages, Total KB, Message Rate and KB.

 

Durables (ems_durables_api.rtv) - Details about Durables, including Total Messages, Total KB, Pending Messages and Pending Messages KB.

 

Connections, Etc. (ems_tables_api.rtv) - Details about Connections, Routes, Durables, Users, Listen Ports and  Bridges.

Monitor Messages (ems_monitor_messages.rtv) - Monitor EMS Server messages that use the TIBCO message monitoring topics to indicate changes in the following: Producers, Consumers, Topics, Queues, Connections and Routes. This display is disabled by default. To enable this display, see Application Options>“TIBCO EMS Administration Tab”.

Note: Because the TIBCO EMS Server publishes message monitor topics when events (connect, disconnect, produce, consume, etc.) occur, this display should be modified in production systems to narrow down the number of monitor messages. Using this display in production systems without modification may have an adverse effect on system performance. Refer to Monitoring Server Events in TIBCO's EMS documentation for more information.

TIBCO EMS Administration SSL Parameters

Note: This section assumes you have a working knowledge of writing, compiling and deploying Java classes.

To use SSL with your TIBCO EMS Administration connections, you will need to create a Java class named MyTibJmsSSLHandler that extends the com.sl.gmsjtibjmsadmin.GmsRtViewTibJmsSSLHandler class.

In MyTibJmsSSLHandler, define the following method:

public Map getSSLParams (String serverUrl)

This method will get called to retrieve the list of SSL parameters to pass in when RTView creates each TIBCO EMS Server Administration connection. See the TIBCO EMS documentation for information on creating a Map of SSL parameters suitable to pass into the TIBCO EMS Server Administration connection.

Add gmsjtibjmsadmin.jar, located in the lib directory (found in your installation directory), to your classpath when you compile MyTibJmsSSLHandler. The compiled MyTibJmsSSLHandler class must be included in the RTView classpath by adding it to the definition for the RTV_USERPATH environment variable.

The following is an example of MyTibJmsSSLHandler. To execute this example you must include the tibjms.jar in your classpath when compiling.

import java.util.*;

import com.tibco.tibjms.TibjmsSSL;

import com.sl.gmsjtibjmsadmin.GmsRtViewTibJmsSSLHandler;

 

public class MyTibJmsSSLHandler extends GmsRtViewTibJmsSSLHandler

{

 

/** This method will get called once per connection attempt for each

* URL. It should return a Map of the SSL parameters needed to

* connect to the specified serverUrl or null if no SSL parameters

* are needed.

* @param serverUrl The String form of the URL RTView is connecting to.

*/

 

public Map getSSLParams (String serverUrl)

{

 

System.out.println("trying to connect to:"+serverUrl);

 

Hashtable<String, String> h = new Hashtable<String, String>();

// Add values common to all servers to the Hashtable.

// Modify these to contain the correct values for your server

// and add any additional SSL parameters that are requred by your servers

// or remove any SSL parameters that are not required by your servers.

// If any of these are not common to all servers, move them into

// the server specific if/else statements below.

// See com.tibco.tibjms.TibjmsSSL in the TIBCO EMS Javadocs

// for a full list of SSL parameters.

 

h.put(com.tibco.tibjms.TibjmsSSL.TRACE,"true");

h.put(com.tibco.tibjms.TibjmsSSL.DEBUG_TRACE, "true");

h.put(com.tibco.tibjms.TibjmsSSL.ENABLE_VERIFY_HOST_NAME, "false");

h.put(com.tibco.tibjms.TibjmsSSL.ENABLE_VERIFY_HOST, "false");

h.put(com.tibco.tibjms.TibjmsSSL.IDENTITY,"C:/tibco/config/tibco/cfgmgmt/ems/data/certs/client_identity.p12");

h.put(com.tibco.tibjms.TibjmsSSL.PASSWORD, "password");

h.put(com.tibco.tibjms.TibjmsSSL.TRUSTED_CERTIFICATES,"C:/tibco/config/tibco/cfgmgmt/ems/data/certs/client_root.cert.pem");

 

// add server specific values to the Hashtable

if (serverUrl.equals("ssl://myserver1:7243")) {

h.put(com.tibco.tibjms.TibjmsSSL.EXPECTED_HOST_NAME,"myserver1");

 

} else if (serverUrl.equals("ssl://myserver2:7243")) {

h.put(com.tibco.tibjms.TibjmsSSL.EXPECTED_HOST_NAME,"myserver2");

}

 

return h;

}

 

}

RTView Deployment - TIBCO EMS Administration

This section contains details about the deployment process that are specific to your data source. Please go to the Deployment section of this documentation for instructions on how to implement your RTView deployment option. Return to this section whenever you are instructed to refer to deployment information that is specific to your data source.

System Requirements and Setup

The TIBCO EMS Administration data source has additional System Requirements and Setup. See “TIBCO EMS Administration System Requirements and Setup” for more information.

Data Source Configuration File

RTView saves general application settings as well as data source configuration options in initialization files that are read at startup. If no directory has been specified for your initialization files and files are not found in the directory where you started the application, then RTView will search under lib in your installation directory. See “Application Options”“Application Options - TIBCO EMS”, and “RTV_JAVAOPTS” for more information.

Include the following initialization file when you deploy RTView with this data source:

File Name

Description

JMSADMOPTIONS.ini

Contains data source options for TIBCO EMS Administration.

Note: Options specified using command line and applet parameters override values set in these initialization files.

Rich Client Browser Deployment Setup for Direct Data Connection

This deployment is not supported by your data source. Use the Data Server to supply data to displays with TIBCO EMS Administration data attachments. See “Rich Client Browser with Served Data” for more information.

TIBCO EMS Administration Data Source Command Line Options

In addition to General Options, the following command line arguments are enabled with the TIBCO EMS Administration data source when you run RTView applications from a Windows Command Prompt or UNIX terminal window.

Note: If a command line argument contains a space or a semicolon, then the entire argument must be enclosed in quotes (e.g.: "-sub:$data:my Data").

Name

Description

-disableFTDiscovery

By default, when this option is not used, RTView queries each EMS Server (each server that is defined in the servers.xml or discovered using Hawk or Routes) for its fault tolerant URL. The URL returned by the EMS Server is the value used in the ft_active setting in the EMS Server configuration. If RTView does not already have this URL in the ServerTable, it will be added and a connection to it will be made. This can cause duplicate entries in the ServerTable in the case where the server was specified in servers.xml using a different URL than was used in the ft_active field. For example, the URL in ft_active uses a host name but the servers.xml entry for the same server uses an IP address. Or, the servers.xml uses a DNS alias, but the ft_active uses a host name or ip address.

When the -disableFTDiscovery option is used, RTView will not query each EMS Server for its fault tolerant URL. Instead, it expects that all fault tolerant EMS Server pairs are added to servers.xml as compound URLs (ex. tcp://myhost:7222,tcp://myhost2:7224). For each server in the compound URL, the fault tolerant URL will be set to the other server in the compound URL. No error checking is done to confirm that the two URLs listed are actually a fault tolerant pair. It is up to the user to be sure that the servers.xml information is correct.

-jmsadm_metrics_period: (milliseconds)

Specify the rate at which the TIBCO EMS Administration metrics should be queried. Default is 2000. See “TIBCO EMS Metrics” for more information.

Example:

-jmsadm_metrics_period:2000

-jmsadm_maxmetricsrowcount:

(number of rows)

Specify the maximum number of rows in a server metrics table. If the table size exceeds this limit, no rows will be read. Default is 1000.

Example:

-jmsadm_maxmetricsrowcount:1000

-jms_minreconnecttime: (seconds)

Enter the minimum number of seconds that will elapse before attempting to reconnect to the server. Default is 30.

Example:

-jms_minreconnecttime:30

-servers:(filename)

Specify the path and file name for your servers file. Default is servers.xml.

Example:

-servers:c:\myservers.xml