Oracle Coherence Monitor User Guide

Oracle Coherence Monitor

User Guide

OCM Properties
This section describes properties available for OCM. OCM 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. You can override certain OCM default settings by editing those properties. There are several property files that you might edit to configure or optimize your OCM deployment.

Modify properties in the rtview.properties file. These instructions assume you have a project directory, as described in OCM Setup. The rtview.properties file is located in your project directory. To see a sample rtview.properties file, see Sample rtview.properties File.

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.

Properties: Describes properties for modifying display behavior, such as drill-down targets.

Sample rtview.properties File

Property Format

This section describes the format for OCM properties. All OCM 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 OCM property filters are predefined and apply automatically depending on what tool is being executed:

Filter	Description
agentsender	Applies the property to the Agent sender Data Server. For example: agentsender.sl.rtview.dataserver.port=3351
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.rtvapm.ocmon.jmxsampleperiod=10000
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
maincollector	Applies the property to the main Data Collection Server. For example: maincollector.sl.rtview.alert.persistAlerts=true
mainreceiver	Applies the property to the Agent main receiver Data Server. For example: mainreceiver.sl.rtview.jmxport=8911
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

Properties

The following properties are available for OCM.

Name Description

jmxsampleperiod Specifies the time interval, in milliseconds, used for polling MBean attributes and operations executed in data attachments if no poll interval is specified in the data attachment. The default is 10000 (10 seconds).
The jmxsampleperiod property can be used to balance the overhead of requesting the data with the latency of the results. To avoid overloading systems, request data at a rate no faster than it can be produced by the system being monitored. See the Metrics Administration display to see the total time taken to obtain the JMX data.

For details about using the jmxsampleperiod property when configuring node expiration modes, see Node Expiration Mode Substitutions.

Because the Default Poll Interval is superseded by the General Update Period, the amount of time elapsed between MBean polls might be longer than the value entered. For example, if the General Update Period is 2000 milliseconds and the Default Poll Interval is 5000 milliseconds, MBean attributes and operations are polled every six seconds.

sl.rtview.alert.alertcommand Specifies to use the RTView EM Self Service Alert system in which the alertCommand is set at runtime by the sl.rtview.alert.alertcommand property. This property is used for OCM Alert Notification.

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

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.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.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.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.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
NOTE: With the use of propfilters, Java applications can have different JVM configurations.

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=$alertActionScript:my_alert_actions

Sample rtview.properties File
OCM Substitutions are configured in the rtview.properties following file.

# OC MONITOR Sample Properties File

# This file contains configuration settings for this
# instance of an OCMON application
#
# Default settings are read from the file:
# common/conf/rtvapm.properties
# followed by those in the file(s):
# <package>/conf/rtvapm.<package>.properties
# where <package> is each item in the rtvapm_package list below
# e.g. ocmon/conf/rtvapm.ocmon.properties
# Settings in this file override any default settings

#
# RTVAPM Package(s) used by this application
#
rtvapm_package=ocmon

#
# CMD Window Title
#
rtv_title=Oracle Coherence Monitor
rtv_proctag=OCMON

#############################################################
# Coherence jar classpath - replaces coherence-setup script
#
# multiple jars can be defined on the classpath one per line
# comment this out if you want to vary this <Cluster>.propeties files
#sl.rtview.cp=c:/coherence/lib/coherence.jar

##########################################
# Agent = agentsender
# Monitor = viewer [ viewer[_ds] | dataclient (-ds] | maincollector ]
# Builder = builder [maincollector + collector | dataclient (-ds] ]
# DataServer = dataserver [ maincollector] | maincollector + mainreceiver ]
# DisplayServer = displayserver [collector]
# Historian = historian [collector]

###########################################
# JVM Properties
# can be set on per application basis by means of appropriate propfilter
sl.rtview.jvm=-Xmx512m
sl.rtview.jvm=-Dtangosol.coherence.mbeans=/sl-custom-mbeans.xml
#dataclient.sl.rtview.jvm=-Xmx512m
#viewer.sl.rtview.jvm=-Xmx512m
#builder.sl.rtview.jvm=-Xmx512m
#dataserver.sl.rtview.jvm=-Xmx512m
#displayserver.sl.rtview.jvm=-Xmx512m

###########################################
# COMMAND LINE ARGS
# can be set on per application basis by means of appropriate propfilter

# for ocm
sl.rtview.cmd_line=-xmlonly

# apearance
sl.rtview.stylesheet=rtv_darkstyles,rtv_flat
#sl.rtview.stylesheet=rtv_whitestyles,rtv_flat

# Coherence (node) Member names
viewer.sl.rtview.cmd_line=-member:RTViewOCMon
builder.sl.rtview.cmd_line=-member:RTViewOCMonBuilder
dataserver.sl.rtview.cmd_line=-member:RTViewOCMonDataServer
agentsender.sl.rtview.cmd_line=-member:RTViewOCMonAgent

############################
# ALERT COLLECTOR PROPERTIES

# Alert Persistence
# enable alert persistence, set defaults for persistence properties
# to enable alert persistence for an application, set persistAlerts=true and
# give each alert engine a unique persistAlertEngineName
#
maincollector.sl.rtview.alert.persistAlerts=true
maincollector.sl.rtview.alert.persistDbName=ALERTDEFS

#
# Substitutions to control alert handling
#
sl.rtview.sub=$domainName:SL-OCMON-1

#
# Define the ALERTDEFS DB
#
# local ocmon DB
collector.sl.rtview.sql.sqldb=ALERTDEFS sa - jdbc:hsqldb:hsql://localhost:9103/alertdefs org.hsqldb.jdbcDriver - false true

##########################
# DATA SERVER PROPERTIES
#
# Default port used by dataserver
#
dataserver.sl.rtview.dataserver.port=3381
# jmx port for jmx monitoring rtv_[status|stop]
dataserver.sl.rtview.dataserver.jmxport=9911

##########################
# DATA CLIENT PROPERTIES
#
# DataServer to connect; needs to match dataserver.sl.rtview.dataserver.port setting above
#
dataclient.sl.rtview.dataserver=//localhost:3381

#
# Optional JMX ports for viewer and Builder for use with start/stop/status_rtv
#
# Note - enabling this will prevent more than one instance of each as they cannot share ports
#
viewer.sl.rtview.jmxport=8915
viewer_ds.sl.rtview.jmxport=8916

builder.sl.rtview.jmxport=8918
builder_ds.sl.rtview.jmxport=8919

#
# This form necessary to connect to http servlet
#
#dataclient.sl.rtview.dataserver=remote:http://localhost/ocmon_rtvdata

##########################
# DISPLAY SERVER PROPERTIES
#
# Default port used by displayserver
#
displayserver.sl.rtview.displayserver.port=3361
# jmx port for jmx monitoring rtv_[status|stop]
displayserver.sl.rtview.displayserver.jmxport=9912

##########################
# HISTORIAN PROPERTIES
#
# Define the RTVHISTORY DB
#
# Note that hsqldb can have poor performance with big amounts of data.
# We suggest to set an alternate database in production environments.
# To specify your database:
# - run the builder in a separate directory
# - select Tools/Options/SQL; enter your database options
# - select Save/No. The file OPTIONS.ini will be created
# - find the line containing your database options and copy it here:
#
collector.sl.rtview.sql.sqldb=RTVHISTORY sa - jdbc:hsqldb:hsql://localhost:9103/rtvhistory org.hsqldb.jdbcDriver - false true
#
historian.sl.rtview.historian.driver=org.hsqldb.jdbcDriver
historian.sl.rtview.historian.url=jdbc:hsqldb:hsql://localhost:9103/rtvhistory
historian.sl.rtview.historian.username=sa
historian.sl.rtview.historian.password=

# jmx port for jmx monitoring rtv_[status|stop]
historian.sl.rtview.historian.jmxport=9913

#########################
# Agent properties are split into agentsender (sender) + mainreceiver (receiver)
# Where the mainreceiver is the dataserver used by the rest of the system
# and the agentsender is the "Agent"
#

##########################
# MAINRECEIVER PROPERTIES
#

# Set useAgentFlag, so dataserver will not joint cluster as a node + report using OCM Agent
mainreceiver.sl.rtview.cmd_line=-ocmagent

#define external $jmx dataserver dataserver called OCMAgent
#so jmx data attatchments for coherenece get their data from a remote dataserver called OCMAgent
# rather than the defined jmxconn - sl.rtvapm.ocmon.jmxconn
mainreceiver.sl.rtview.sub:$jmxdataserver:OCMAgent

# Define how we connect to remote "agent" dataserver // but it could be any of the connection mechanisms.
# port should match sender.sl.rtview.dataserver.port=3351
#ocm.agent_port=3351
mainreceiver.sl.rtview.cmd_line=-dataserver:name=OCMAgent;connect=localhost:3351

#
# mainreceiver uses default sl.rtview.dataserver.jmxport=8911
mainreceiver.sl.rtview.jmxport=8911

#################################
# AGENTSENDER (NODE) PROPERTIES
#
# configure Agent Target here (only applies to dataagent)
#
#ocm.agent_port=3351
agentsender.sl.rtview.dataserver.port=3351
# jmx port for jmx monitoring rtv_[status|stop]
# format for start / stop
agentsender.sl.rtview.jmxport=8914
#format for port used.
agentsender.sl.rtview.dataserver.jmxport=8914
# but only if the key is one of the well defined names

#ocm.agent_log=DemoCluster_agent.log
agentsender.sl.rtview.cmd_line=-logfile:agent.log

##########################
# LOGGER PROPERTIES
#
sl.rtview.jvm=-Dcom.sl.rtview.RTVLog4jLevel=info
sl.rtview.jvm=-Dcom.sl.rtview.useLog4j=false

##########################
# WINDOWS SERVICES
#
# Example of (un)installing a data server as a Windows service
# win_run_apm_dataserver -propfilter:(un)installdata
#
#installdata.sl.rtview.cmd_line=-install_service
#installdata.sl.rtview.cmd_line=-service:OCMONdataserver
#installdata.sl.rtview.cmd_line=-dir:%RTVAPM_STARTUP%
#
#uninstalldata.sl.rtview.cmd_line=-uninstall_service
#uninstalldata.sl.rtview.cmd_line=-service:OCMONdataserver

##########################
# DATA COLLECTOR PROPERTIES

#
# OCMON JMX METRICS SAMPLE PERIOD
#
collector.sl.rtvapm.ocmon.jmxsampleperiod=10000

##################################
# Collector named JMX Connections
#
# e.g. for use in multi cluster JMX connections
#
# Template (from JMXOPTIONS.INI) for host / port jmx connections is
# maincollector.sl.rtview.jmx.jmxconn=<conn_name> <host> <port> URL:- - - 'false'

##################################
# OCM Properies
#
# taken from OPTIONS.INI

#
# Database + Database table Subs
#

#
# Various cache historys can be persisted to the database
#
# Due to the volume of data, not all are
#
# To enable a cache for peristence comment out the '' empty subs
# e.g sl.rtview.sub=$<CACHE>_TABLE:''
# and uncomment out the populated subs
# e.g sl.rtview.sub=$<CACHE>_TABLE:<CACHE>
#
# you can also limit the volume of data by disabling persitance for configured caches
# by reversing the above
#

sl.rtview.sub=$RTVHISTORY_DB:RTVHISTORY
sl.rtview.sub=$ALERTDEFS_DB:ALERTDEFS
sl.rtview.sub=$ALERTDEFS_TABLE:ALERTDEFS
#sl.rtview.sub=$ALERTDEFS_TAB_TABLE:ALERTDEFS_TAB

# New Subs for OCM cache history tables

#
# Default OCM Cache History Tables
#
sl.rtview.sub=$OCMCLUSTERSTATS_TABLE:OCM_CLUSTERSTATS
sl.rtview.sub=$OCMCACHETOTALS_TABLE:OCM_CACHETOTALS
sl.rtview.sub=$OCMSTORAGETOTALS_TABLE:OCM_STORAGETOTALS
sl.rtview.sub=$OCMCACHESERVICETOTALS_TABLE:OCM_CACHESERVICETOTALS
sl.rtview.sub=$OCMINVOCATIONSERVICETOTALS_TABLE:OCM_INVOCATIONSERVICETOTALS
sl.rtview.sub=$OCMNODETOTALS_TABLE:OCM_NODETOTALS
sl.rtview.sub=$OCMNODESTATS_TABLE:OCM_NODESTATS

#
# Optional Stats OCM Cache History Tables
#
#sl.rtview.sub=$OCMCACHESERVICESTATS_TABLE:OCM_CACHESERVICESTATS
#sl.rtview.sub=$OCMINVOCATIONSERVICESTATS_TABLE:OCM_INVOCATIONSERVICESTATS
#sl.rtview.sub=$OCMCACHESTATS_TABLE:OCM_CACHESTATS
#sl.rtview.sub=$OCMSTORAGESTATS_TABLE:OCM_STORAGESTATS

sl.rtview.sub=$OCMCACHESERVICESTATS_TABLE:''
sl.rtview.sub=$OCMINVOCATIONSERVICESTATS_TABLE:''
sl.rtview.sub=$OCMCACHESTATS_TABLE:''
sl.rtview.sub=$OCMSTORAGESTATS_TABLE:''

#
# Optional Proxy / Extend OCM Cache History Tables
#

#sl.rtview.sub=$OCMPROXYSERVICESTATS_TABLE:OCM_PROXYSERVICESTATS
#sl.rtview.sub=$OCMPROXYSERVICETOTALS_TABLE:OCM_PROXYSERVICETOTALS
#sl.rtview.sub=$OCMEXTENDCONNECTIONS_TABLE:OCM_EXTENDCONNECTIONS

sl.rtview.sub=$OCMPROXYSERVICESTATS_TABLE:''
sl.rtview.sub=$OCMPROXYSERVICETOTALS_TABLE:''
sl.rtview.sub=$OCMEXTENDCONNECTIONS_TABLE:''

#
# Optional JVM/GC/JMX OCM Cache History Tables
#

#sl.rtview.sub=$OCMJVMGCINFO_TABLE:OCM_JVMGCINFO
#sl.rtview.sub=$OCMJVMMEMORYPOOL_TABLE:OCM_JVMMEMORYPOOL
#sl.rtview.sub=$OCMJVMOPERATINGSYSTEM2_TABLE:OCM_JVMOPERATINGSYSTEM
#sl.rtview.sub=$OCMJMXMGMTDATA_TABLE:OCM_JMXMGMTDATA
#sl.rtview.sub=$OCMJMXSTATSTOTALS_TABLE:OCM_JMXSTATSTOTALS

sl.rtview.sub=$OCMJVMGCINFO_TABLE:''
sl.rtview.sub=$OCMJVMMEMORYPOOL_TABLE:''
sl.rtview.sub=$OCMJVMOPERATINGSYSTEM2_TABLE:OCM_JVMOPERATINGSYSTEM
sl.rtview.sub=$OCMJMXMGMTDATA_TABLE:''
sl.rtview.sub=$OCMJMXSTATSTOTALS_TABLE:OCM_JMXSTATSTOTALS

sl.rtview.sub=$clusterName:ClusterUnknown

sl.rtview.sub=$cacheFilter:*
#sl.rtview.sub=$cacheFilter:service=DistributedCache,name=foo,*
sl.rtview.sub=$cacheNameFormat:4*24

sl.rtview.sub=$storageFilter:*
#sl.rtview.sub=$storageFilter:service=DistributedCache,cache=foo,*

#
# OCM Cache History Size Subs
#
sl.rtview.sub=$ocmMaxNumberOfHistoryRowsSmall:100000
sl.rtview.sub=$ocmMaxNumberOfHistoryRowsMedium:200000
sl.rtview.sub=$ocmMaxNumberOfHistoryRowsLarge:300000

#
# OCM Cache Condense/Compaction Subs
#
sl.rtview.sub=$ocmCondenseRowsRawDataTimeSpan:1200
sl.rtview.sub=$ocmCondenseRowsInterval:300
sl.rtview.sub=$ocmCompactionRules:'1d - ;1M 15m'

#
# OCM Cache Condense/Compaction Subs for smaller clusters
# Where JMX Collection times < 30 seconds
#
#sl.rtview.sub=$ocmCondenseRowsRawDataTimeSpan:1200
#sl.rtview.sub=$ocmCondenseRowsInterval:60
#sl.rtview.sub=$ocmCompactionRules:'1h -;1M 15m'

#
# OCM JVM Cache Condense/Compaction Subs
#
sl.rtview.sub=$jvmCondenseRowsRawDataTimeSpan:1200
sl.rtview.sub=$jvmCondenseRowsInterval:300

#
# OCM mark time gaps (expected) interval (in seconds)
#
# Must be larger than maximum expected compaction interval
# top avoid compacted data being marked as a gap, and thus not displayed
#
sl.rtview.sub=$ocmMarkTimeGapsInterval:901

#
# Expiry Mode
# 1 = Mark // Show Expired nodes - Forever
# 3 = Mark + Delete
# // Remove nodes as they expire = Don't Show Expired Nodes
# // Remove nodes after they expire = Show Expired Nodes for a limited Time
#
# For mode = 3
# // Remove nodes as they expire = Don't Show Expired Nodes
# $ocmRowExpirationTime == $ocmRowExpirationTimeForDelete == ~2.5 * jms_update_period
# // Remove nodes after they expire = Show Expired Nodes for a limited Time
# $ocmRowExpirationTimeForDelete > $ocmRowExpirationTime , say ocmRowExpirationTimeForDelete=86400 (86400 seconds = 24 hours)
#
# For $ocmRowExpirationMode = 1
# $ocmRowExpirationTime = ~2.5 * jms_update_period
# $ocmRowExpirationTimeForDelete - ignored

# - Show Expired Nodes - Forever
#sl.rtview.sub=$ocmRowExpirationMode:1
#sl.rtview.sub=$ocmRowExpirationTime:25
#sl.rtview.sub=$ocmRowExpirationTimeForDelete:25

# - Show Expired Nodes - But Delete time After they expire
#sl.rtview.sub=$ocmRowExpirationMode:3
#sl.rtview.sub=$ocmRowExpirationTime:25
#sl.rtview.sub=$ocmRowExpirationTimeForDelete:86400

# - Don't Show Expired Nodes (Delete As they Expire)
sl.rtview.sub=$ocmRowExpirationMode:3
sl.rtview.sub=$ocmRowExpirationTime:25
sl.rtview.sub=$ocmRowExpirationTimeForDelete:25

#
#Alert Configuration Subs
#
sl.rtview.sub=$AVERAGE_MEMORY_TIME_WINDOW:86400
sl.rtview.sub=$BAD_COMMUNICATION_NODES_TIME_RANGE:300
sl.rtview.sub=$NODES_DEPARTED_TIME_WINDOW:600

#
# Super Size Cluster Subs
#
sl.rtview.sub=$coherenceGlobalDomain:Coherence
sl.rtview.sub=$coherenceLocalDomain:Coherence

#
# Initial cluster connection
#
sl.rtview.sub=$cluster_conn none

########################################
# OCM Cluster Configuration Parameters
# taken from cluster.properties
# Note prefix sl.rtview.ocm -> sl.rtvapm.ocmon
#
# Specify whether OCM should connect as a node or not
sl.rtvapm.ocmon.node=true

# multi cluster
#sl.rtvapm.ocmon.jmxconn=*
#maincollector.sl.rtview.jmx.jmxconn=sim9097 localhost 9097 URL:- - - 'false'
#maincollector.sl.rtview.jmx.jmxconn=sim9098 localhost 9098 URL:- - - 'false'
#maincollector.sl.rtview.jmx.jmxconn=sim9099 localhost 9099 URL:- - - 'false'

# Coherence Cluster configuration settings
# These are used if sl.rtvapm.ocmon.node=true
# Specify Coherence parameters for connecting as a node
# These are the most commonly used parameters; see end of file for complete list
tangosol.coherence.cluster=MyClusterName
tangosol.coherence.wka=

#tangosol.coherence.wka.port=11078
#tangosol.coherence.localport=11078
tangosol.coherence.cacheconfig=mydemocaches.xml
tangosol.coherence.management.refresh.policy=refresh-expired
tangosol.coherence.management.refresh.expiry=500

# These are used if sl.rtvapm.ocmon.node=false
# Specify parameters for connecting via JMX host and port
#sl.rtvapm.ocmon.jmxhost=localhost
#sl.rtvapm.ocmon.jmxport=9971

# - use a Collector named JMX Connection defined above
#sl.rtvapm.ocmon.jmxconn=<connection_name>
# for multi cluster jmxconn= *
# sl.rtvapm.ocmon.jmxconn=*
#
# Specify parameters for connecting via JMX RMI
# Comment the JMX host and port properties if using RMI
#sl.rtvapm.ocmon.jmxurl=service:jmx:rmi://localhost:3000/jndi/rmi://localhost:9000/server

#
# JMX TABLES
#
# was
# ocm.use_jmxtables=[false|true]
# uncomment line below when ocm.use_jmxtables=true
# maincollector.sl.rtview.cmd_line=-ocjmxtables

#
# FAST JMX
#
# was
# ocm.use_fastjmx=[false|true]
# uncomment line below when ocm.use_fastjmx=true
# maincollector.sl.rtview.cmd_line=-fastjmx

#
# LOGGING
#
# logging is provided by the rtvapm framework
# Uncomment/edit the properties below to
# override the default values in conf\rtvapm.properties

#
# Location and name of log file for dataserver
#
#dataserver.sl.rtview.cmd_line=-logfile:dataserver.log
#dataserver.sl.rtview.cmd_line=-logdir:logs

#
# Location and name of log file for displayserver
#
#displayserver.sl.rtview.cmd_line=-logfile:displayserver.log
#displayserver.sl.rtview.cmd_line=-logdir:logs

#
# Location and name of log file for historian
#
#historian.sl.rtview.cmd_line=-logfile:historian.log
#historian.sl.rtview.cmd_line=-logdir:logs

#-----------------------------------------------------------------------------
# The list of Coherence properties available for use in this file:
#tangosol.coherence.cluster=
#tangosol.coherence.clusteraddress=
#tangosol.coherence.clusterport=
#tangosol.coherence.override=
#tangosol.coherence.edition=
#tangosol.coherence.mode=
#tangosol.coherence.wka=
#tangosol.coherence.wka.port=
#tangosol.coherence.localhost=
#tangosol.coherence.localport=
#tangosol.coherence.cacheconfig=
#tangosol.coherence.management.refresh.policy=
#tangosol.coherence.management.refresh.expiry=
#tangosol.pof.enabled=
#tangosol.pof.config=
#tangosol.coherence.ttl=

#
# Addtional tangosol.* properties will be set as system properties
#

RTView contains components licensed under the Apache License Version 2.0.

JMS, JMX and Java are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. They are mentioned in this document for identification purposes only.

SL, SL-GMS, GMS, RTView, SL Corporation, and the SL logo are trademarks or registered trademarks of Sherrill-Lubinski Corporation in the United States and other countries. Copyright © 1998-2013 Sherrill-Lubinski Corporation. All Rights Reserved.

Name	Description
jmxsampleperiod	Specifies the time interval, in milliseconds, used for polling MBean attributes and operations executed in data attachments if no poll interval is specified in the data attachment. The default is 10000 (10 seconds). The jmxsampleperiod property can be used to balance the overhead of requesting the data with the latency of the results. To avoid overloading systems, request data at a rate no faster than it can be produced by the system being monitored. See the Metrics Administration display to see the total time taken to obtain the JMX data. For details about using the jmxsampleperiod property when configuring node expiration modes, see Node Expiration Mode Substitutions. Because the Default Poll Interval is superseded by the General Update Period, the amount of time elapsed between MBean polls might be longer than the value entered. For example, if the General Update Period is 2000 milliseconds and the Default Poll Interval is 5000 milliseconds, MBean attributes and operations are polled every six seconds.
sl.rtview.alert.alertcommand	Specifies to use the RTView EM Self Service Alert system in which the alertCommand is set at runtime by the sl.rtview.alert.alertcommand property. This property is used for OCM Alert Notification.
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
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.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.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.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.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 NOTE: With the use of propfilters, Java applications can have different JVM configurations.
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=$alertActionScript:my_alert_actions