Oracle Data Guard Database
To configure the monitor type
In the Add Monitoring Configuration panel, select the following parameters for the Oracle Enterprise Database KM:
Parameter | Selection |
|---|---|
Monitoring Solution | Oracle Enterprise Database |
Monitoring Profile | Oracle Environment Monitoring |
Monitor Type | Oracle Data Guard Database |
Click Add and enter the following details:
Field | Description |
|---|---|
Environment name | Enter a unique name for the environment. We recommend the use of alphanumeric characters in the environment name. Important:
|
Oracle credentials | |
User Name | Enter the SYSDBA monitoring user name of the Oracle Database. Important: Confirm that the user has permission for object access; see Monitoring-categories-and-user-permissions. |
Password | Enter the user password of the Oracle Database. Important: If you are using Vault to access the BMC Helix Operations Management password, enter the query string in the Password and Confirm password field. |
Confirm password | Re-enter the user password of the Oracle Database. |
Connect as | Select how the specified user would connect to the database:
|
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 is displayed in the tnsnames.ora file on Oracle Database host. Important: This value is used for all stand-alone Data Guard instances only. This value is not used for each Oracle RAC instance; you must enter the Oracle RAC service name. If you have Oracle RAC instances but no stand-alone Data Guard instances, the value entered in the field acts as a container for the RAC instances. The value is not used for the Oracle RAC instance connections. |
Disable standby database monitoring | Select this check box to disable the standby database monitoring. If the standby database monitoring is disabled, the primary database will be monitored based on its current role. |
Data Guard instance connection details Click Add and enter the following details. | |
Oracle host | Enter 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. The IP address can be in IPv4 or IPv6 format. An example of an IPv6 address is [2001:db8:28:3:f98a:5b31:67b7:67ef]. |
Oracle port | Enter 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:
|
Oracle connection name | Enter the name of the Oracle Database SID to monitor. The SID name is displayed 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. Important: This value is used for all stand-alone Data Guard instances only. It is not used for each Oracle RAC instance; you must enter the Oracle RAC service name. |
Mark as primary node | Select this check box if the Oracle instance is the preferred primary node of the Data Guard setup. |
Data Guard RAC instance connection details Click Add and enter the following details. | |
Oracle SCAN | Enter the Oracle RAC instance SCAN or host name. |
Oracle SCAN listener port | Enter the Oracle RAC SCAN listener port. |
Oracle Data Guard connection method | This 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 node | Select this 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 | |
Jobs | Select this check box to monitor the jobs and transactions running in the Oracle Database. |
Long running job time (min) | Set the duration time 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) | Set the duration time for jobs that are overdue because they are not executed (2 minutes late). These jobs might be delayed, broken, or failed. |
Tablespaces | |
Tablespaces | Select this check box 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 in the Configuration Variables on the Add Configuration Variable page.
Replace EnvType with DataGuard, Standalone, or RAC and <EnvName> with the name you used in the Environment name field. Restart the 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. Important: These configuration variables do not apply to UNDO and TEMP tablespaces. |
Tablespaces filtering options | |
Filtering mode | Select one of the following filtering modes:
|
Include/Exclude matching criteria | Based on the selection in the filtering mode, specify the tablespaces to include or exclude from monitoring. Use comma (,) to separate the tablespaces. For example, if the tablespace name is DB12, you can use any of the following methods to include or exclude the tablespace from monitoring:
Important: Be cautious if you add spaces while entering the regex search string. An extra space is considered a character by the search string. |
Filter for top n queries by total wait time For more information, see Monitoring-of-wait-time-attributes-of-SQL-query. | |
Total wait time monitoring | Select this check box to filter for top n queries by total wait time. |
Top Number of queries | Enter the number of queries that you want to filter. |
Maximum query instances limit | Enter the maximum number of query instances to filter. |
Number of days to keep query instances | Enter the number of days to store the query instance. |
Oracle Custom SQL Queries Click Add and enter the following details. | |
Query name | Enter a SQL query name. 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. To change the environment name, first make a copy of the monitoring solution and then change the environment name of the original configuration. |
SQL query | Enter a SQL query. The SQL query must not contain a semicolon (;). |
Collection time (min) | Enter the SQL query collection time. The default collection time is 10 minutes. |
Enable number of records annotation | Select this check box to display the query result as an annotation on a number of record metrics. |
Environment settings | |
Logging | Select this check box 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 the PATROL_HOME directory:
For more information about logging, see Using-debug-logging-in-the-TrueSight-Infrastructure-Management-operator-console. |
Device mapping | Accept the default device mapping or change to disabled. 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 items:
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:
|
JVM arguments | Enter the optional Java Virtual Machine (JVM) arguments for the Java collector. |
Java OS credentials | |
User Name | Enter the local user name to start the Java process. |
Password | Enter the user password to start the Java process. |
Confirm password | Re-enter the user password to start the Java process. |
Collection settings | |
Availability collection interval (min) | Enter the time interval used to check for the environment's availability for collecting data. The default interval is one minute. |
Data collection interval (min) | Enter the time interval used for data collection from the environment. The default interval is five minutes. Important: A data collection time of less than 5 minutes will result in a performance issue for the KM. |
Long running data collection queries (min) | Enter the time interval, in minutes, that determines 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 instance attributes only. The default wait time for SQL data collection time is 5 minutes. The valid input range is 5-60. For more information, see Monitoring-of-wait-time-attributes-of-SQL-query. |
Global monitoring settings | |
Logging | Select this check box to 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. |
Where to go from here