Oracle Data Guard Database

Monitor profiles allow you to configure monitoring of similar properties of your environment. For example, by configuring Oracle Data Guard Database, you can enable monitoring of your data guard databases. While configuring you can configure what to monitor and how to access the environment that you want to monitor. You enter all this information in an infrastructure policy.

Before you begin

You must download and install PATROL for Oracle Enterprise Database. For more information see Installing and Performance and scalability data.

To configure the monitor type

In the Add Monitoring Configuration panel, select the following parameters for the Oracle Enterprise Database KM:

ParameterSelection
Monitoring SolutionOracle Enterprise Database
Monitoring ProfileOracle Environment Monitoring
Monitor TypeOracle Data Guard Database

For the Global Monitoring Setting, you can enable Logging for all of the configured PATROL Agent environments to confirm that all of the PATROL for Oracle Enterprise Database environments are correctly configured.

Click Add and enter the following details.

FieldDescription
Environment name

Enter a unique name for the environment. We recommend you to use alphanumeric characters in the environment name.

Note

  • The name cannot include blank spaces or any of the following special characters: # $ \ ' | ~ ! @ % ^ ; ` ( ) { } ? \ " [ ] + = & : > < * /
  • Do not use non-English characters to specify an environment name.
  • Once you save the environment configuration, you cannot change the name without losing the environment's historical data. You can change the environment name by making a copy of the monitoring solution and then you can change the environment name.
Oracle credentials
User Name

The SYSDBA monitoring user name of the Oracle Database.
Note: Confirm that the user has permission for object access, see Monitoring categories and user permissions.

Oracle connection name

Enter the name of the Oracle Database SID to monitor. The SID name appears in the tnsnames.ora file on Oracle Database host.
Note: This value is used for all standalone Data Guard instances only. For each Oracle RAC instance, this value is not used and you must enter the Oracle RAC service name.

If you do not have standalone Data Guard instances, but have Oracle RAC instances, you need to enter a value in the field; however, the value is not used for Oracle RAC instances.
If you do not have standalone Data Guard instances, but have Oracle RAC instances, this value acts only as a container of RAC instances.

Password
Confirm password

The user password of the Oracle Database.

If you are using vault to access the password in BMC Helix Operations Management, enter the query string in the Password and Confirm password field.

Connect as

Select how the specified user would connect to the database:

  • SYSDBA
  • SYSDG
  • NON SYS

If you select NON SYS, ensure that the standby databases to be monitored are in the read-only mode in Active Data Guard.

Data Guard details
Oracle Data Guard connection method

Select how to connect to the Data Guard databases: SID
The value in this field determines how to connect with all Data Guard databases. To enter connection information about a specific instance, enter details in the Data Guard instance connection details section.

Oracle connection name

Enter the name of the Oracle Database SID to monitor. The SID name appears in the tnsnames.ora file on Oracle Database host.

Note

This value is used for all standalone Data Guard instances only. For each Oracle RAC instance, this value is not used and you must enter the Oracle RAC service name.

If you have Oracle RAC instances, but no standalone Data Guard instances, the value entered in the field acts as a container of RAC instances. The value is not used for the Oracle RAC instances connections.

Data Guard instance connection details

Oracle host

The host name or the IP address used for the Data Guard Oracle Database.
You can use the $HOSTNAME variable for the Oracle host. The name is taken from the PATROL agent that is registered in the  TrueSight console's Devices page Open link .

The IP address can be in the IPv4 or IPv6 format. An example of an IPv6 address is [2001:db8:28:3:f98a:5b31:67b7:67ef]

Oracle port

The port number used to connect with the Data Guard Oracle Database.

The default port number is 1521.

Oracle Data Guard connection method

Select how to connect to the Data Guard database instance:

  • Service
  • SID 
Oracle connection name

Enter the name of the Oracle Database SID to monitor. The SID name appears in the tnsnames.ora file on Oracle Database host.
If you leave the field blank, the value entered in the Oracle connection name field in the Data Guard Details section is used to connect to the database.

Note

This value is used for all standalone Data Guard instances only. For each Oracle RAC instance, this value is not used and you must enter the Oracle RAC service name.

Mark as primary nodeSelect this option if the Oracle instance is the preferred primary node of the Data Guard setup.
Data Guard RAC instance connection details
Oracle SCANEnter the Oracle RAC instance SCAN or host name.
Oracle SCAN listener portEnter the Oracle RAC SCAN listener port.
Oracle RAC connection methodThis field displays how you are connecting to the Oracle RAC instance. In this case, you would connect to the Oracle RAC instance as a service.
Oracle RAC Service name

Enter the Oracle RAC service name.

Mark as primary nodeSelect the check box to mark the RAC instance as the primary node.
Monitoring categories

Select the Oracle Database activity categories that you want to monitor.

Jobs
JobsSelect this option to monitor the jobs and transactions running in the Oracle Database.
Long running job time (min)

The duration for jobs that are running longer than the defined duration (default 30 minutes). Any job that exceeds this duration sets an alert.

Job overdue time (min)

The duration for jobs that are overdue because they are not executed (2 minutes late). These jobs may be delayed, broken, or failed.
For more information, see Jobs (KOE_INST_JOBS).

Tablespaces
Tablespaces

Select this option to monitor the tablespaces. 

To monitor large and very large tablespaces under separate application classes (Oracle Large Tablespace (KOE_INST_LARGE_TABLESPACE) and Oracle Very Large Tablespace (KOE_INST_VERY_LARGE_TABLESPACE)), configure the minimum size (in MB) of the large and very large tablespaces in the following configuration variables (both are required). Set configuration variables on the Configuration Variables > Add Configuration Variable page.

  • /KOE/Oracle/<EnvType>/<EnvName>/LargeTablespaceSize
  • /KOE/Oracle/<EnvType>/<EnvName>/VeryLargeTablespaceSize

Replace EnvType with DataGuard, Standalone, or RAC and <EnvName> with the name that you used in the Environmant name field.

Restart PATROL Agent after configuring these configuration variables.

If you do not configure values in one or any of these variables or if the value in VeryLargeTablespaceSize is smaller than the value in LargeTablespaceSize, all tablespaces are discovered under the Oracle Tablespace (KOE_INST_TABLESPACE) class.

For example, you configure the value of the LargeTablespaceSize variable as 200 and the value of the VeryLargeTablespaceSize variable as 500. The tablespaces between the sizes 200 and 500 MB are monitored under the Oracle Large Tablespace (KOE_INST_LARGE_TABLESPACE) application class and the tablespaces with sizes more than 500 MB are monitored under the Oracle Very Large Tablespace (KOE_INST_VERY_LARGE_TABLESPACE) application class.

Note: These configuration variables are not applicable to UNDO and TEMP tablespaces.

Tablespaces filtering options
Filtering mode

Select the filtering mode:

  • None
  • Include
  • Exclude
Include/Exclude matching criteria

Based on the selection in the filtering mode, specify the tablespaces to include or exclude from monitoring. Use comma (,) only to separate the tablespaces.
For example, consider the tablespace name is DB12, you can use any of the following methods to include or exclude tablespaces from monitoring:

  • Starts with: ^DB.*
  • Contains: .*B1.*
  • Ends with: .*12$
  • Equals to: DB12

Note

Be cautious when you add spaces while entering the regex search string. Extra space is considered as a character by the search string.


Filter for top n queries by total wait time

Total wait time monitoring

Select this option to enable the filter for top n queries by total wait time.

Top Number of queries

Enter the number of queries that you want to filter. 
The valid input range is 1-100.

Maximum query instances limit

Enter the maximum number of query instances to filter.
The valid input range is 1-2500.

Number of days to keep query instances

Enter the number of days to store the query instance. 
The valid input range is 1-60.

Oracle Custom SQL Queries

Query name

Enter a SQL query name.

Note

The name cannot include blank spaces or any of the following special characters: # $ \ ' | ~ ! @ % ^ ; ` ( ) { } ? \ " [ ] + = & : > < * /
After you save the environment configuration, you cannot change the name without losing the environment's historical data. You can change the environment name by making a copy of the monitoring solution and then changing the environment name.

SQL query

Enter a SQL query.

Note

The SQL query must not contain the semicolon (;).

Collection time (min)Enter the SQL query collection time. The default collection time is 10 minutes.
Enable number of records annotationSelect this option to display the query result as an annotation on number of records metric.
Environment Settings details
Logging 

Select this option to enable detail level logging for all PostgreSQL databases configured on this environment to get more details about policy configuration and data collection.
The log files are created under PATROL_HOME directory:

  • JavaPATROL_HOME/Patrol3/koekm/logs/java
  • PSLPATROL_HOME/Patrol3/log/koe-*.kmlog

For more information about logging, see Using debug logging in the TrueSight Infrastructure Management operator console.

Device mapping

By default, device mapping on the TrueSight console is enabled. If enabled, all the Oracle Database instances are discovered under the Oracle host device.
If it is disabled, all the Oracle Database instances are discovered under the PATROL Agent host device.

Java collector settings
Java path

Specify the path to the JRE directory (also known as $JAVA_HOME environment variable) on the PATROL Agent host.
If you use the $JAVA_HOME variable, the Java location depends on the following:

  • No user name and password are entered for the Java collector settings; the KM uses the Java location of the user running the PATROL Agent.
  • A user name and password are entered for the Java collector settings; the KM uses Java location of the user entered in the collector settings.

If you enter a path for the JRE directory, you must enter the full path, such as C:\Program files\Java\jre1.8.0_151. Do not use the short path format.
If you do not enter a value in this field, the KM looks for the Java installed in the PATROL Agent home directory as:

  • Linux$PATROL_HOME/../openjdk$PATROL_HOME/../jre64
  • Windows%PATROL_HOME%/../openjdk%PATROL_HOME%/../jre64
JVM arguments
Enter the optional Java Virtual Machine (JVM) arguments for the Java collector
User NameEnter the local user name to start the Java process.

Password

Confirm password

Enter the user password to start the Java process.
Collection settings
Availability collection interval (min)

The time interval used to check for the environment's availability for collecting data.
The default interval is one minute.

Data collection interval (min)

The time interval used for data collection from the environment.
The default interval is five minutes.
Note: Entering a data collection time that is less than 5 minutes will result in a performance issue for the KM.

Long running data collection queries (min)

The time interval use to determine when a running query is blocked. The query is blocked because its execution duration is equal to, or greater than, this interval's threshold.
The default interval is 30 minutes.

Wait time SQL data collection interval (min)

Enter the total time interval in minutes to collect or report the value for the wait time SQL attributes. This attribute is valid for SQL instances attributes only. The default wait time for SQL data collection time is 5 minutes.
The valid input range is 5-60.

Where to go from here

Verifying the configuration


Was this page helpful? Yes No Submitting... Thank you

Comments