6 Properties

This chapter describes the property files delivered to the cfg subdirectory when Oracle GoldenGate Monitor and Oracle GoldenGate core are installed. These files contain settings that control the monitoring process. Some property values are preset based on the release of the software and some are set by the installer based on user entries.

This chapter includes the following sections:

• Monitor Server Properties

• Agent Properties

6.1 Monitor Server Properties

The monitor.properties file describes the characteristics of Oracle GoldenGate Monitor processing. It includes properties to define the relationship with the JMX server and the timing for connection attempts. Many of these property values are initially set based on user entries during installation.

Note:

After you change a property value, you must restart the Monitor Server to activate it.

6.1.1 Restricted Properties

Certain Oracle GoldenGate Monitor properties can cause the system to malfunction if changed. These properties are designated as restricted. You should not change the preset values for restricted properties.

Restricted properties include:

monitor.jmx.internal.mbeans.enabled
monitor.supported.agent.metadata.versioneclipselink.target-database
eclipselink.weaving
eclipselink.ddl-generation

6.1.2 SSO Web Parameters

The SSO web parameters specifies the SSO (Single Sign On) log out URL. If Oracle GoldenGate Monitor is accessed in SSO environment, then monitor.ssoLogOutUrl is used to set the log out URL for the application. If the log out URL format for subsequent OAM (Oracle Access Manager) version changes, then this property has to be modified accordingly. However, server restart is not required in such an event.

The syntax is as follows:

monitor.ssoLogOutUrl=/oamsso/logout.html?end_url=/monitor

6.1.3 JMX Server Properties

These properties enable the JMX server, identify the user name, and register the name and port of the JMX server host.

6.1.3.1 monitor.jmx.server.enabled

Use monitor.jmx.server.enabled to enable or disable the JMX server. The JMX server must be enabled to allow the Jagent to register with the Oracle GoldenGate Monitor Server. The value is initially set to true to allow the agent to register.

Default

true

Syntax

monitor.jmx.server.enabled={true | false}

6.1.3.2 monitor.jmx.server.port

Use monitor.jmx.server.port to specify the JMX server port number. The value is initially set by the installer based on user entries. This must match the monitor.jmx.port entry in the agent's Config.properties file.

Syntax

monitor.jmx.server.port=port_number

Example

monitor.jmx.server.port=5502

6.1.3.3 monitor.jmx.server.host

Use monitor.jmx.server.host property to specify the computer name of the Oracle GoldenGate Monitor installation.

Syntax

Set monitor.jmx.server.host property to the fully qualified host name of the server for the Oracle GoldenGate Monitor installation. This must match the monitor.host entry in the agent's Config.properties file. The value is initially set by the installer based on user entries.

monitor.jmx.server.host=host_name

6.1.3.4 monitor.jmx.server.user

Use monitor.jmx.server.user to specify the user name to use when communicating with the JMX server. The value is initially set by the installer based on user entries. This must match the monitor.jmx.username entry in the agent's Config.properties file.

Syntax

monitor.jmx.server.user=user_name

Example

monitor.jmx.server.user=oggmsjmxusr

6.1.4 Communication

You must select whether the communication will use SSL or not. If you use SSL, you need to identify the storage for the keys and certificates.

6.1.4.1 monitor.ssl

Use monitor.ssl to specify whether or not the communication from Oracle GoldenGate Monitor will use SSL.

Note:

The monitor.ssl setting for Oracle GoldenGate Monitor Server must match the jagent.ssl property settings in the Configuration.properties file of all agents that communicate with the server.

Default

false

Syntax

monitor.ssl=[true | false]

6.1.4.2 monitor.keystore.file

Use monitor.keystore.file to identify the file that stores the key pairs and certificates used for SSL authentication.

Default

monitorKeyStore

Syntax

monitor.keystore.file=keystore_filename

6.1.4.3 monitor.truststore.file

Use monitor.truststore.file to store trusted certification authority (CA) certificates that verify the identity of other clients or servers.

Default

jagentKeyStore

Syntax

monitor.truststore.file=truststore_filename

6.1.5 Connection Properties

These properties define characteristics of the connections. They can be changed, but it is recommended that you first consult with Oracle Support. For more information go to http://support.oracle.com.

6.1.5.1 monitor.default_agent_connection.max_attempts

Use monitor.default_agent_connection.max_attempts to specify the number of unsuccessful connections before the process will stop attempting to connect. An entry of 0 or a negative number specifies no limit on the number of times the connection should be tried. The value is initially set to 10.

Syntax

monitor.default_agent_connection.max_attempts=number

Example

monitor.default_agent_connection.max_attempts=0

6.1.5.2 monitor.default_agent_connection.reconnect_interval

Use monitor.default_agent_connection.reconnect_interval to specify the number of seconds to wait after an existing connection is broken before an attempt is made to reconnect. The value is initially set to 5.

Syntax

monitor.default_agent_connection.reconnect_interval=seconds

Example

monitor.default_agent_connection.reconnect_interval=5

6.1.5.3 monitor.default_agent_connection.interval

Use monitor.default_agent_connection.interval to specify the number of seconds to wait between each unsuccessful attempt to connect. The value is initially set to 30.

Syntax

monitor.default_agent_connection.interval=seconds

Example

monitor.default_agent_connection.interval=30

6.1.5.4 monitor.web.rendering_interval

The monitor.web.rendering_interval property is used for Interval Renderer in seconds. To disable interval renderer set to 0.

Default

15 seconds

Syntax

monitor.web.rendering_interval=no_of_seconds

6.1.5.5 eclipselink.ddl-generation

Use the eclipselink.ddl-generation property to create database objects on server re-start if the administrator wants to re-point the server install to a new database.

Syntax

eclipselink.ddl-generation=create-tables

6.1.5.6 eclipselink.target-database

Use the eclipselink.target-database property to provides pointer to eclipselink to use the appropriate dialect according to the target database,

Default

This property underlines the database that eclipselink will be talking to.

Syntax

eclipselink.target-database=org.eclipse.persistence.platform.database.OraclePlatform. In case of SQL Server, the syntax is: eclipselink.target-database=org.eclipse.persistence.platform.database.SQLServerPlatform.

6.1.5.7 eclipselink.weaving

The eclipselink.weaving property is used to set a mode for

Default

Static

Syntax

eclipselink.weaving=static

6.1.6 Configuration Management Properties

These properties set the timeout value and the threshold number of events to trigger processing.

6.1.6.1 monitor.cm.event.timeout

Use monitor.cm.event.timeout to specify the time in milliseconds for the solution discovery process to wait between inquiries for new agents registered with the Oracle GoldenGate Monitor Server. The solution discovery process starts if a new agent is found. The value is initially set to 2000 milliseconds.

Syntax

monitor.cm.event.timeout=milliseconds

6.1.6.2 monitor.cm.event.max.size

Use monitor.cm.event.max.size to specify the threshold number of events that triggers the solution discovery process not to wait monitor.cm.event.timeout seconds before processing the remaining events. The value is initially set to 1000 events.

Syntax

monitor.cm.event.max.size=number_events

6.1.6.3 monitor.events.dispatcher.threads_size

Use monitor.events.dispatcher.threads_size to specify the number of threads that will be used by the events dispatcher process. The value is initially set to 30.

Syntax

monitor.events.dispatcher.threads_size=number

Example

monitor.events.dispatcher.threads_size=30

6.1.6.4 monitor.max.mpevent.before.refresh

Use monitor.max.mpevent.before.refresh to modify the refresh rates in the User Interface. monitor.max.mpevent.before.refresh=default means no lag in refresh rate. The value indicates number of events must be reached before User Interface can refresh.

Syntax

monitor.max.mpevent.before.refresh=number_of_events

Note:

This property is applicable in Oracle GoldenGate Monitor 12.2.1.2.181115+ bundle patch only.

Note:

To monitor 300 processes, Oracle recommends this value to be 100.

6.1.6.5 monitor.refresh.landing.page

Use monitor.refresh.landing.page to do an auto refresh based on seconds for the Process Metrics tab page of an Instance, and Metrics tab page of a process.

Syntax

monitor.refresh.landing.page=default

monitor.refresh.landing.page=default means no auto refresh of Process Metrics and Metrics tabs.

Note:

This property is applicable in Oracle GoldenGate Monitor 12.2.1.2.181115+ bundle patch only.

6.1.6.6 monitor.disable.solution

Use monitor.disable.solution to turn on/off solution function. After setting this property to true, the solution function stops working and the Solutions sub menu disappears from the UI.

Syntax

monitor.disable.solution=true

6.1.6.7 monitor.landing.page.treeview

Use monitor.landing.page.treeview to configure the display layout of tree structure navigation in Oracle GoldenGate Monitor UI. The value default makes each tree node expanded. The value level-1 makes node expansion stop at first level, which is the Hosts/Solutions/Views icon.

Syntax

monitor.landing.page.treeview=default

6.1.6.8 monitor.debug.backendqueue.interval

Use monitor.debug.backendqueue.interval to specify the time interval that the debug thread will wait to get various metrics of monitor queues operation. Time unit is second. The default value zero disables the debug thread. A positive numeric value enables the debug thread and make it run periodically as the value defined. A negative numeric value also disables the debug thread. The monitored metric info will be logged in the monitor log.

Syntax

monitor.debug.backendqueue.interval=<time in seconds>

Default

0

6.2 Agent Properties

Some of the properties have default values that are used when a value for the property is not defined in the property file. Default values are not substituted for invalid entries. A message is written to the jagent.log and the ggserr.log when a default value is used.

The Config.properties file configures an Oracle GoldenGate Monitor Agent for communication with the Oracle GoldenGate Monitor Server or Oracle Enterprise Manager (Oracle GoldenGate release 11.2.1 or later). It contains preset properties delivered with the Oracle GoldenGate core installation. Values such as host server names, ports, and users must be reset to valid values for your system.

Note:

After you change a property value, you must restart the agent to activate it.

6.2.1 Agent Definition

You must set the type of agent that will be used to monitor the Oracle GoldenGate instance.

6.2.1.1 jmx.broker.port

Use the jmx.broker.port parameter for remote JMX server monitoring, and it is only applicable when jmx.enable.remote.monitoring is true. jAgent will internally use the broker port for remote JMX monitoring.

If the network is protected by firewall, then both jmx.broker.port and jagnet.jmx.port (in OGGMON mode) or jagent.rmi.port (in OEM mode) must be allowed through firewall. It can take any valid open port value. If the value of property jmx.enable.remote.monitoring is true and jmx.broker.port is not provided or its value is given as default then it takes jagent.jmx.port (in OGGMON mode) or jagent.rmi.port (in OEM mode) as the jmx.broker.port.

Default

default

Syntax

jmx.broker.port=port_number

Example

jmx.broker.port=default 
jmx.broker.port=12345 

6.2.1.2 jmx.enable.remote.monitoring

The jmx.enable.remote.monitoring is used to enable remote monitoring for jAgent JMX server. If the value is false, then the remote connection to jAgent JMX server is not allowed.

Default

true

Syntax

jmx.enable.remote.monitoring=true

6.2.1.3 jagent.restful.ws.timeout

Use jagent.restful.ws.timeout to set the Jagent RESTful Web Service timeout in milliseconds.

Default

15000

Syntax

jagent.restful.ws.timeout=number

6.2.1.4 jagent.ggsci.timeout

Use jagent.ggsci.timeout to set the Jagent GGSCI timeout in seconds.

Default

30

Syntax

jagent.ggsci.timeout=number

6.2.1.5 continuous.alerts

When the condition of an alert is set for process not running, an alert is triggered when this process goes down. By default, no more alert is triggered as long as the process remains down, even when the alert suppression time is reached. If the user wishes to continuously receive alerts at every suppression interval, set the continuous.alerts parameter to true.

Syntax

continuous.alerts=true

6.2.1.6 jagent.large.deployment.threshold

The jagent.large.deployment.threshold value defines the threshold value of the Oracle GoldenGate processes the Agent is monitoring that is considered as large deployment. After the number of processes is equal or greater than the threshold, the jAgent automatically switches to a Large Deployment Mode.

In a Large Deployment mode, the jAgent creates a batch for all the monitoring objects rather than the previous behavior of creating only one monitoring object. This reduces the calls between the server and agent and increases the efficiency of the batch processing.

Syntax

jagent.large.deployment.threshold=Number_of_processes

Default

10

Example

jagent.large.deployment.threshold=5

6.2.1.7 agent.type.enabled

Use agent.type.enabled to specify whether monitoring will be done in Oracle GoldenGate Monitor or Oracle Enterprise Manager.

The Oracle GoldenGate Monitor Agent polls Manager at configurable intervals to collect monitoring points data.

• Setting agent.type.enabled to OGGMON causes the Oracle GoldenGate Monitor Agent to send the data to the Oracle GoldenGate Monitor Server.

• Setting agent.type.enabled to OEM causes the Oracle GoldenGate Monitor Agent to supply monitoring points data when polled by an Oracle Enterprise Manager agent or ODI.

This setting is also required when integrating with Oracle Data Integrator. If you are using both GoldenGate Monitor and Oracle Data Integration at the same time, you will need to set up two agents, one with agent.type.enabled set to Oracle GoldenGate Monitor and one set to OEM.

When agent.type.enabled is set to OEM, the Oracle Enterprise Manager agent will connect to the Oracle GoldenGate Monitor Agent through the Remote Method Invocation (RMI) connector, so you must enter the jagent.rmi.port.

Note:

This property is valid for the 11.2.1 release of Oracle GoldenGate and later.

Syntax

agent.type.enabled={OGGMON | OEM}

6.2.1.8 jagent.rmi.port

Use jagent.rmi.port to specify the port number for the RMI connector. This is the port that will be used by the Enterprise Manager agent when connecting to the Oracle GoldenGate Monitor Agent.

This property is required when agent.type.enabled is set to OEM.

Note:

This property is valid for the 11.2.1 release of Oracle GoldenGate and later.

Default

5559

Syntax

agent.rmi.port=port_number

6.2.2 Communication

You must select whether the communication will use Secure Sockets Layer (SSL) or not. If you use SSL, you need to identify the storage for the keys and certificates.

Note:

Oracle GoldenGate Monitor Agents running on IBM z/OS can only use SSL . Additionally, all agents communicating with a GoldenGate Monitor Server must all use the same connection protocol.

6.2.2.1 jagent.ssl

Use jagent.ssl to specify whether or not the communication from the agent will use SSL.

Note:

If the jagent.backward.compatility property is set to true, Oracle GoldenGate Monitor assumes SSL is not enabled and ignores the setting for jagent.ssl.

Note:

The jagent.ssl setting for all agents that communicate with Oracle GoldenGate Monitor Server must match the server's setting for the monitor.ssl property in the monitor.properties file.

Default

false

Syntax

jagent.ssl=[true | false]

6.2.2.2 jagent.keystore.file

Use jgent.keystore.file to identify the file that stores the key pairs and certificates used for SSL authentication.

Default

jagentKeyStore

Syntax

jagent.keystore.file=keystore_filename

6.2.2.3 jagent.truststore.file

Use jagent.truststore.file to store trusted certification authority (CA) certificates that verify the identity of other clients or servers.

Default

jagentKeyStore

Syntax

jagent.truststore.file=truststore_filename

6.2.3 Monitoring Targets

You need to identify the names and ports for the computers where the Oracle GoldenGate Manager and Agent reside. You also set backward compatibility and define the agent credentials.

6.2.3.1 jagent.host

Use jagent.host to specify the host name of the computer where the Oracle GoldenGate Monitor Agent is running. This is the host name of the Oracle GoldenGate instance being monitored and should be the same name used in the RMTHOST parameter by any remote GoldenGate Extract processes that connect to this Oracle GoldenGate Monitor instance. This will ensure that Solution Discovery works properly.

This property is required. If a valid value is not entered, the Manager writes an error to ggserr.log during start up and the agent is not initialized successfully.

Syntax

jagent.host=ogg_host_name

Note:

If a remote trail is specified in the Extract parameter file using RMTTRAIL, then the host name specified for the RMTHOST parameter must match the value set for the Java jagent.host entry. When you have a remote Extract connecting to the local Oracle GoldenGate Monitor instance running the Oracle GoldenGate Monitor Agent, the fully qualified host name specified in the parameter file must be the same as the fully qualified name used for jagent.host.

6.2.3.2 jagent.jmx.port

Use jagent.jmx.port to specify the JMX port of the agent.

Default

5555

Syntax

jagent.jmx.port=port_number

6.2.3.3 mgr.host

Use mgr.host to specify the name or IP address of the computer where the Oracle GoldenGate Manager is running. Together, mgr.host and mgr.port identify the Oracle GoldenGate instance to the Oracle GoldenGate Monitor Agent.

If this property is not entered, the system will assume that the agent is local to the Oracle GoldenGate instance and determine the value by default.

Note:

This property is not used for 11.2.1 and earlier releases since the agent must be local to the Oracle GoldenGate instance.

Syntax

mgr.host=ogg_host_name

6.2.3.4 mgr.port

Whenever you change the mgr.port property, you should change the jagent.jmx.port property as well to register it with the Monitor server so that the correct results will be displayed.

Use mgr.port to specify the port of the Oracle GoldenGate Manager. If this property is not entered, the system will assume that the agent is local to the Oracle GoldenGate instance and determine the value by default.

Note:

This property is not used for 11.2.1 and earlier releases since the agent must be local to the Oracle GoldenGate instance.

Syntax

mgr.port=manager_port

6.2.3.5 monitor.host

Use monitor.host to specify the host computer name of the Oracle GoldenGate Monitor Server installation. Use the fully qualified host name. This must match the entry for monitor.jmx.server.host in the monitor.properties file.

This property is required. If a valid value is not entered, Manager writes an error to ggserr.log during start up and the agent is not initialized successfully.

Syntax

monitor.host=monitor_host_name

6.2.3.6 monitor.jmx.port

Use monitor.jmx.port to specify the JMX port of the Oracle GoldenGate Monitor Server installation. Initially set this to the value entered for the port on the JMX Server Configuration screen during the Oracle GoldenGate Monitor Server installation. This must match the monitor.jmx.server.port entry in the monitor.properties file.

Default

5502

Syntax

monitor.jmx.port=port_number

6.2.3.7 monitor.jmx.username

The monitor.jmx.username property must match the monitor.jmx.server.user entry in the monitor.properties file.

Use monitor.jmx.username to specify the user name for the JMX connection to the Oracle GoldenGate Monitor Server. Initially set this to the value entered for the user name on the JMX Server Configuration screen during the Oracle GoldenGate Monitor installation.

This property is required. If a valid value is not entered, Manager writes an error to ggserr.log during start up and the agent is not initialized successfully.

Syntax

monitor.jmx.username=user_name

6.2.3.8 jagent.username

Use jagent.username to specify the agent user name for the JMX connection to the Oracle GoldenGate Monitor Agent. When the agent registers, it passes this name to the Oracle GoldenGate Monitor Server.

This property is required. If a valid value is not entered, Manager writes an error to ggserr.log during start up and the agent is not initialized successfully.

Syntax

jagent.username=user_name

6.2.3.9 jagent.backward.compatibility

Set jagent.backward.compatibility to true to activate backward compatibility that allows monitoring of Oracle GoldenGate 11.1.1.1.1 instances. The value is initially set to false

.

Note:

This property applies only when agent.type.enabled=OGGMON. It is ignored when agent.type.enabled=OEM.

jagent.backward.compatibility is valid for all supported platforms except IBM z/OS.

If jagent.backward.compatibility is set to true, Oracle GoldenGate Monitor assumes SSL is not enabled and jagent.ssl is ignored.

Syntax

jagent.backward.compatibility={true | false}

6.2.4 Polling Properties

You can set the polling intervals. These polling interval properties default to the indicated default number of seconds if nothing is entered. An error message is generated if the entered number of seconds is negative or greater than 2147483647.

6.2.4.1 interval.quick

Use interval.quick to specify the polling interval used for monitoring points in the Quick Default Polling Group. The value is in seconds.

Default

30 seconds

Syntax

interval.quick=seconds

6.2.4.2 reg.retry.interval

Use reg.retry.interval to specify the interval to wait before retrying an initial agent registration when an exception occurs.

Default

10 seconds

Syntax

reg.retry.interval=seconds

6.2.4.3 instance.query.initial.interval

Use instance.query.initial.interval to specify the interval that Jagent will wait to register if Manager is the only running process. If there are still no other processes after this interval, the agent will proceed with the registration.

Default

5 seconds

Syntax

instance.query.initial.interval=seconds

6.2.4.4 incremental.registration.quiet.interval

Use incremental.registration.quiet.interval to specify the interval that the agent will wait before registration of a new process.

Default

5 seconds

Syntax

incremental.registration.quiet.interval=seconds

6.2.4.5 maximum.message.retrieval

Use maximum.message.retrieval property to specify the maximum number of messages to retrieve from the core Oracle GoldenGate instance when the starts up.

Setting this number to zero or a negative number disables message retrieval function of the agent, which can be considered to increase performance if message monitoring is not needed.

Default

500 messages

Syntax

maximum.message.retrieval=number

6.2.4.6 message.polling.interval

Use message.polling.interval to set the interval for agent to poll ggserr.log for new messages.

Default

5 seconds

Syntax

message.polling.interval=seconds

6.2.4.7 status.polling.interval

Use status.polling.interval to set the interval for the agent to poll for the status of new and existing processes.

Default

5 seconds

Syntax

status.polling.interval=seconds