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:
The monitor.properties
file describes the characteristics of Oracle GoldenGate Monitor processing. It includes properties to define the relationship with the JMX server, types of alert notifications to be used, 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 Monitor Server to activate it.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.version monitor.jpa.connection.driver_class monitor.jpa.connection.url eclipselink.target-database eclipselink.weaving eclipselink.ddl-generation
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
These properties enable the JMX server, identify the user name, and register the name and port of the JMX server host.
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.
true
monitor.jmx.server.enabled={true | false}
monitor.jmx.server.host
Use monitor.jmx.server.host
to specify the computer name of the Oracle GoldenGate Monitor installation. Set this to the fully qualified host name of the server for the Oracle GoldenGate Monitor installation. This must match the entry for monitor.server 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
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.
monitor.ssl
Use monitor.ssl
to specify whether or not the communication from Oracle GoldenGate Monitor will use SSL.
Note:
Themonitor.ssl
setting for Oracle GoldenGate Monitor Server must match the agent.ssl
property settings in the Configuration.properties
file of all agents that communicate with the server.false
monitor.ssl=[true | false]
monitor.keystore.file
Use monitor.keystore.file
to identify the file that stores the key pairs and certificates used for SSL authentication.
monitorKeyStore
monitor.keystore.file=keystore_filename
monitor.truststore.file
Use monitor.truststore.file
to store trusted certification authority (CA) certificates that verify the identity of other clients or servers.
jagentKeyStore
monitor.truststore.file=truststore_filename
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
.
monitor.db.connection.initial_size
Use monitor.db.connection.initial_size
to set the Initial number of database connections in the database connection pool. The default is 5.
monitor.db.connection.initial_size=5
monitor.db.connection.max_active
Use monitor.db.connection.max_active
to set the maximum number of database connection can be created. The default is 50.
monitor.db.connection.max_active=50
monitor.db.connection.max_idle
Use monitor.db.connection.max_idle
to set the maximum number of database connection that can be idle. The default is 5.
monitor.db.connection.max_idle=5
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.
monitor.default_agent_connection.max_attempts=number
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.
monitor.default_agent_connection.interval=seconds
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.
monitor.default_agent_connection.reconnect_interval=seconds
The repository database is selected during the installation of Oracle GoldenGate Monitor. Contact Oracle Support if you need to change the repository after installation. For more information on contacting support, go to http://support.oracle.com
.
These properties set the timeout value and the threshold number of events to trigger processing.
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.
monitor.cm.event.timeout=milliseconds
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.
monitor.cm.event.max.size=number_events
The Config.properties
file configures an Oracle GoldenGate Monitor Java 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.
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.
Note:
After you change a property value, you must restart the agent to activate it.You must set the type of agent that will be used to monitor the Oracle GoldenGate instance.
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 Java Agent polls Manager at configurable intervals to collect monitoring points data.
Setting agent.type.enabled
to OGGMON
causes the Oracle GoldenGate Monitor Java Agent to send the data to the Oracle GoldenGate Monitor Server.
Setting agent.type.enabled
to OEM
causes the Oracle GoldenGate Monitor Java 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 Integrator 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 Java 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.agent.type.enabled={OGGMON | OEM}
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 Java 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.5559
agent.rmi.port=port_number
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 Java 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.jagent.ssl
Use jagent.ssl
to specify whether or not the communication from the agent will use SSL.
Note:
If thejagent.backward.compatility
property is set to true
, Oracle GoldenGate Monitor assumes SSL is not enabled and ignores the setting for jagent.ssl.
Note:
Thejagent.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.false
jagent.ssl=[true | false]
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.
jagent.host
Use jagent.host
to specify the host name of the computer where the Oracle GoldenGate Monitor Java 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, Manager writes an error to ggserr.log
during start up and the agent is not initialized successfully.
jagent.host=ogg_host_name
Note:
If a remote trail is specified in the Extract parameter file usingRMTTRAIL
, 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 Java Agent, the fully qualified host name specified in the parameter file must be the same as the fully qualified name used for jagent.host
.jagent.jmx.port
Use jagent.jmx.port
to specify the JMX port of the agent.
5555
jagent.jmx.port=port_number
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 Java 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.
mgr.host=ogg_host_name
mgr.port
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.
Whenever you change this 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.
Note:
This property is not used for 11.2.1 and earlier releases since the agent must be local to the Oracle GoldenGate instance.
mgr.port=manager_port
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.
monitor.host=monitor_host_name
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.
5502
monitor.jmx.port=port_number
monitor.jmx.username
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.
monitor.jmx.username=user_name
jagent.username
Use jagent.username
to specify the agent user name for the JMX connection to the Oracle GoldenGate Monitor Java 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.
jagent.username=user_name
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 whenagent.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.
jagent.backward.compatibility={true | false}
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.
interval.regular
Use interval.regular
to specify the polling interval used for monitoring points in the Regular Default Polling Group
. The value is in seconds.
60 seconds
interval.regular=seconds
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.
30 seconds
interval.quick=seconds
reg.retry.interval
Use reg.retry.interval
to specify the interval to wait before retrying an initial agent registration when an exception occurs.
60 seconds
reg.retry.interval=seconds
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.
15 seconds
instance.query.initial.interval=seconds
incremental.registration.quiet.interval
Use incremental.registration.quiet.interval
to specify the interval that the agent will wait before registration of a new process.
5 seconds
incremental.registration.quiet.interval=seconds
maximum.message.retrieval
Use maximum.message.retrieval
to specify the maximum number of messages to retrieve from the core Oracle GoldenGate instance when the Oracle GoldenGate Monitor Java Agent starts up.
500 messages
maximum.message.retrieval=number
message.polling.interval
Use message.polling.interval
to set the interval for agent to poll ggserr.log
for new messages.
5 seconds
message.polling.interval=seconds
status.polling.interval
Use status.polling.interval
to set the interval for the agent to poll for the status of new and existing processes.
5 seconds
status.polling.interval=seconds
The monitor.properties
file describes the characteristics of Oracle GoldenGate Monitor processing. It includes properties to define the relationship with the JMX server, types of alert notifications to be used, and the timing for connection attempts. Many of these property values are initially set based on user entries during installation.