2.1.4 Setting up PFM - RM for Oracle (Windows)
This subsection describes how to set up PFM - RM for Oracle for operation.
![[Figure]](GRAPHICS/ZU12001.GIF)
indicates an item that may or may not be required depending on your operating environment, or an optional item that you can
set if you do not wish to use the default.
- Organization of this subsection
(1) Register PFM - RM for Oracle
To perform integrated management of PFM - RM for Oracle using PFM - Manager and PFM - Web Console, you must register PFM - RM for Oracle with PFM - Manager and PFM - Web Console.
If PFM - RM for Oracle is already registered in PFM - Manager and PFM - Web Console, you do not have to follow the procedure described below. If PFM - RM for Oracle is not registered yet, manually register PFM - RM for Oracle according to the procedure.
You can determine whether manual registration of PFM - RM for Oracle is necessary by referring to the conditions described below.
- Manually registering PFM - RM for Oracle in PFM - Manager
-
When all of the following conditions apply, manually register PFM - RM for Oracle in PFM - Manager:
-
The PFM - RM for Oracle to be installed is of a product version that is not specified in the Release Notes for PFM - Manager.
-
PFM - RM for Oracle is installed on a host other than PFM - Manager.
-
- Manually registering PFM - RM for Oracle in PFM - Web Console
-
When the following condition applies, manually register PFM - RM for Oracle in PFM - Web Console:
-
The PFM - RM for Oracle to be installed is of a product version that is not specified in the Release Notes for PFM - Web Console.
-
If, however, the Release Notes for PFM - RM for Oracle state that it is necessary to execute the setup command, execute the setup command.
The following figure shows the flow of PFM - RM for Oracle registration.
|
|
![[Figure]](GRAPHICS/ZUO02004.GIF)
- Notes
-
-
Register PFM - RM for Oracle before setting up an instance environment.
-
You do not need to register a new instance of an already registered version of PFM - RM for Oracle when you add it to the Performance Management system.
-
When you have installed different versions of PFM - RM for Oracle on different hosts, set up the older version before the newer version.
-
When you install PFM - RM for Oracle on the same host as PFM - Manager, the jpcconf agent setup command is executed automatically, and the following message is output to the common message log: KAVE05908-I New agent setup (pfm-agent-service-key) ended successfully. (version=version). Check the result of command execution in the log file. If execution was unsuccessful, try it again. For details about how to execute commands, see the chapter on commands in the manual JP1/Performance Management Reference.
-
Registration of PFM - RM for Oracle creates the RM Oracle folder in Reports window and Alarms window of PFM - Web Console. If the RM Oracle file or folder already exists on the Reports window, rename the file or folder before registering PFM - RM for Oracle.
-
(a) Copy the PFM - RM for Oracle setup files
Copy the setup files from the host on which you installed PFM - RM for Oracle (PFM - RM host) to the hosts on which PFM - Manager and PFM - Web Console are installed.
To copy the files:
-
If PFM - Web Console is running, stop it before copying the files.
-
Copy the PFM - RM for Oracle setup files in binary mode.
The following table shows the location of the setup files and where they should be copied.
Table 2‒2: Setup files to be copied PFM - RM for Oracle setup file
Destination
PFM program name
OS
Destination folder
installation-folder\setup\jpcagt1w.EXE
PFM - Manager
Windows
installation-folder\setup
installation-folder\setup\jpcagt1u.Z
UNIX
/opt/jp1pc/setup/
installation-folder\setup\jpcagt1w.EXE
PFM - Web Console
Windows
installation-folder\setup
installation-folder\setup\jpcagt1u.Z
UNIX
/opt/jp1pcwebcon/setup/
(b) Execute the setup command on the PFM - Manager host
On the PFM - Manager host, execute the following command to set up PFM - RM for Oracle:
jpcconf agent setup -key RMOracle
- Notes on executing the command:
-
If any Performance Management programs or services are still running on the local host when you execute the jpcconf agent setup command, an error may occur. If an error occurs, make sure that all Performance Management programs and services have completely stopped, and then execute the jpcconf agent setup command again.
You can then delete the PFM - RM for Oracle setup files remaining on the PFM - Manager host.
(2) Create an Oracle account to be used in PFM - RM for Oracle
To monitor an Oracle Database and collect performance data by using PFM - RM for Oracle, you must perform either of the following setting tasks:
-
Set the sys account as the account used to monitor the Oracle Database from PFM - RM for Oracle
-
Create a special Oracle account with system privileges, and set it as the account used to monitor the Oracle Database from PFM - RM for Oracle
If the monitoring target is Oracle Database 12c Release 2 or later in a CDB configuration, PDBs and the root container (CDB$ROOT) can be monitored. When you create Oracle accounts to monitor PDBs and the root container in a CDB configuration, create the following users:
-
If you create a user for monitoring the root container (CDB$ROOT)
A common user with system privileges for CDB$ROOT listed in Table 2-3
When the root container (CDB$ROOT) that is being monitored, collecting performance data is different by monitored account. For details, see 5. List of records for PFM - RM for Oracle or descriptions of each record field.
This is difference of setting for collecting PDB's performance data. For details, see your Oracle documentation.
-
If you create a user for monitoring PDBs
A local user with system privileges for the PDBs to be monitored listed in Table 2-3
If you create Oracle accounts by executing the mk_rmus.sql script, the following users can be created:
-
If the monitoring target is Oracle Database 11g Release 2 or earlier, or Oracle Database 12c Release 1 or later in a non-CDB configuration
A user with system privileges listed in Table 2-3
-
If the monitoring target is Oracle Database 12c Release 2 or later in a CDB configuration
The following table lists the operations that PFM - RM for Oracle performs for the Oracle Database to collect performance data. The table also lists the system privileges required to perform the operations with the Oracle account.
|
Operations that PFM - RM for Oracle performs for the Oracle Database |
System privileges required to perform the operations |
|---|---|
|
|
The sys account has the system privileges shown in Table 2-3. When the sys account cannot be used for Oracle Database monitoring due to security requirements, use an Oracle account with the system privileges shown in Table 2-3.
When creating an Oracle account for monitoring the Oracle Database, without using the mk_rmus.sql script, grant the appropriate privileges for operations. By granting these privileges, the minimum necessary privileges can be granted to the Oracle account. When granting privileges according to role, do so explicitly (using GRANT privileges...). For details about the privileges needed for each operation, see I. Precautions Regarding Permissions.
The following table lists the information necessary to execute the mk_rmus.sql script and create an Oracle account. Check the information before starting setup operations.
|
Item |
Description |
|---|---|
|
Enter username |
Specifies the name of the account to be created. The value you specify must consist of 7-bit ASCII alphanumeric characters, must not exceed 30 bytes, and must be specifiable in the user parameter of the CREATE USER statement. Note that a character string that begins with a number and includes an alphabetic character cannot be specified. The default is RMAGT1.
|
|
Enter password |
Specifies the password for the account to be created. The value you specify must consist of 7-bit ASCII alphanumeric characters, must not exceed 30 bytes, and must be specifiable in the BY password parameter of the IDENTIFIED clause in the CREATE USER statement. Note that a character string that begins with a number and includes an alphabetic character cannot be specified. This is a mandatory item. |
|
Enter default tablespace |
Specifies the default tablespace used by the account to be created. The value you specify must consist of 7-bit ASCII alphanumeric characters, must not exceed 30 bytes, and must be specifiable in the DEFAULT TABLESPACE clause in the CREATE USER statement. Note that a character string that begins with a number and includes an alphabetic character cannot be specified. This is a mandatory item.
|
|
Enter default temporary tablespace |
Specifies the default temporary tablespace used by the account to be created. The value you specify must consist of 7-bit ASCII alphanumeric characters, must not exceed 30 bytes, and must be specifiable in the TEMPORARY TABLESPACE clause in the CREATE USER statement. Note that a character string that begins with a number and includes an alphabetic character cannot be specified. This is a mandatory item.
|
- Notes:
-
-
Make sure that the value of each item consists of only 7-bit ASCII alphanumeric characters that do not exceed 30 bytes. If the value is longer than 30 bytes or includes a character that is not a 7-bit ASCII alphanumeric character, the script may operate incorrectly.
-
Make sure that the value of each parameter is a nonquoted identifier described in the Schema Object Naming Rules. If you specify a value that is not a nonquoted identifier, the script may operate incorrectly. For details about the Schema Object Naming Rules and nonquoted identifiers, see your Oracle documentation.
-
If you create a common user, by executing the mk_rmus.sql script, for monitoring the root container (CDB$ROOT) of Oracle Database 12c Release 2 or later in a CDB configuration, the default tablespace and default temporary tablespace that are specified in the mk_rmus.sql script must be included in all containers that belong to the CDB. For that reason, before executing the mk_rmus.sql script, create the default tablespace and default temporary tablespace in all containers that belong to the CDB. If the mk_rmus.sql script is executed without satisfying the requirements for creating a common user, the creation might fail and the KAVL18506-E message might appear. For details about the requirements for creating a common user, see the Oracle Database documentation.
-
If you want to check the details of an account created by mk_rmus.sql, see DBA_USERS, which is a static dictionary view for the monitoring-target Oracle Database.
The following example shows how to view the tablespace for the account R4O in the static data dictionary view DBA_USERS. If it is clear from the execution results of this SQL statement that the account has been created in the wrong tablespace, delete the account, and then re-create it using mk_rmus.sql.
- Example:
-
To check the details of Oracle account R40 in Windows:
-
From the command prompt, use the sys account to connect to SQL*Plus.
sqlplus "sys account /sys-account-password@net-service-name-for-the-monitoring-target-database AS SYSDBA"
-
Use SQL*Plus to execute the following SQL statement:
SQL>select DEFAULT_TABLESPACE, TEMPORARY_TABLESPACE from DBA_USERS where USERNAME='R4O';
-
Check the execution results. For example, you can check the default tablespace from the DEFAULT_TABLESPACE column and the default temporary tablespace from the TEMPORARY_TABLESPACE column.
-
- Note:
-
The method for connecting to SQL*Plus with the sys account may differ according to the Oracle version. For details, see the Oracle documentation.
Use SYSDBA privileges to connect to the Oracle Database that you want to monitor.
-
For details about the CREATE USER statement, see your Oracle documentation.
The following procedure shows how to create an Oracle account. Before creating an Oracle account, make sure that the tablespaces and other required resources have been prepared.
To create an Oracle account:
-
Set up an environment where the sqlplus Oracle command can be executed.
For details about Oracle environment setup, see your Oracle documentation.
-
Navigate to the following folder, which contains mk_rmus.sql provided by PFM - RM for Oracle:
installation-folder\agt1\agent\sql
-
Execute the mk_rmus.sql script for the monitoring-target Oracle Database.
Example:
- If the monitoring target is Oracle Database 12c Release 1 or earlier, or Oracle Database 12c Release 2 or later in a non-CDB configuration
-
sqlplus Oracle-account/password-for-the-Oracle-account@net-service-name-for-the-monitoring-target-database @mk_rmus.sql
- If the monitoring target is Oracle Database 12c Release 2 or later in a CDB configuration
-
- If you create a local user for a PDB
sqlplus Oracle-account/password-for-the-Oracle-account@net-service-name-for-the-monitoring-target-PDB @mk_rmus.sql
- If you create a common user for the root container (CDB$ROOT)
sqlplus Oracle-account/password-for-the-Oracle-account@net-service-name-for-the-monitoring-target-CDB$ROOT @mk_rmus.sql
Notes:
-
The sqlplus command is provided by Oracle Corporation.
-
The Oracle account with which the mk_rmus.sql script is executed must be granted the CREATE USER, CREATE SESSION and GRANT ANY PRIVILEGE system privileges before the script is executed.
-
If the SYS account is used to execute the mk_rmus.sql script, an error may occur unless the AS SYSDBA option is specified.
-
Establish either a SYSDBA connection to the monitoring-target Oracle Database.
The following shows an example of the mk_rmus.sql script:
Example:
If the monitoring target is Oracle Database 12c Release 1 or earlier, or Oracle Database 12c Release 2 or later in a non-CDB configuration
sqlplus "sys/password-for-the-sys@net-service-name-for-the-monitoring-target-database AS SYSDBA" @mk_rmus.sql
If the monitoring target is Oracle Database 12c Release 2 or later in a CDB configuration
- If you create a local user for a PDB
sqlplus "sys/password-for-the-sys@net-service-name-for-the-monitoring-target-PDB AS SYSDBA" @mk_rmus.sql
- If you create a common user for the root container (CDB$ROOT)
sqlplus "sys/password-for-the-sys@net-service-name-for-the-monitoring-target-CDB$ROOT AS SYSDBA" @mk_rmus.sql
-
When the mk_rmus.sql script is executed, the execution results are output to a spool file. Output is successful only when the current folder is changed to the folder shown in step 2 when the script is executed.
-
Set the parameters that are required to create an Oracle account.
Enter the values for the items listed in Table 2-4 as prompted by the command. All items are mandatory. To use the default value displayed for an item, only press the Enter key.
When all values have been entered, the Oracle account is created.
- Notes:
-
-
Before creating an account, check whether you want to acquire the value of the Explain Plan (EXPLAIN_PLAN) field in the SQL Text (PD_PDSQ) record for operations on the objects that belong to the SYS schema. If you want to do so, use sys as the account to be used by PFM - RM for Oracle. If you use an account other than sys, you will no longer be able to acquire the value of that field. If the value of the EXPLAIN_PLAN field cannot be acquired, message Explain Plan Failed is stored in the field.
-
If the account used by PFM - RM for Oracle has no privileges to access, or fails to reference, an object that belongs to a schema of the user who executed SQL, the following value cannot be acquired:
The value of the Explain Plan (EXPLAIN_PLAN) field in the SQL Text (PD_PDSQ) record
If the value of the EXPLAIN_PLAN field cannot be acquired, message Explain Plan Failed is stored in the field. If you want to acquire the value of the Explain Plan (EXPLAIN_PLAN) field, execute SQL for manipulating the field in the owner.table-name format.
-
Any Oracle account created using the mk_rmus.sql script is granted UPDATE ANY TABLE or another system privilege that can freely manipulate objects of other schemas. Manage such Oracle accounts with special care.
The following table lists the privileges granted to Oracle accounts and the assignment limits of tablespaces.
Table 2‒5: Privileges granted by mk_rmus.sql to Oracle accounts and the assignment limits of tablespaces Type
Privileges granted / assignment limits
Description
System privilege
CREATE SESSION
Required to establish a session with the monitored Oracle Database.
CREATE TABLE
Required when registering a table needed to monitor the Oracle Database, for the monitored Oracle Database (see the table in Table 2-11).
CREATE PROCEDURE
Required when registering a procedure needed to monitor the Oracle Database, for the monitored Oracle Database (see the package in Table 2-11).
SELECT ANY DICTIONARY
Required when registering information needed to monitor an Oracle Database in the monitored Oracle Database (see Table 2-11) and when collecting information.
SELECT ANY TABLE
Required to obtain the Explain Plan (EXPLAIN_PLAN) field in a SQL Text (PD_PDSQ) record.
INSERT ANY TABLE
Required to obtain the Explain Plan (EXPLAIN_PLAN) field in a SQL Text (PD_PDSQ) record.
UPDATE ANY TABLE
Required to obtain the Explain Plan (EXPLAIN_PLAN) field in a SQL Text (PD_PDSQ) record.
DELETE ANY TABLE
Required to obtain the Explain Plan (EXPLAIN_PLAN) field in a SQL Text (PD_PDSQ) record.
CREATE ANY INDEX
Required to obtain the Explain Plan (EXPLAIN_PLAN) field in a SQL Text (PD_PDSQ) record.
ALTER ANY INDEX
Required to obtain the Explain Plan (EXPLAIN_PLAN) field in a SQL Text (PD_PDSQ) record.
Assignment limits of tablespaces
Unlimited assignment for the default tablespace#
Required when registering information needed to monitor an Oracle Database in the monitored Oracle Database (see Table 2-11) and when obtaining the Explain Plan field of the PD_PDSQ record.
-
- #
-
Any created account is granted a privilege to write to the default tablespace without any limit. To change the size of the tablespace allocated to an account after you have created the account, issue the ALTER USER statement in an environment where the sqlplus Oracle command can be executed. Note that any Oracle account with which you execute the ALTER USER statement must be granted the ALTER USER system privilege.
The following shows an example of changing the size of tablespace allocated to an account.
Example:
ALTER USER Oracle-account QUOTA maximum-tablespace-allocation-size ON tablespace-name;
For details about the ALTER USER statement, see your Oracle documentation.
(3) Set up an instance environment
PFM - RM for Oracle requires configurations of the instance environment and the monitoring target. There is a one-to-one match between the configuration of the instance environment and the configuration of the monitoring target.
Note that in PFM - RM for Oracle you can associate one instance environment with only one monitoring target.
You can set up multiple instance environments and monitoring targets by repeating the procedure for each instance.
-
Setting up instance information
-
Setting monitoring target
-
Registering objects in the Oracle Database
-
Setting up the Oracle Database
-
For example, if you monitor three Oracle instances, repeat these procedures three times.
When you create an environment where there are multiple instances, the number of instances depends on the system configuration. As a guide, use three to five instances for the number of instances. You can increase the number of instances by reducing the number of records to be collected or by lengthening the collection interval. Consider this carefully before operation.
This section describes the procedures for each of the actions.
(a) Set up instance information
You must specify instance information for the Oracle that is to be monitored by the PFM - RM for Oracle. Specify instance information on the PFM - RM host.
The following table lists the instance information items that are to be specified. You should check this information before you start the setup procedure. For details about the Oracle instance information items, see your Oracle documentation.
|
Item |
Description |
Specifiable value |
Default |
|---|---|---|---|
|
Monitoring-target Oracle system identifier (the same value as the value of the ORACLE_SID environment variable) |
A character string of 255 or fewer bytes that does not include the following characters:
|
The value specified for the -inst option of the jpcconf inst setup command |
|
|
Oracle home folder of Oracle Client used by PFM -RM for Oracle (the same value as the value of the ORACLE_HOME environment variable) #2 |
A character string of 255 or fewer bytes that does not include the following characters:
|
-- |
|
|
Version number of Oracle Client used by PFM - RM for Oracle To use Oracle Client 12c or later (about Oracle Client 18c) to monitor an Oracle Database, 12 is set. |
A two-digit number.
|
11 |
|
|
An account for monitoring Oracle . For details about accounts that can be specified and the required privileges, see (2) Create an Oracle account to be used in PFM - RM for Oracle. |
A character string of 255 or fewer bytes that does not include the following characters:
|
sys |
|
|
A password for the account that was specified in oracle_user |
A character string of 255 or fewer bytes that does not include the following characters:
|
-- |
|
|
The net service name of a monitoring-target database. For details about the net service name of a monitoring-target database, see your Oracle documentation. |
A character string of 255 or fewer bytes that does not include the following characters:
|
Instance name (the value of oracle_sid) |
|
|
The retry interval for re-establishing connection in the event of an authentication error during establishment of a connection with the Oracle system. If an authentication error occurs after the specified period has passed, the PFM - RM for Oracle service stops. When the value is 0, the PFM - RM for Oracle service stops without retrying to re-establish connection in the event of an authentication error. This item is enabled when startup_always is N. The specification of this item is ignored when startup_always is Y. |
0 to 600 (seconds) |
0 |
|
|
The absolute path name of the folder for storing agent log information |
A character string of 245 or fewer bytes that does not include the following characters:
|
installation-folder\agt1\agent\instance-name\log |
|
|
The maximum size of one agent log file#7 |
1 to 32 (in megabytes). The recommended value is 16 or greater. |
16 |
|
|
The timeout period for Oracle access during a query. |
0, or 10 to 3600 (in seconds). When 0 is specified, timeout monitoring is not performed. When a value from 1 to 9 is specified, it is changed to 10 at runtime. For details about timeouts, see 2.6.5 Cancellation facility for Oracle access during record collection. |
0 |
|
|
When Y is specified, information about the following items#9 is not collected for PI_PIDB and PD_PDTS records, and the value specified by 0 or numeric_10 is set. |
{ Y | N } |
N |
|
|
When sql_option is set to Y, the value specified is set for items for which information is not collected. If sql_option is set to N, this specification is disregarded. |
0 to 99999. Note that if the value specified exceeds the maximum value for the data format of the set field (32767 for short and 65535 for ushort), the maximum value for the data format is set.#11 |
0 |
|
|
startup_always |
PFM - RM for Oracle may stop due to an Oracle connection error, such as when the monitored Oracle is still starting up when PFM - RM for Oracle starts up. If Y is specified, start processing continues even if a connection error occurs. If N is specified, start processing will stop if an error occurs. |
{ Y | N } |
Y |
|
Option for switching the display of the free space of the locally managed temporary tablespace of PD_PDDB, PI_PIDB, PD_PDDF, PI_PIDF, PD_PDTF, PD_PDTS, and PD_PCTS records. If Y is specified, display the size of the free space. If N is specified, display the size of the unallocated space. |
{ Y | N } |
N |
|
|
Option for specifying the character encoding used for communication between PFM - RM for Oracle and Oracle Database. |
Character code set:
|
AMERICAN_AMERICA.US7ASCII |
|
|
Option for switching how the value displayed as the free space in the UNDO tablespace of the PD_PDDB, PI_PIDB, PD_PDDF, PI_PIDF, PD_PDTS, and PD_PCTS records is determined. If N is specified, the size of the unallocated space is displayed. If Y is specified, the size of the free space is displayed. |
{ Y | N } |
Y |
- Legend:
-
--: None
- #1
-
The prerequisite product for PFM - RM for Oracle version 10-50 or earlier was Oracle Client 32-bit. The prerequisite product for version 11-00 or later is Oracle Client 64-bit.
The setting method for version 10-50 or earlier cannot be used to connect to an Oracle Database. Therefore, you must set up PFM - RM for Oracle version 11-00 or later on the assumption that Oracle Client 64-bit is used.
Because instance information settings have been changed in version 11-00 or later as shown in the following table, make sure that the information is set up correctly:
Item
PFM - RM for Oracle
10-50 or earlier
11-00 or later
oracle_home
Specify the Oracle home folder for Oracle Client 32-bit.
Specify the Oracle home folder for Oracle Client 64-bit.
oracle_version
Specify the version of Oracle Client 32-bit.
Specify the version of Oracle Client 64-bit.
To use Oracle Client 12c or later (about Oracle Client 18c) to monitor an Oracle Database, 12 is set.
net_service_name
Specify the net service name that can be used to connect to the monitoring-target Oracle Database specified in Oracle Client 32-bit.
Specify the net service name that can be used to connect to the monitoring-target Oracle Database specified in Oracle Client 64-bit.
- Notes:
-
-
To upgrade PFM - RM for Oracle 10-50 or earlier to 11-00 or later, instance information is subject to change, and must therefore be updated before starting the PFM - RM for Oracle service.
Note that Oracle Client 32-bit is no longer needed, and can be uninstalled if it is not used by any product other than PFM - RM for Oracle.
-
If you specify ORACLE_HOME for Oracle Client 32-bit and start PFM - RM for Oracle, the KAVL18020-E message appears.
-
- #2
-
If PFM - RM for Oracle uses the client library of an Oracle Database (when Oracle Database 64-bit is installed on a server with PFM - RM for Oracle installed), specify the Oracle home folder of the Oracle Database.
- #3
-
PFM - RM for Oracle runs using Oracle password authentication.
- #4
-
If the expiration date is set on oracle_passwd, once the password is out of date connections to Oracle fail so that PFM - RM for Oracle cannot collect the performance information. In order to avoid connection errors, perform either of the following procedures before the password is expired:
-
Unset the expiration date of the password
-
After updating password, execute the jpcconf inst setup command to update oracle_passwd.
Note that the Oracle default profile is applied to the Oracle account created by mk_rmus.sql.
-
- #5
-
Specify in advance the network service (such as tnsnames.ora) of the Oracle Client used by PFM - RM for Oracle.
Configure the network service definition (such as listener.ora) and run the listener process in advance.
When monitoring Oracle Database instances in an Oracle RAC configuration, set up the PFM - RM for Oracle so that it monitors Oracle Database instances on each node. For details about how to set up, see the Oracle documentation.
Note that the location of tnsnames.ora must be:
oracle_home\network\admin
If tnsnames.ora is located on other folder, must therefore set to TNS_ADMIN
environment variable in starting user of PFM - RM for Oracle before
starting the PFM - RM for Oracle service.
For details about the TNS_ADMIN environment variable, see the Oracle
documentation.
If tnsnames.ora is located on other folder, PFM - RM for Oracle cannot connect to Oracle.
- #6
-
The path information before the change is not saved. Manually record this information as history data in a file. Depending on the problem, agent logs from the directory before the change might need to be obtained.
- #7
-
A maximum of 4 agent log files are collected for one instance. Before specifying the log_size value, make sure that the value satisfies the following condition (this condition also applies when log_path is set to the default):
Amount of free space on the drive containing the folder specified in log_path (MB) > log_size x 4
If the free disk space is insufficient, agent log cannot be output. For details about the agent log, see 7.3 Log information.
- #8
-
Set the timeout value according to the time needed to collect records during heavy load (peak time).
- #9
-
To obtain each piece of Oracle segment-related information, PFM - RM for Oracle searches Oracle's static data dictionary views DBA_SEGMENTS. If a large number of segments (more than hundreds of thousands) exist for Oracle, information collection requires a significant amount of time. As such, when a large number of segments exist, and the information listed in the following table no longer needs to be collected, set the sql_option to Y during operation.
Table 2‒7: Record names and the values specified for numeric_10 (setting up instance information) Record name
PFM - View name
Value specified for numeric_10
PD_PDTS
Segments
Enabled
Extents
Enabled
PI_PIDB
DB Files %
Enabled
Log Files %
Enabled
NextAlloc Fails
Enabled
Tablespaces
Enabled
Rollback Segments
Enabled
Rollback Segments Trans
Enabled
Blocks
Enabled
Segments
Enabled
Extents
Enabled
Free Mbytes
Enabled
Overextended
Enabled
High Max Extent
Enabled
Datafiles
Enabled
Mbytes
Enabled
Free Extents
Enabled
Free%
Enabled
Free Change
Enabled
Write%
Enabled
Write/sec
Enabled
Redo Files
Enabled
Links
Enabled
Links Logged On
Enabled
Links In Tran
Enabled
Links Open Cursors
Enabled
Used Change
Enabled
Used Mbytes
Enabled
Rollback Segments Hit%
Enabled
Sort Segments
Enabled
Sorting Users
Enabled
Physical Blocks Read
Always set to 0 because it is a delta item.
Physical Blocks Written
Always set to 0 because it is a delta item.
Physical Reads
Always set to 0 because it is a delta item.
Physical Writes
Always set to 0 because it is a delta item.
- #10
-
When displayed in PFM - Web Console, this item indicates whether the values set in each field in #9 are values collected from the Oracle Database, or fixed values.
- #11
-
If the field format for each record is float or double, since the data is a floating-point number, it may be rounded depending on the specified value.
Example:
When numeric_10 is set to 32767, it may be displayed as 32760.
- #12
-
When localtemp_option is set to Y, collect free space of the locally managed temporary tablespace and information about the extents from v$sort_segment or v$temp_extent_pool of the dynamic performance view. The displayed values of the size of free space are calculated from the size of the used space.
When localtemp_option is set to N, collect free space of the locally managed temporary tablespace and information about the extents from v$temp_space_header of the dynamic performance view. The displayed values of the size of free space are the size of the unallocated space. Since the allocated space is not freed until the temporary tablespace is reconstructed or recreated, the displayed values of free space do not increase until the space is freed.
When issuing query to v$temp_extent_pool view, the Oracle instance goes to sleep. Since this may have effect on the performance of the Oracle instance, you need adequate consideration before localtemp_option is set to Y. For details, see your Oracle documentation.
The following records use v$temp_extent_pool view:
-
Data File (PD_PDDF)
-
Data File Interval (PI_PIDF)
-
- #13
-
The following figure shows the relationship among data, language environment of the OS, and instance information handled by PFM - RM for Oracle.
Figure 2‒5: Relationship between data and the setting values ![[Figure]](GRAPHICS/ZUO02014.GIF)
PFM - RM for Oracle can collect performance data in SJIS (in Japanese Windows) and GB18030 (in Simplified-Chinese Windows) format as well as 7-bit ASCII format. You must specify nls_lang variable for the language environment of the OS, NLS_CHARACTERSET of the Oracle.
OS language of PFM - RM for Oracle installed
NLS_CHARACTERSET of the monitored Oracle (Database character set)
nls_lang instance information (this item)
Japanese
JA16SJISTILDE
AMERICAN_AMERICA.JA16SJISTILDE or AMERICAN_AMERICA.US7ASCII#
JA16SJIS
other
AMERICAN_AMERICA.US7ASCII#
Simplified-Chinese
ZHS16GBK
AMERICAN_AMERICA.ZHS32GB18030 or AMERICAN_AMERICA.US7ASCII#
AL32UTF8
other
AMERICAN_AMERICA.US7ASCII#
other language
notdependent
AMERICAN_AMERICA.US7ASCII#
- #
-
Performance data is collected within the scope of 7-bit ASCII characters, likely resulting in unreadable characters.
For any other combination, performance data is collected within the scope of 7-bit ASCII characters, likely resulting in unreadable characters.
When you specify an invalid character code set for the nls_lang instance information, the message KAVL18302-W with errcode 12705 is output, and the connection with Oracle will fail.
In the following cases as well, unreadable characters might occur in the performance data:
-
The Oracle column length is exceeded.
If you store data that exceeds the Oracle column length, the last character might become unreadable. If you use PFM - RM for Oracle to collect data in Oracle and that data contains unreadable characters, the last character of the performance data will be unreadable.
-
The field size of PFM - RM for Oracle is exceeded.
PFM - RM for Oracle collects performance data of the record field size from Oracle. Therefore, if Oracle contains data that exceeds the field size, the last character of the performance data might be unreadable. The following table lists the applicable fields:
Record name
Field name
Filed size (unit: bytes)
Parameter Values(PD_PDP)
Value
512
SQL Text(PD_PDSQ)
Explain Plan
30,000
SQL Text
30,000
- #14
-
When undospace_option is set to N, the size of the unallocated space is collected as the amount of free space in the UNDO tablespace. Space in the UNDO tablespace that becomes available because its retention period has expired is treated as allocated space until it is released.
When undospace_option is set to Y, the size of the free space is collected as the amount of free space in the UNDO tablespace. Space of the UNDO tablespace that becomes available because its retention period has expired is included in the size of the free space.
The following table shows the fields whose values change depending on the specification of the undospace_option:
Record name
Field name
Data File (PD_PDDF)
Free %
Free Mbytes
Used Mbytes
Data File Interval
(PI_PIDF)
Free %
Free Change
Free Mbytes
Used Change
Used Mbytes
Database (PD_PDDB)
Free %
Free Mbytes
Used Mbytes
Database Interval
(PI_PIDB)
Free %
Free Change
Free Mbytes
Used Change
Used Mbytes
Tablespace (PD_PDTS)
Free %
Free Mbytes
Used Mbytes
Max Extend Free %
Max Extend Free Mbytes
Collection Tablespace 2
(PD_PCTS)
Free Mbytes
- Notes:
-
-
The PFM - RM for Oracle services can be started only when an instance environment has been set up.
-
When you use the jpcconf inst setup command to create an instance environment, the command terminates normally even if an instance name that does not exist in Oracle is specified. However, if you then start record collection, message KAVL18401-W is output to the common message log, and you cannot connect to the monitored Oracle. If this problem occurs, check whether you specified the correct instance name, and re-execute the jpcconf inst setup command with the correct instance name specified.
-
Do not use multiple PFM - RM for Oracle services to monitor the same Oracle instance. Do not use PFM - RM for Oracle and PFM - Agent for Oracle to monitor the same Oracle instance.
-
Do not set Oracle9i as the monitoring target of PFM - RM for Oracle. If so, "KAVL18501-E" is output to the common message log and PFM - RM for Oracle stops.
-
An instance environment is created by using the jpcconf inst setup command. The following procedure shows how to create an instance environment.
To create an instance environment:
-
Execute the jpcconf inst setup command with a service key and instance name specified.
For example, when you want to create the instance environment for the PFM - RM for Oracle instance named SDC, use the following command line:
jpcconf inst setup -key RMOracle -inst SDC
Note that you cannot use sql as an instance name.
For details about the jpcconf inst setup command, see the chapter on commands in the manual JP1/Performance Management Reference.
-
Set up Oracle instance information for PFM - RM for Oracle.
Enter the values for the items listed in Table 2-6 as prompted by the command. All items are mandatory. To use the default value displayed for an item, only press the Enter key.
When all values have been entered, the instance environment is created. If you want to change the instance information, re-execute the jpcconf inst setup command to update the instance environment. For details about updating an instance environment, see 2.6.3 Updating an instance environment.
The following describes the created instance environment.
-
Folder configuration of the instance environment
The instance environment is set up in the following folders:
For a physical host: installation-folder\agt1
For a logical host: environment-folder#\jp1pc\agt1
- #
-
The environment folder is a folder on the shared disk specified when the logical host was created.
The following table describes the folder configuration of the created instance environment.
Table 2‒8: Folder configuration of the instance environment Folder and file
Description
agent
instance-name
jpcagt.ini
Remote Monitor Collector service startup initialization file
jpcagt.ini.model#
Model file for the Remote Monitor Collector service startup initialization file
status.dat
Relay file for internal processing
tstatuses.dat
Status information file for virtual agent
targetlist.ini
List file for monitoring target
grouplist.ini
List file for monitoring group
GARULES.DAT
List file containing a description of the grouping rules
targets
Storage folder for remote agent
groups
Storage folder for group agent
log
Storage folder for log files
store
instance-name
jpcsto.ini
Remote Monitor Store service startup initialization file
jpcsto.ini.model#
Model file for the Remote Monitor Store service startup initialization file
*.DB
Performance data file
*.IDX
Index file for performance data file
*.LCK
Lock file for performance data file
status.dat
Relay file for internal processing
*.DAT
Data model definition file
dump
Export destination folder
import
Standard database import destination folder
backup
Backup destination folder
log
Storage folder for log files
partial
Standard database partial backup destination folder
STPD
Performance data storage destination folder for records of the PD record type
STPI
Performance data storage destination folder for records of the PI record type
- #
-
This file is used to reset all values to the initial values set when the instance environment was created.
-
Service ID for the instance environment
The service for the instance environment has the following format:
-
Remote Monitor Collector service:
-
1Ainstance-number instance-name [host-name]
-
Remote Monitor Store service:
1S instance-number instance-name [host-name]
-
Group Agent service:
1Ainstance-number instance-name [ALL@host-name]
In PFM - RM for Oracle, the instance name specified in the jpcconf inst setup command is displayed.
For example, if you execute the command with host name host1 and instance name SDC, the service names will be as follows:
-
Remote Monitor Collector service:
1A1SDC [host1]
-
Remote Monitor Store service:
1S1SDC [host1]
-
Group Agent service:
1A1SDC [All@host1]
For details about the service ID, see the naming rules described in Appendix in the JP1/Performance Management Planning and Configuration Guide.
-
-
Windows service names in the instance environment
The Windows service names in the instance environment are as follows:
-
Remote Monitor Collector service:
-
PFM - RM for Oracle instance-name [logical-host-name]
-
Remote Monitor Store service:
-
PFM - RM Store for Oracle instance-name [logical-host-name]
For example, when the logical host name is lhost and the instance name is SDC, the service name will be:
-
Remote Monitor Collector service:
PFM - RM for Oracle SDC [lhost]
-
Remote Monitor Store service:
-
PFM - RM Store for Oracle SDC [lhost]
For details about Windows service names, see the naming rules described in Appendix in the JP1/Performance Management Planning and Configuration Guide.
For details about the Windows service names for logical host operation, in the JP1/Performance Management User's Guide, see the chapters explaining setup and operation for cluster systems.
-
(b) Set the monitoring target
When you set the monitoring target, you associate the instance that you specify in (a) Set up instance information with the information about the monitoring target host.
Set the monitoring target on PFM - RM host.
You must specify the information shown in the following table. Before you set the monitoring target, check the information in advance.
|
Item |
Description |
Specifiable value |
Default Value |
Changeable |
|---|---|---|---|---|
|
Target Host |
Oracle host name for monitoring target. If the Oracle host is a logical host, specify the logical host. |
Host names can consist of 1 to 32 alphanumeric characters and hyphen. Note that you cannot specify a (logical) host name beginning with a hyphen. Physical and logical host names must be unique within the system.#1 |
--#2 |
Changeable |
- Legend:
-
--: None
- #1
-
You cannot specify "ALL" because "ALL" is a reserved word for group agent.
- #2
-
If you omit the specification, the host name of the PFM - RM host is assumed.
- Notes:
-
-
You must set the monitoring target to start PFM - RM for Oracle.
If PFM - RM for Oracle starts without specifying the monitoring target, it outputs "KAVL18639-E" to the common message log and then stops.
-
PFM - RM for Oracle identifies the monitoring target Oracle instance by oracle_sid that is set in the instance environment.
The host name specified as Target Host is used only in a health check and is not used to connect to the Oracle instance.
If invalid host names are set to Target Host, the status for collecting performance data may not be consistent with the result of the health check.
-
Even if you set an invalid value for Target Host, the jpcconf target setup command ends successfully.
-
If you are running a firewall environment on the host of the monitoring target Oracle instance, set up the firewall environment so that the Oracle client used by PFM - RM for Oracle can successfully connect to the Oracle host. For details about Oracle environment setup, see your Oracle documentation. After Oracle environment setup, make sure that you can execute the Oracle sqlplus command in that environment.
-
In order to set up the monitoring target environment, execute the jpcconf target setup command.
To set up the monitoring target environment:
-
Execute the jpcconf target setup command specified with the service key, the instance name, and the monitoring target name.
jpcconf target setup -key RMOracle -inst instance-name -target monitoring-target-name
-
Specify the monitoring target information of PFM - RM for Oracle.
Enter the information shown in Table 2-9 in accordance with the command's instructions. You must enter all of the information items. To use the displayed default value, press the Enter key.
After you have finished entering the information, the monitoring target environment is set up in installation-folder\agt1. If you want to change the monitoring target information, re-execute the jpcconf target setup command and update the monitoring target environment. For details about updating the monitoring target environment, see 2.6.2 Updating a monitoring target.
Table 2-10 shows the organization of the monitoring target environment folder:
|
Folder name and file name |
Description |
|||
|---|---|---|---|---|
|
agent |
Instance name |
targets |
Monitoring-target-name.ini |
Configuration file for the monitoring target |
|
Monitoring-target-name.ini.model |
Model configuration file for the monitoring target |
|||
(c) Registering objects in the Oracle Database
To use PFM - RM for Oracle to monitor an Oracle Database, you must register the objects provided by PFM - RM for Oracle in the Oracle Database. The objects are registered by using an SQL script provided by PFM - RM for Oracle. The following procedure shows how to execute the SQL script. Note that the procedure is used only once for each account with which the Oracle Database instance is to be monitored.
If the monitoring target is Oracle Database 12c Release 2 or later in a CDB configuration, register objects in the PDBs to be monitored. If you use the sys account, execute the sp_rist.sql script for each PDB to be monitored. When monitoring the root container (CDB$ROOT), do not register objects in it because objects are not used for monitoring.
To execute the SQL script:
-
Set up an environment where the sqlplus Oracle command can be executed.
For details about Oracle environment setup, see your Oracle documentation.
-
Navigate to the following directory, which contains the sp_rist.sql file provided by PFM - RM for Oracle:
installation-folder\agt1\agent\sql
-
Execute the sp_rist.sql script for the Oracle Database that you want to monitor.
Connect to the Oracle Database by using the account specified by oracle_user in the instance information, and then execute the sp_rist.sql script.
The sp_inst.sql script will register with Oracle the objects (procedures for monitoring and tables for operation) PFM - RM for Oracle needs to perform Oracle monitoring.
Example:
- If the monitoring target is Oracle Database 12c Release 1 or earlier, or Oracle Database 12c Release 2 or later in a non-CDB configuration
-
sqlplus Oracle-account/password-for-the-Oracle-account@net-service-name-for-the-monitoring-target-database @sp_rist.sql
- If the monitoring target is Oracle Database 12c Release 2 or later in a CDB configuration
-
sqlplus Oracle-account/password-for-the-Oracle-account@net-service-name-for-the-monitoring-target-PDB @sp_rist.sql
-
The sqlplus command is provided by Oracle Corporation.
-
Specify the oracle_user value as the Oracle account. The objects are created in the database with the Oracle account used here. You must specify the same Oracle account when setup of the instance environment is canceled.
-
When you use a SYS user for the Oracle account, executing the sp_rist.sql script without specifying the AS SYSDBA option may result in an error. If an error occurs, execute the script with the AS SYSDBA option specified.
When the above command is executed, the table and packages shown in the following table are created.
Table 2‒11: Table and packages to be created Table
Package
LSC_14_PLAN_TABLE#
LSC_14_PDAS, LSC_14_73_PDDB, LSC_14_PDDB2, LSC_14_PDI, LSC_14_73_PIDB, LSC_14_PIDB2, LSC_14_PIDB3
- #
-
LSC_14_PLAN_TABLE is only used during collection of the SQL Text (PD_PDSQ) record. Therefore, when you collect the SQL Text (PD_PDSQ) record, make sure that at least 5 megabytes of free space is allocated to the default tablespace.
(d) Setting up the Oracle Database
To use the records provided by PFM - RM for Oracle to collect the performance data items listed in the following table, you must set the TIMED_STATISTICS Oracle Database initialization parameter to TRUE.
|
Record |
Field |
|---|---|
|
ASM Disk (PD_PDDK) |
Read Time (READ_TIME) |
|
Write Time (WRITE_TIME) |
|
|
Data File Interval (PI_PIDF) |
Write Time (WRITE_TIME) |
|
Session Detail (PD_PDS) |
Avg Wait (AVERAGE_WAIT) |
|
Avg Wait String (AVERAGE_WAIT_STRING) |
|
|
Time Waited (TIME_WAITED) |
|
|
Time Waited String (TIME_WAITED_STRING) |
|
|
Session Statistics Summary (PD_PDS2) |
Statement CPU (STATEMENT_CPU) |
|
System Stat Summary (PD) |
Session CPU Usage (SESSION_CPU_USAGE) |
|
System Stat Summary Interval (PI) |
Session CPU Usage (SESSION_CPU_USAGE) |
- Notes:
-
-
If you modify the initialization parameters file, you must restart the instance's database.
-
A value change you make in the server parameters file may take precedence over a change made to the initialization parameters file.
-
Setting the TIMED_STATISTICS initialization parameter to TRUE may have adverse effects on the performance of the Oracle Database. If you plan to use this setting, you should first evaluate the possible effects. For details, see your Oracle documentation.
-
(4) Specifying network settings
You must specify the network settings according to the configuration in which Performance Management is used.
The following are the two network setting items:
-
IP addresses
Set the IP addresses when using Performance Management in a network environment where multiple LANs are connected. You can set multiple IP addresses by defining the host names and IP addresses in the jpchosts file. Use the same jpchosts file throughout the Performance Management system.
For details, see the chapter on installation and setup in the JP1/Performance Management Planning and Configuration Guide.
-
Port numbers
Specify the port numbers to be used by Performance Management. To avoid conflicts, use the same port numbers and service names across the Performance Management system.
For details about setting port numbers, see the chapter on installation and setup in the JP1/Performance Management Planning and Configuration Guide.
(5) Change the size of log files
The operational status of Performance Management is output to Performance Management's own log file. This log file is called the common message log. Modify this setting if you want to change the file size.
For details, see the chapter explaining installation and setup in the JP1/Performance Management Planning and Configuration Guide.
(6) Change the storage location of performance data
Perform this setting if you want to change the folders where the database of performance data managed by PFM - RM for Oracle is saved, backed up, or exported.
By default, performance data is saved in the following locations:
-
Save destination folder: installation-folder\agt1\store\instance-name\
-
Backup destination folder: installation-folder\agt1\store\instance-name\backup\
-
Partial backup destination folder: installation-folder\agt1\store\instance-name\partial
-
Export destination folder: installation-folder\agt1\store\instance-name\dump\
-
Import destination folder: installation-folder\agt1\store\instance-name\import\
- Note:
-
For the default save destination for logical host operation, replace installation-folder with environment-folder\jp1pc.
For details, see 2.6.1 Changing the storage location of performance data.
(7) Set the connection-target PFM - Manager of PFM - RM for Oracle
On each host on which a PFM - RM for Oracle program is installed, set the connection-target PFM - Manager program that is to manage the PFM - RM for Oracle. Use the jpcconf mgrhost define command to set the connection-target PFM - Manager.
- Notes:
-
-
When multiple instances of PFM - RM are installed on a single host, you can specify only one PFM - Manager as their connection target. You cannot have a different instance of PFM - Manager as the connection target for each PFM - RM.
-
When PFM - RM for Oracle is installed on the same host as PFM - Manager, the connection-target PFM - Manager will be the PFM - Manager on the local host. You cannot change this.
-
To set the connection-target PFM - Manager:
-
Stop all Performance Management programs and services.
Stop all active Performance Management programs and services on the host before beginning setup. For details about how to stop services, see the chapter on starting and stopping Performance Management in the JP1/Performance Management User's Guide.
If any Performance Management programs or services are running when you execute the jpcconf mgrhost define command, you will be prompted by a message to stop the programs or services.
-
Execute the jpcconf mgrhost define command with the host name of the PFM - Manager host you wish to use specified as the connection target.
For example, if the PFM - Manager you wish to use as the connection target resides on host host01, execute the command as follows:
jpcconf mgrhost define -host host01
(8) Setting up the action log
This setting is required to output action logs when alarms occur. The action log stores history information that is output in conjunction with the alarms for thresholds related to system load and other conditions.
For details about how to set up the action log, see K. Outputting Action Log Information.