4.3.4 Setup procedure
This subsection describes how to set up Performance Management to run in a cluster system.
Setup must be performed first on the executing node and then on the standby node.
indicates a task to be performed on the executing node. indicates a task to be performed on the standby node. indicates a setup item that is required depending on the environment or an optional setup item used when the default is to be changed.
- Organization of this subsection
(1) Register PFM - Agent for Oracle
To perform integrated management of PFM - Agent for Oracle using PFM - Manager and PFM - Web Console, you must register PFM - Agent for Oracle with PFM - Manager and PFM - Web Console.
You will need to register PFM - Agent for Oracle in the following cases:
-
You add a new instance of PFM - Agent for Oracle to the Performance Management system.
-
You update the data model version of an instance of PFM - Agent for Oracle that is already registered.
Registration is performed separately for PFM - Manager and PFM - Web Console. The registration procedure is the same as in the registration procedure in a non-cluster system.
For details about the procedure, see 2.1.4(2) Register PFM - Agent for Oracle.
(2) Bring the shared disk online
Make sure that the shared disk is online. If the shared disk is not online, use the cluster software or the volume manager to bring it online.
(3) Set up the logical host environment for PFM - Agent
Execute the jpcconf ha setup command to set up the logical host environment. When you execute the command, the necessary files are copied to the shared disk, the logical host definition is set up, and the logical host environment is created.
- Note:
-
Before you execute the command, stop all Performance Management programs and services throughout the Performance Management system. For details about how to stop services, see the chapter on starting and stopping Performance Management in the JP1/Performance Management User's Guide.
To set up the logical host environment:
-
Execute the jpc conf ha setup command to create the logical host environment for PFM - Agent for Oracle.
Execute the command as follows:
jpcconf ha setup -key Oracle -lhost jp1-halora -d S:\jp1
Use the -lhost option to specify the logical host name. In the example above, the logical host name is jp1-halora. For DNS operation, specify a logical host name with the domain name portion removed.
Specify the name of the shared disk directory as the environment directory name of the -d option. For example, if you specify -d S:\jp1, the directory S:\jp1\jp1pc is created, and the files for the logical host environment are created in that directory.
- Notes:
-
- PFM - Agent for Oracle runs on file systems. When the database is built on RAW devices or ASM, the shared disk must be based on a file system.
- For the environment directory name, do not specify a path containing a parenthesis ((,)).
If the path contains a parenthesis, the logical host environment will be created successfully, but PFM - Agent for Oracle startup may fail.
-
Execute the jpcconf ha list command to check the logical host settings.
Execute the command as follows:
jpcconf ha list -key all
Confirm that the logical host environment you created has been set up correctly.
(4) Set the connection-target PFM - Manager
Execute the jpcconf mgrhost define command to specify which PFM - Manager is to manage PFM - Agent for Oracle.
-
Execute the jpcconf mgrhost define command to set the connection-target PFM - Manager.
Execute the command as follows:
jpcconf mgrhost define -host jp1-hal -lhost jp1-halora
Use the -host option to specify the host name of the connection-target PFM - Manager. If that PFM - Manager is running in a logical host environment, specify the logical host name of the PFM - Manager in the -host option. In the example above, the logical host name of PFM - Manager is jp1-hal.
Use the -lhost option to specify the logical host name of PFM - Agent for Oracle. In the example above, the logical host name of PFM - Agent for Oracle is jp1-halora.
Although an example of interactive command execution is shown here, the jpcconf mgrhost define command can be also executed non-interactively. For details about the jpcconf mgrhost define command, see the chapter that describes commands in the manual JP1/Performance Management Reference.
(5) Create an Oracle account to be used
Create an Oracle account that has specific system privileges to collect performance data for the Oracle Database monitored by PFM - Agent for Oracle.
For details about how to create an Oracle account, see 2.1.4(3) Create an Oracle account to be used in PFM - Agent for Oracle.
This setup task is unnecessary when you use the sys account.
(6) Set up an instance environment
Execute the jpcconf inst setup command to set up an instance environment for PFM - Agent for Oracle.
The setup procedure is the same as the setup procedure in a non-cluster system, except that, in a cluster system, you must specify the logical host name in the -lhost option when executing the jpcconf inst setup command.
In a cluster system, the jpcconf inst setup command is executed in the following format:
jpcconf inst setup -key Oracle -lhost logical-host-name -inst instance-name
Although an example of interactive command execution is shown here, the jpcconf inst setup command can be also executed non-interactively. For details about the jpcconf inst setup command, see the chapter that describes commands in the manual JP1/Performance Management Reference.
As the agent log output folder (the value of log_path), specify the path of a folder that is on the shared disk.
For details about other settings and procedures, see 2.1.4(4) Set up an instance environment.
(7) Set up the logical host environment for other Performance Management programs
At this point, set up any other Performance Management programs, such as PFM - Manager or PFM - Agent, on the same logical host.
For details about how to set up these products, see the chapters on setup and operation in a cluster system in the JP1/Performance Management User's Guide, and the chapter on operation in a cluster system in the manuals for the applicable version of PFM - Agent.
(8) Specify network settings
This setup task is necessary only when you change the network settings to match the configuration in which Performance Management is used.
The following are the two network setting items:
-
IP addresses
To specify the IP address used by Performance Management in a network environment where multiple LANs are connected, directly edit the contents of the jpchosts file.
After editing the file, copy it from the executing node to the standby node.
For details about how to set IP addresses, see the chapter on installation and setup in the JP1/Performance Management Planning and Configuration Guide.
-
Port numbers
If Performance Management programs will communicate with each other through a firewall, use the jpcconf port command to set the port numbers.
For details about how to set port numbers, see the chapter on installation and setup and the chapters on setup and operation in a cluster system in the JP1/Performance Management Planning and Configuration Guide.
(9) Change the size of log files
Performance Management outputs its operating status to a set of proprietary log files called a common message log. By default, the common message log consists of two 2,048 KB files. Perform this setting if you want to change the default file size.
For details, see the chapter on installation and setup in the JP1/Performance Management Planning and Configuration Guide.
(10) Change the storage location of performance data
Perform this setting only if you want to change the folders where the database of performance data managed by PFM - Agent for Oracle is saved, backed up, exported, or imported.
For details, see 2.4.1 Changing the storage location of performance data.
(11) Setting up the action log
This setting is required to output action log when alarm 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.
(12) Export the logical-host environment definition file
Once you have created the logical host environment for PFM - Agent for Oracle, export the environment definition as a file. In the export process, a file containing the collective definition information for all Performance Management programs set up on that logical host is output. Export the environment definition only after you have set up all additional Performance Management programs on the logical host.
To export the environment definition of the logical host:
-
Execute the jpcconf ha export command to export the environment definition of the logical host.
The definition information for the logical host environment you created is output to an export file. You can give this file any name you wish.
For example, execute the command as follows to output the logical host environment definition to the file lhostexp.txt:
jpcconf ha export -f lhostexp.txt
Although an example of interactive command execution is shown here, the jpcconf ha export command can be also executed non-interactively. For details about the jpcconf ha export command, see the chapter that describes commands in the manual JP1/Performance Management Reference.
(13) Copy the logical-host environment definition file to the standby node
Copy the file you exported in (12) Export the logical-host environment definition file from the executing node to the standby node.
(14) Take the shared disk offline
Use the cluster software or the volume manager to take the shared disk offline. Note that if you intend to continue using the shared disk, you do not need to take it offline at this point.
(15) Import the logical-host environment definition file
On the standby node, import the exported file you copied from the executing node.
Use the jpcconf ha import command to set up the environment definition for the Performance Management programs of the logical host that you created on the executing node so that they run on the standby node. If more than one Performance Management program was installed on the logical host, the definition information for all of the programs is imported in batch form.
Note that the shared disk does not need to be online when you execute this command.
To import the logical-host environment definition file:
-
Execute the jpcconf ha import command to import the environment definition of the logical host.
jpcconf ha import -f lhostexp.txt
Although an example of interactive command execution is shown here, the jpcconf ha import command can be also executed non-interactively. For details about the jpcconf ha import command, see the chapter that describes commands in the manual JP1/Performance Management Reference.
When you execute the command, the settings on the standby node are changed to reflect the environment described in the export file. This sets up the standby node to run PFM - Agent for Oracle as a logical host.
If you used the jpcconf port command to assign fixed port numbers during setup, the same port numbers will take effect on the standby node.
-
Execute the jpcconf ha list command to check whether the logical host is set up correctly.
Execute the command as follows:
jpcconf ha list -key all
Check whether the same output is displayed as when you executed jpcconf ha list on the executing node.
(16) Register PFM - Agent for Oracle in the cluster software
If you intend to use Performance Management programs in a logical host environment, make sure that the programs are registered in the cluster software. Also, set up the environment so that the Performance Management programs are started and stopped based on instructions from the cluster software.
- Note:
-
Before you can register PFM - Agent for Oracle, you must register Oracle Database resource.
For details about how to register PFM - Agent for Oracle in the cluster software, see your cluster software documentation.
This subsection describes how to register PFM - Agent for Oracle in your cluster software, using the settings for Windows MSCS as an example.
Register the following services of PFM - Agent for Oracle in the cluster software:
No. |
Name |
Service name |
Dependencies |
---|---|---|---|
1 |
PFM - Agent Store for Oracle instance-name [LHOST] |
JP1PCAGT_OS_instance-name [LHOST] |
IP address resource#1 Physical disk resource#2 Oracle Database resource |
2 |
PFM - Agent for Oracle instance-name [LHOST] |
JP1PCAGT_OA_instance-name [LHOST] |
Cluster resource in No. 1 |
3 |
PFM - Action Handler [LHOST] |
JP1PCMGR_PH [LHOST] |
IP address resource#1 Physical disk resource#2 |
- #1
-
IP address resource defined in the Oracle cluster environment
- #2
-
Shared disk resource
Replace LHOST with the logical host name. For example, if the instance name is SDC1 and the logical host name is jp1-halora, the display name of the service will be PFM - Agent Store for Oracle SDC1 [jp1-halora], and the service name will be JP1PCAGT_OS_SDC1 [jp1-halora].
When using MSCS as your cluster software, register the services as MSCS resources. Set up each resource according to the instructions below. Text in bold indicates a setting you perform in MSCS.
-
Register the service with Resource type set to General-Purpose service.
-
Set Name, Dependency, and Service Name as shown in Table 4-3.
Note that the Name in the table is the display name of the service, and the Service name is the name MSCS uses to specify the service when issuing instructions. In any of the following cases, for PFM - Agent Store for Oracle instance-name [LHOST], specify a dependency with Oracle TNS Listener:
-
When you want to monitor alarms or resources of the listener
-
When there is an Oracle service that is running with an account other than the local system account
-
When you specify Y for the instance item sqlnet in the instance environment settings
If you do not specify a dependency with Oracle TNS Listener in these cases, an error might occur in Oracle.
-
-
Do not specify the Startup Parameter and Duplicate Registry settings.
-
On the Details page of the Properties dialog box, choose how you want MSCS to behave when an error occurs in a Performance Management program.
For example, if you want MSCS to fail over the node when PFM - Agent for Oracle fails, perform the following settings:
Restart: Select this check box.
Apply to Group: Select this check box.
Threshold for the restart retry count: 3#
- #
-
Usually, specify 3 as the Threshold for the restart retry count.
- Note:
-
The cluster software is responsible for starting and stopping the services that have been registered in it. Set Startup type for those services to Manual to prevent them from starting automatically when the OS starts. When you set up a service using the jpcconf ha setup command, Startup type for the service will be set to Manual. Also, do not use the following command to forcibly stop a service registered in the cluster software:
jpcspm stop -key all -lhost logical-host-name -kill immediate
(17) Check whether services can be started and stopped from the cluster software
Check whether the cluster software is operating correctly by using it to issue start and stop requests to Performance Management programs on each node.
(18) Set up the environment in the cluster system
After setting up the Performance Management programs, use PFM - Web Console to set up the environment for the programs. You will then be able to display reports on the operating status of monitoring targets, and notify users whenever a problem occurs.
For details about setting up the environment for Performance Management programs, see the chapters on setup and operation in a cluster system in the JP1/Performance Management User's Guide.