RTView EM Properties
This section describes properties available
for EM. RTView EM configuration is specified using a series of
properties. Properties can be specified in the command line, in properties
files, or in a properties database. However, the most convenient way from a
maintenance perspective is to create your own properties files, or edit the
properties files
in
your project
directory
(the directory you created per instructions
in Configure Central Servers).
You can override certain EM default settings by editing properties. There are several property files that you might edit to configure
or optimize your EM deployment. Typically,
to apply property settings:
- to a single Solution Package, modify
properties in the Solution Package directory:
project
directory/servers/<package_name> (in which the Solution Package-specific rtview.properties file
resides, as well as other Solution Package-specific property files)
- globally to Solution Packages, modify
properties up one level, in the directory:
project
directory/servers
- to EM processes,
modify properties in the directory:
project
directory/servers/central (in which the rtview.properties file
and the central.properties file reside); and the project
directory/conf directory,
(in which the emcommon.properties
file resides)
- global alert notification (across all
Solution Packages), modify properties in rtvapm.properties.
NOTE: The property file locations differ for
custom deployments.
To set properties as
command line options
use
an
initialized command window.
Options specified on the
command line are applied last, therefore command line arguments override values
saved in configuration files (such as .properties files).
Also, in many cases the command-line option
cannot be used as a property,
or vice versa.
For these reasons, we recommend that you use properties rather than
command line
options.
To specify a property in the command line:
- Add
a dash (-) at the beginning.
-
Remove the prefix (sl.rtview.).
- Remove the
propfilter prefix if present (for example,
displayserver.).
-
Replace the
colon (:) with an equals sign (=).
For example, the property
myprefix.sl.rtview.someflag=true is -someflag:true as a command
line option.
If a command line argument contains a space or a semicolon, the entire
argument must be enclosed in quotes (e.g.:
"-sub:$data:my Data").
This section includes:
- Property Format:
Describes property format, filters and naming conventions.
- General
Properties:
Describes properties for modifying display behavior, such as drill-down
targets.
-
Substitutions:
Describes substitutions available for
modifying display behavior.
Property Format
This section describes the format for EM
properties. All EM properties have the prefix sl.rtview which is followed
by a property name = value pair:
sl.rtview.<property_name>=:<value>.
For example, to specify the Data Server port number
globally:
sl.rtview.dataserver.port=3278
Property Filters
Filters are available to apply
limit the scope to which a property is applied.
Filters
precede the
sl.rtview property
prefix followed by a period (.): <property_filter>.sl.rtview.<property_name>=:<value>.
For example, to specify the Data Server port number to only proxy clients, we
use the proxyclient
filter:
proxyclient.sl.rtview.dataserver.port=3278
The
following EM property filters are predefined and apply automatically depending
on what tool is being executed:
|
Filter |
Description |
|
builder |
Applies the property to the Display Builder. For example:
builder.sl.rtview.stylesheet |
|
collector |
Applies the property to the Data Collection Server. For example:
collector.sl.rtview.jmx.jmx_metrics_period=15000 |
|
dataserver |
Applies the property to the Data Server. For example:
dataserver.sl.rtview.dataserver.socket=true |
|
displayserver |
Applies the property to the Display Server. For example:
displayserver.sl.rtview.displayserver.port=3079 |
|
historian |
Applies the property to the Historian. For example:
historian.sl.rtview.historian.driver=org.hsqldb.jdbcDriver |
|
proxyclient |
Applies the property to the proxy client. For example:
proxyclient.sl.rtview.dataserver.port=2078 |
|
rtvanalyzer |
Applies the property to the RTView Analyzer. For example:
rtvanalyzer.sl.rtview.stylesheet=rtv_default,rtv_flat |
|
viewer |
Applies the property to the Display Viewer. For example:
viewer.sl.rtview.panelconfig=custom_panels.xml |
You can define your own property filters and use
them as prefixes in your properties files. To select a property filter on the
command line use the -propfilter argument. For example, to apply the
AlertCollector filter:
-propfilter:AlertCollector
General Properties
The following properties are available for RTView EM.
| Name |
Description |
| sl.rtview.cache.config |
Specifies a cache definition file. To load several
cache definition files this property can be specified multiple times. New
properties do not override previous values, they instead add one more file to
the list.
Example:
collector.sl.rtview.cache.config=bird_cache.rtv |
|
sl.rtview.cmd_line |
Specifies options on the command line.
When a new instance of this property is specified, the pre-existing values are
not overridden. New properties concatenate its value to the command line. You
can specify any valid command line option with a few exceptions. For example,
you cannot add a new properties file with -properties, or add a property
filter with -propfilter from within a property file. Example:
displayserver.sl.rtview.cmd_line=-logfile:displayserver.log |
|
|
log4j |
Specifies to use Log4j
as the default log engine for RTView EM processes
(the Data Server, Historian, Viewer and Display Server). To set
Log4j as the default, edit the rtvapm.properties
file, located in your project directory/conf
directory and the central.properties file, located in your project directory/servers/central
directory as follows:
Uncomment the following lines in both files:
#sl.rtview.cmd_line=-logfile:
#sl.rtview.cmd_line=-logdir:
#sl.rtview.jvm=-Dcom.sl.rtview.useLog4j=true
On UNIX, comment out the command line for
Windows:
#sl.rtview.cmd_line=-log4jprops:%RTVAPM_HOME%/common/conf/sl.log4j.properties
And uncomment the command line for
UNIX:
sl.rtview.cmd_line=-log4jprops:$RTVAPM_HOME/common/conf/sl.log4j.properties
Open the log file,
located in your project directory/conf
directory, and verify the file content is similar to the following:
10:18:35,342 INFO rtv_file - [rtview] Log4j is being used with
project directory/conf/sl.log4j.properties as the configuration file.
NOTE: To verify whether
Log4j is currently
the default log engine, execute a start script (for
example, start_rtv). If Log4j is not
you see content similar to the following in
the log file:
2013-06-12 10:05:13.968 [rtview] Logging
redirected for System.out and System.err. Log4j is not in use.
|
|
sl.rtview.dataserver |
Specifies the default Data Server to connect
to. This setting must match the Data Server port setting specified for the
dataserver.sl.rtview.dataserver.port
property. The default is //localhost:3278.
Example:
dataclient.sl.rtview.dataserver=//localhost:3278
This property can also specify a named Data Server
to connect to. The port used must match the port specified in the Data Server we
are to connect to.
Example:
sl.rtview.dataserver=name=MISCMON-LOCAL;connect=//localhost:10123 |
|
sl.rtview.dataserver.port |
Specifies the Data Server port for client
connections. This setting must match the data client connection port setting
specified for the
dataclient.sl.rtview.dataserver
property. The default is 3278.
Example:
dataclient.sl.rtview.dataserver=3278 |
|
sl.rtview.dsenable |
Specifies the data source to enable.
Example:
proxyclient.sl.rtview.dsenable=cache |
|
sl.rtview.historian.charlimit |
Specifies the maximum number of characters per table
column for the Historian (RTVHISTORY) database.
The default is 255. Example:
historian.sl.rtview.historian.charlimit=255 |
|
sl.rtview.historian.compactiontimerinterval |
Specifies how often, in seconds, the aggregation
engine checks for data to aggregate in the Historian (RTVHISTORY) database.
The default is 5. Data aggregation reduces the amount of aged data stored
in the Historian cache table.
Example:
historian.sl.rtview.historian.compactiontimerinterval=5 |
|
sl.rtview.historian.compactionverbose |
Specifies for the Historian (RTVHISTORY) database
whether and how to output to the console. The default is 0. There are
three options:
0 - No information is output to the console.
1 - Summary information is output to the console.
2 - Debug-level information is output to the console.
Example:
historian.sl.rtview.historian.compactionverbose=0 |
|
sl.rtview.historian.driver |
Specifies the Historian (RTVHISTORY) database. Not enabled, by default. Use this
property to change the default HSQLDB database (used for evaluation purposes) to
a production Historian database.
Example:
sl.rtview.historian.driver=org.hsqldb.jdbcDriver
NOTE: To enable the database, uncomment this
property in the emcommon.properties file.
|
|
sl.rtview.historian.index_history_tables |
Specifies whether to add indices when creating
tables in the Historian (RTVHISTORY) database. true adds indices and
false does not add indices. The default is true.
Example:
historian.sl.rtview.historian.index_history_tables=true |
|
sl.rtview.historian.noreset |
Specifies whether to
clear the
Historian (RTVHISTORY) database tables
before storing new data. true does not
clear the tables and false does clear the tables. The default is true.
Example:
historian.sl.rtview.historian.noreset=true |
|
sl.rtview.historian.password |
Specifies the password for accessing the
Historian (RTVHISTORY) database. When no characters are entered (for example, historian.sl.rtview.historian.password=)
the password is blank, which is also a valid password. Valid values are
according to the database engine.
Example:
historian.sl.rtview.historian.password=99thPassword |
|
sl.rtview.historian.url |
Specifies the Historian (RTVHISTORY) database URL.
Not enabled, by default. Use this property to change the default HSQLDB database
(used for evaluation purposes) to a production database.
Example:
sl.rtview.historian.url=jdbc:hsqldb:hsql://localhost:9099/rtvhistory
NOTE: To enable the database, uncomment this
property in the emcommon.properties file.
|
|
sl.rtview.historian.username |
Specifies the Historian (RTVHISTORY) database user
login password.
Not enabled, by default. Valid values are according to the database engine.
Example:
sl.rtview.historian.username=sa |
|
sl.rtview.historian.verbose |
Specifies whether to print a line to the console for
each record that is stored in the Historian (RTVHISTORY) database. true
prints a line for each record and false does not. The default is false.
Example:
historian.sl.rtview.historian.verbose=false |
|
sl.rtview.jmx.jmx_mbeans_change_dynamically |
Specifies whether to assume the JMX MBean
attribute structure does not change dynamically. true specifies to not assume
dynamic change. false specifies to assume dynamic change. The default is false.
Example:
sl.rtview.jmx.jmx_mbeans_change_dynamically=false |
|
sl.rtview.jmx.jmx_metrics_period |
Specifies how often, in milliseconds, JMX MBean
methods are executed. Default is 10000.
NOTE: Because the MBean Method Execution Interval is superseded by the General
Update Period, the amount of time elapsed between method executions may be
longer than the value entered. For example, if the General Update Period is 2000
milliseconds and the MBean Method Execution Interval is 5000 milliseconds, MBean
methods will be executed every six seconds.
Example:
sl.rtview.jmx.jmx_metrics_period=10000 |
|
sl.rtview.jmx.jmx_minreconnecttime |
Specifies the amount of time that elapses, in
seconds, before JMX attempts to reconnect. Default is 30.
Example:
sl.rtview.jmx.jmx_minreconnecttime=30 |
|
sl.rtview.jmx.jmxconn |
Specifies the JMX data connection. The default is
local - - 'URL:local' - - false. Specify
the connection name, host, port, user name and password.
Example:
-jmxconn:Myconnection host1 9998 |
|
sl.rtview.jmx.jmxdsShowConnectionOnlyOnMultiples |
Specifies whether to add a JMX Connection
column when an asterisk (*) is used to reference multiple connections. true specifies to add a JMX Connection column.
false specifies
to not add a JMX Connection column.
The default is true.
Example:
sl.rtview.jmx.jmxdsShowConnectionOnlyOnMultiples=true |
|
sl.rtview.jvm |
Specifies command line options for the Java
Virtual Machine. For example, to allocate additional heap memory.
Examples:
displayserver.sl.rtview.jvm=-Djava.awt.headless=true
dataserver.sl.rtview.jvm=-Xmx768m
dataserver.sl.rtview.jvm=-Xms128m |
| sl.rtview.sql.dbretry |
Specifies the amount of time, in seconds, between
attempts to reconnect to the database. The default is 40000.
Example:
sl.rtview.sql.dbretry=40000 |
| sl.rtview.stylesheet |
Specifies a list of RTView Style definition files
that determine the appearance of RTView displays (text sizes, fonts, colors and
so forth). The default is
rtv_darkstyles,rtv_flat.
Example:
sl.rtview.stylesheet=rtv_darkstyles,rtv_flat |
|
sl.rtview.sub |
Specifies to use a substitution. For details, see
Substitutions.
Example:
sl.rtview.sub=$rtvAlertMaxNumberOfHistoryRows:50000 |
Substitutions
The following substitutions can be set to modify
your EM configuration and EM display behavior. There are different ways you can
set a substitution, but the preferred way is to use the
sl.rtview.sub
property.
| Name |
Description |
|
$alertActionScript |
Specifies the name of the script to execute
for an alert command, without
the extension. This name is combined with the value of $scriptEnding to
form the complete name of the script.
Example:
sl.rtview.cmd_line=-sub:$alertActionScript:my_alert_actions |
|
$domainName
|
Specifies a domain name to be used by the alert commands. Use this substitution
on any Data Server that generates alerts to identify the source of the alert.
Usually each Solution Package defines its own domain name.
Example:
sl.rtview.sub=$domainName:mydomainname
|
|
$jmxdataserver |
Specifies the name of the JMX Data Server. The default is ProxyDataServer.
Example:
proxyclient.sl.rtview.sub=$jmxdataserver:ProxyDataServer |
|
$proxydataserver |
Specifies the name of the proxy Data Server. The default is ProxyDataServer.
Example:
proxyclient.sl.rtview.sub=$proxydataserver:ProxyDataServer |
|
$RTV_ALERTS_CURRENT_TABLE |
Specifies the name of the current alerts database table. The default is
RTV_ALERTS_CURRENT.
Use this substitution in conjunction with the
RTV_ALERTS_TABLE substitution to turn on
alert history.
Example:
sl.rtview.sub=$RTV_ALERTS_CURRENT_TABLE:RTV_ALERTS_CURRENT
|
|
RTV_ALERTS_TABLE |
Specifies the name of the alert database table. The default is
RTV_ALERTS.
Use this substitution in conjunction with the
RTV_ALERTS_CURRENT_TABLE
substitution to turn on alert history.
Example:
sl.rtview.sub=$RTV_ALERTS_TABLE:RTV_ALERTS
|
|
$RTV_JMXSTATSTOTALS_TABLE |
Specifies the JMX table name. The default is
RTV_JMXSTATSTOTALS.
Example:
sl.rtview.sub=$RTV_JMXSTATSTOTALS_TABLE:RTV_JMXSTATSTOTALS |
|
$rtvAlertHistoryColumnNames |
Specifies to add columns to the alert history table. Provide column names in a
semicolon (;) delimited list. The default is ;Comments.
Example:
sl.rtview.sub=$rtvAlertHistoryColumnNames:;Comments |
|
$rtvAlertMaxNumberOfHistoryRows |
Specifies the maximum number of rows to store in the alerts cache. The default is 50000.
Example:
sl.rtview.sub=$rtvAlertMaxNumberOfHistoryRows:50000 |
|
$rtvAlertPackageMask |
Specifies a regular expression to only show alerts
in the Alert Administration display for Packages that match the specified
mask. Use this substitution to display alerts for one or more Solution Package. The default is ",
which specifies
to show all alerts
in the Alert Administration display.
Example to display only WebLogic alerts:
sl.rtview.sub=$rtvAlertPackageMask:Wls
Example
to display only WebLogic and JVM alerts:
sl.rtview.sub=$rtvAlertPackageMask:^Wls|^Jvm
Example:
sl.rtview.sub=$rtvAlertPackageMask:'' |
|
$RTVCONFIG_CITYPE_ALERTMAP_TABLE |
Specifies the alert table name in the CI database. The default is
'CITYPE_ALERTMAP'.
Example:
sl.rtview.sub=$RTVCONFIG_CITYPE_ALERTMAP_TABLE:'CITYPE_ALERTMAP' |
|
$RTVCONFIG_CITYPE_CACHEMAP_TABLE |
Specifies the CI Type table name in the CI database. The default is
'CITYPE_CACHEMAP'.
Example:
sl.rtview.sub=$RTVCONFIG_CITYPE_CACHEMAP_TABLE:'CITYPE_CACHEMAP' |
|
$RTVCONFIG_CITYPE_DEFS_TABLE |
Specifies the CI Type definitions table name in the CI database. The default is
'CITYPE_DEFS'.
Example:
sl.rtview.sub=$RTVCONFIG_CITYPE_DEFS_TABLE:'CITYPE_DEFS' |
|
$RTVCONFIG_DB |
Specifies the name of the CI database. The default is ".
Example:
sl.rtview.sub=$RTVCONFIG_DB:'' |
|
$RTVHISTORY_DB |
Specifies the name of the Historian database table. The default is
RTVHISTORY.
Use this substitution in conjunction with the
RTV_ALERTS_TABLE substitution and the
RTV_ALERTS_CURRENT_TABLE
substitution to configure
Historian database tables.
Example:
sl.rtview.sub=$RTVHISTORY_DB:RTVHISTORY |
|
$rtvNavAppDisplayName
|
Specifies the drill-down target from heatmaps and tables in
All Management Areas, Multi Area Service Views and Single Area
Service Views displays. By default, these heatmaps and tables drill-down to
the Service By CI Type (rtv_service_citype_summary.rtv)
display. Other possible values are rtv_app_summary.rtv,
or the file name of your own custom display (if one is available).
Example:
sl.rtview.sub=$rtvNavAppDisplayName:rtv_service_citype_summary.rtv |
|
$rtvNavAppRightClickActionFlag
|
Specifies drill-down behavior
for heatmaps and tables.
Set to 1 to enable drill-down on a double-click. Set to 0
allow drill-down on a single-click. The default is 0.
Example:
sl.rtview.sub=$rtvNavAppRightClickActionFlag:1
|
|
$rtvNavBackEnabledFlag |
Specifies whether to make the back button visible in
the Display Viewer, Display Server and the Display
Builder. 0 specifies to make the back button invisible.
1 specifies to make the back button visible.
The default is 1.
Example:
sl.rtview.sub=$rtvNavBackEnabledFlag:1 |
|
$rtvShowDataServerColumn |
Specifies whether to display the
Data Server column in
Service Summary
display, where 1 specifies to show the column and 0 specifies to hide the
column. Example:
sl.rtview.sub=$rtvShowDataServerColumn:1 |
|
$rtvUserShowDualTables |
Adds a second table at the bottom
of the Alerts Table display. This table
shows all open (not cleared)
alerts owned by the logged in user. Filters in this display do not apply to this
table.
You can specify this substitution per-user or per-role if the
RTView login is enabled and custom users or roles are defined. For
details, see the Configure Role Management.
By default, this enhanced table is hidden. To show this
table, add the following line to the rtview.properties file in the
directory where you run the Viewer or Display Server:
sl.rtview.sub=$rtvUserShowDualTables:1 |
|
$scriptEnding |
Specifies the suffix of the script called for an alert command.
Typically, it is set to bat on Windows systems and sh on Linux.
The default is bat.
Example:
sl.rtview.cmd_line=-sub:$scriptEnding:bat |
|
