Configuring RTView Manager, Version 5.2

This section describes how to collect data from the RTView Servers you want to monitor. Using the RTView Configuration Application, you can provide server details to establish connections, modify the poll rate interval for collecting data, enable/disable autodiscover (this option is enabled by default), and set rules for how data is stored, as well as when data is reduced, expired, and deleted. For changes made in the RTView Configuration Application to take place, you must restart your data server after making and saving your changes.

Configuring Data Collection

This section describes how to establish the data connection for Solution Package for RTView Manager. This part of the configuration is required.

To configure data connections for the Solution Package for RTView Manager:

  • Navigate to Solution Package Configuration > RTView Manager from the list.

  • On the CONNECTIONS tab and in the Connections region, click the  icon.

The Add Connection dialog displays.

  • Specify the connection information and click SAVE where:

Connection Name: Name to use when referencing this connection. This must be unique.

Host: Host name or IP address of the MBean server.

Port: Port exposed by your MBean server.

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

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

The newly created connection displays in the Connections region. Repeat the last two steps for each server to be monitored.

  • You can optionally modify the Poll Rates (query interval, in seconds) that will be used to collect the metric data for all RTView Manager caches in Solution Package Configuration > RTView Manager DATA COLLECTION > Poll Rates.

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

  • Optionally, you can enable the Autodiscover JMX Connections option to automatically discover and connect to all local JMX MBean Servers in Solution Package Configuration > RTView Manager DATA COLLECTION > Connection Discovery. Disable this option to connect only to the JMX MBean Server listed in the Connections tab.

Configuring Historical Data Collection (Optional)

You can specify the number of history rows to store in memory, the compaction rules, the duration before metrics are expired and deleted, and the different types of metrics that you want the Historian to store in the DATA STORAGE tab in the RTView Configuration Application.

Defining the Storage of 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 JvmGcInfo, JvmMemoryPool, RtvDataServerManager, RtvDisplayServerManager and RtvDataServerClientTotals caches. The default setting for History Rows is 50,000. The History Rows Large property defines the maximum number of rows to store for the JvmOperatingSystem, JvmThreading, JvmMemory, RtvDataServerClientStats and TomcatWebModuleStats caches. The default setting for History Rows Large is 200,000.  To update the default settings:

  • Navigate to the Solution Package Configuration > RTView Manager DATA STORAGE tab.
  • In the Size region, click the History Rows and History Rows Large fields and specify the desired number of rows.

Defining Compaction Rules

Data compaction, essentially, is taking large quantities of data and condensing it using a defined rule so that you store a reasonably sized sample of data instead of all of your data, thus preventing you from potentially overloading your database. The available fields are:

Condense Interval -- The time interval at which the cache history is condensed for the following caches: JvmGcInfo, JvmMemoryPool, JvmOperatingSystem, JvmThreading, JvmMemory, RtvDataServerManager and RtvDataServerClientTotals caches. The default is 60 seconds.

Condense Raw Time -- The time span of raw data kept in the cache history table for the following caches: JvmGcInfo, JvmMemoryPool, JvmOperatingSystem, JvmThreading, JvmMemory, RtvDataServerManager, RtvDataServerClientTotals, TomcatWebModuleStats, TomcatGlobalRequestStats and TomcatWebModuleTotals caches. 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: JvmOperatingSystem, JvmThreading, JvmMemory, RtvDataServerManager, RtvDataServerClientTotals, TomcatWebModuleStats, TomcatGlobalRequestStats and TomcatWebModuleTotals. 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).

  • Navigate to the Solution Package Configuration > RTView Manager DATA STORAGE tab.
  • In the Compaction region, click the Condense Interval, Condense Raw Time, and Compaction Rules fields and specify the desired settings.

Note: When you click in the Compaction Rules field, the Copy default text to clipboard link appears, which allows you 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 RTView Manager Metrics

The data for each metric is stored in a specific cache and, when the data is not updated in a certain period of time, that data will either be marked as expired or, if it has not been updated for 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 caches impacted by the Expire Time field has not been updated within 45 seconds. The caches impacted by the Expire Time field are: JvmConnections, JvmGcInfo, JvmMemoryPool, JvmClassLoading, JvmCompilation, JvmOperatingSystem, JvmThreading, JvmMemory, JvmMemoryManager, JvmSystemProperties, RtvDataServerManager, RtvDisplayServerManager, RtvHistorianManager, RtvDataServerClientStats, RtvDataServerClientTotals, RtvServerVersion, TomcatWebModuleStats, TomcatConnectorInfo, TomcatGlobalRequestStats, TomcatHostInfo, and TomcatWebModuleTotals. Also, by default, if the data has not been updated for the caches impacted by the Delete Time field within 3600 seconds, it will be removed from the cache. The caches impacted by the Delete Time field are: JvmConnections, JvmGcInfo, JvmMemoryPool, JvmClassLoading, JvmCompilation, JvmOperatingSystem, JvmRuntime, JvmThreading, JvmMemory, JvmMemoryManager, JvmSystemProperties, RtvDataServerManager, RtvDisplayServerManager, TomcatWebModuleStats, TomcatGlobalRequestStats, TomcatWebModuleTotals, RtvHistorianManager, RtvDataServerClientStats, RtvDataServerClientTotals, RtvServerVersion, TomcatWebModuleStats, TomcatConnectorInfo, TomcatGlobalRequestStats, TomcatHostInfo and TomcatWebModuleTotals. To modify these defaults:

  • Navigate to the Solution Package Configuration > RTView Manager DATA STORAGE tab.
  • In the Duration region, click the Expire Time, Expire Time Long, Expire Time for Events, and Delete Time fields and specify the desired settings.

Enabling/Disabling Storage of Historical Data

The History Storage section allows you to select which metrics you want the Historian to store in the history database. By default, all supported RTView Manager historical data is saved to the database. To disable the collection of historical data, perform the following steps:

  • Navigate to the Solution Package Configuration > RTView Manager DATA STORAGE tab.
  • In the History Storage region, 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 RTView Manager 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 between data servers when you have multiple data servers with corresponding Historians using the same solution package(s) and database. In this case, each Historian needs to save to a different table, otherwise the corresponding data server will load metrics from both Historians on startup. Once you have defined the History Table Name Prefix, you will need to create the corresponding tables in your database as follows:

  • Locate the .sql template for your database under rtvapm/rtvmgr/dbconfig and make a copy of template.
  • Add the value you entered for the History Table Name Prefix to the beginning of all table names in the copied .sql template.
  • Use the copied .sql template to create the tables in your database.

Note: 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:

  • Navigate to the Solution Package Configuration > RTView Manager DATA STORAGE tab.
  • Click on the History Table Name Prefix field and enter the desired prefix name.