3.1.2 Preparation for installing and setting up PFM - Agent for Oracle

(a) IP addresssettings

The PFM - Agent for Oracle host must be set up in a network environment where IP addresses can be resolved from host names. PFM - Agent for Oracle will not start in an environment where IP addresses cannot be resolved.

PFM - Agent for Oracle can run in an IPv6 environment and dual stack environment in addition to an IPv4 environment. To run PFM - Agent for Oracle in an IPv6 environment, the monitored Oracle database must support IPv6 environments.

You can use the real host name or the alias name as a monitoring host name (a host name used in Performance Management system).

• When using a real host name

  Execute the hostname command on a Windows system or uname -n command on a UNIX system to check the host name, and set up the environment so that it can resolve IP addresses. Note that on a UNIX system, the host name obtained by the hostname command can also be used.

• When using an alias name

  Set up the environment so that an IP address can be resolved from the specified alias name.

For details about the configuration of a monitoring host name, see the chapter on installation and setup in the JP1/Performance Management Planning and Configuration Guide.

Use one of the following methods to set the host name and IP address of a host monitored by Performance Management programs:

• Host information settings file for Performance Management (jpchosts file)

• hosts file

• DNS (Domain Name System)

Notes on setting IP addresses:

• Although the Performance Management programs and PFM - Agent for Oracle can operate in a DNS environment, they do not support host names in FQDN (Fully Qualified Domain Name) format. When you specify an IP address, use the host name returned by the hostname command after removing the domain name portion.

• If you intend to use Performance Management within multiple LAN environments, set the IP addresses in the jpchosts file. For details, see the chapter on installation and setup in the JP1/Performance Management Planning and Configuration Guide.

• Performance Management cannot operate on the hosts to which IP addresses are assigned dynamically by DHCP. Make sure that all the hosts on which Performance Management programs are installed are configured with user-specified static IP addresses.

Performance Management supports IPv6 environments as well as IPv4 environments as a network configuration. Therefore, Performance Management can operate even in a network configuration in which both an IPv4 environment and an IPv6 environment are used.

PFM - Agent for Oracle can communicate with PFM - Manager via IPv6. Note that this explanation applies only when the OS of a host on which PFM - Agent for Oracle and PFM - Manager are installed is Windows or Linux.

For details about the scope of communication in an environment with both IPv4 and IPv6, see M. About Communication in IPv4 Environments and IPv6 Environments.

When you want to use IPv6 for communication between PFM - Manager and PFM - Agent for Oracle, the settings for using IPv6 must be enabled for both the PFM - Manager host and the PFM - Agent host. In addition, before installing PFM - Agent for Oracle, you need to enable the use of IPv6 on the PFM - Agent host. You have to execute the jpcconf ipv6 enable command to enable this setting. If this setting is already enabled, however, you do not need to execute the command. If you want to check whether the use of IPv6 is enabled, execute the jpcconf ipv6 display command.

For details about the jpcconf ipv6 enable command and jpcconf ipv6 display command, see the chapter that describes commands in the manual JP1/Performance Management Reference. For details about the conditions or occasions for executing the jpcconf ipv6 enable command, see the chapter that describes network configuration examples in an environment that includes IPv6 in the JP1/Performance Management Planning and Configuration Guide.

When you use IPv6 for communication between a monitored host and PFM - Agent for Oracle, specify the name of a monitored host where name resolution can be performed.

Communication between PFM - Agent for Oracle and a monitoring target is performed with an IP address that can be resolved. Also, if an IPv4 environment and an IPv6 environment are both used, and communication between PFM - Agent for Oracle and the monitoring target fails with an IP address that can be resolved, the communication is not retried by using another IP address.

For example, if communication fails when IPv4 is used, IPv6 is not used to retry communication. Similarly, if communication fails when IPv6 is used, IPv4 is not used to retry communication. Make sure beforehand that a connection can be established.

(b) Port number settings

The following table shows the default port numbers assigned to the services of Performance Management programs. For other services and programs, available port numbers are automatically assigned each time they are started. If you use Performance Management in a firewall environment, use fixed port numbers. For details about how to set fixed port numbers, see the chapter on installation and setup in the JP1/Performance Management Planning and Configuration Guide.

Table 3‒1: Default port numbers for Performance Management program services (in UNIX)

Service description	Service name	Parameter	Port number	Remarks
Service configuration information management facility	Name Server	jp1pcnsvr	22285	The port number used by the Name Server service of PFM - Manager. This port is set up on every Performance Management host.
Service status management facility	Status Server	jp1pcstatsvr	22350	The port number used by the Status Server service of PFM - Manager and PFM - Base. This port is set up on the hosts on which PFM - Manager and PFM - Base are installed.
Monitoring console communication facility	View Server	jp1pcvsvr	22286	The port number used by the View Server service of PFM - Manager. This port is set up on the hosts on which PFM - Manager is installed.
Web service facility	Web Service	--	20358	The port number used by the Web Service service of PFM - Web Console.
Web container facility	Web Console	--	20359 20360	The port number used by the Web Console service of PFM - Web Console.
JP1/SLM linkage facility	JP1/ITSLM	--	20905	The port number set by JP1/SLM.

Legend:

--: None

Ensure that the network is set up to allow communication using these port numbers, which are used by PFM - Agent for Oracle.

(a) Monitoring target programs

The monitoring target programs of PFM - Agent for Oracle are as follows:

• Oracle Database Standard Edition

• Oracle Database Standard Edition One

• Oracle Database Standard Edition 2

• Oracle Database Enterprise Edition

To monitor this program, it must be installed on the same host as PFM - Agent for Oracle.

Note that when a monitoring target program running on a virtualized OS is being monitored, PFM - Agent for Oracle monitors what the monitoring target program can perform on the virtualized OS.

(b) Performance Management programs

Install PFM - Agent and PFM - Base on the PFM - Agent host.

PFM - Base is a prerequisite program for PFM - Agent. Only one instance of PFM - Base is required, even when multiple instances of PFM - Agent are installed on one host.

Note that you do not need to install PFM - Base if PFM - Manager and PFM - Agent are installed on the same host.

To monitor Oracle operation using PFM - Agent for Oracle, PFM - Manager and PFM - Web Console are required.

(a) Precautions regarding environment variables

Because Performance Management uses JPC_HOSTNAME as an environment variable, do not set it as a user-specific environment variable, as this will prevent Performance Management from operating properly.

(b) Notes on installing and setting up multiple Performance Management programs on same host

With Performance Management, you can install PFM - Manager, PFM - Web Console, and PFM - Agent on the same host. When doing so, note the following:

• When PFM - Manager and PFM - Agent are installed on the same host, PFM - Base is not required. In this case, PFM - Manager is a prerequisite program for PFM - Agent and must be installed before PFM - Agent is installed.

• You cannot install PFM - Base and PFM - Manager on the same host. If you want to install PFM - Manager on a host on which PFM - Base and PFM - Agent are already installed, uninstall all Performance Management programs, and then install PFM - Manager and PFM - Agent in that order. The same applies when you install PFM - Base on a host on which PFM - Manager and PFM - Agent are already installed: you must uninstall all Performance Management programs, and then install PFM - Base and PFM - Agent in that order.

• If you install PFM - Agent on a host on which PFM - Manager is already installed, the connection-target PFM - Manager will be the instance of PFM - Manager on the local host, and cannot change it to that on the remote host. If you want PFM - Agent to connect to PFM - Manager on a remote host, ensure that PFM - Manager is not installed on the host on which you install PFM - Agent.

• If you install PFM - Manager on a host on which PFM - Agent is already installed, the connection-target PFM - Manager is reset to the local host. See the setting results that are output to the common message log.

• If you install PFM - Agent on a host on which PFM - Web Console is already installed, close all the browser windows before you install the program.

• When you perform a new installation of a Performance Management program, the status management facility will be enabled by default. However, if you upgrade from version 07-50 to 08-00 or newer, the settings for the status management function remain the same as they were in the older version. To change the setting of the status management facility, see the chapter on error detection for Performance Management in the JP1/Performance Management User's Guide.

  Tip

  To improve system performance and reliability, we recommend running PFM - Manager, PFM - Web Console, and PFM - Agent on separate hosts.

(c) Notes on upgrading PFM - Agent for Oracle

Before you perform version upgrade installation, you need to perform the procedure described in 3.2.2(1)(b) Deleting the objects registered in the Oracle Database. Complete version upgrade installation and then perform the procedure in 3.1.4(4)(b) Registering objects in the Oracle Database.

For details about notes on upgrading the versions of Performance Management programs, see the section describing the notes on version upgrading in the chapter that explains installation and setup in the JP1/Performance Management Planning and Configuration Guide.

For details about notes on upgrading the version of PFM - Agent for Oracle, see H. Migration Procedure and Notes on Migration.

For details about upgrading, see the JP1/Performance Management Planning and Configuration Guide.

If you delete the objects after the upgrade installation finishes rather than before the upgrade installation starts, the following message appears:

ORA-04043: object LSC_13_PDDB2 does not exist, ORA-04043: object LSC_13_PIDB2 does not exist, ORA-04043: object LSC_13_PIDB3 does not exist, see 3.2.2(1)(b) Deleting the objects registered in the Oracle Database. This message, however, does not indicate a serious problem. Even if this message appears, proceed to register the objects again, see 3.1.4(4)(b) Registering objects in the Oracle Database.

(d) Other cautionary notes

• When the monitoring-target program is Oracle Database 12c Release 1, you cannot monitor a multitenant container database (CDB) and can monitor a non-CDB.

• When the monitoring-target program is Oracle Database 12c Release 2 or later, in addition to the program in a traditional non-CDB environment, PDBs and the root container (CDB$ROOT) in a CDB environment can be monitored. Monitoring application containers (an application root and application PDBs) is not supported.

• When you install Performance Management programs, check whether the following security-related programs are installed. If they have been installed, take appropriate action according to the following explanation.

  • Security monitoring program

    Stop the security monitoring program or change the settings so that the installation of Performance Management programs will not be interrupted.

  • Virus detection program

    Stop the virus detection program before you install Performance Management programs.

    If a virus detection program is running during the installation of Performance Management programs, the installation processing might slow down, installation might not be executable, or the programs might not be able to be installed correctly.

  • Process monitoring program

    Stop the process monitoring program or change the settings. Also, specify settings that prevent the services or processes of Performance Management and common components from being monitored.

    If the process monitoring program starts or stops these services or processes during the installation of Performance Management programs, installation might fail.

• When you perform a new installation of PFM - Agent for Oracle in an environment where no other Performance Management program has been installed, make sure that there are no files or folders in the installation folder.

• If installation fails and Install failed is displayed on the installation status bar as a result, acquire the /etc/.hitachi/.hitachi.log file. Note that this log file is overwritten every time installation is performed. If you want to keep its contents, you will have to back it up. For the default file name for the installation log file, see 8.4.2(2) Information about Performance Management.

• If you install Performance Management programs in a directory linked to another directory, some files and directories may remain when the programs are uninstalled. If files and directories remain, delete them manually. When Performance Management programs are installed in the link-target directory, any existing files and directories whose names are the same as the names of the files and directories being installed will be overwritten.

• If the /opt/jp1pc/setup directory contains the setup file for PFM - Agent for Oracle, additional setup for a new instance of PFM - Agent for Oracle is performed. When additional setup of PFM - Agent for Oracle is successful, message KAVE05908-I New agent setup (pfm-agent-service-key) ended successfully is output to the common message log. Check whether this message has been output.

• In Linux, this software is a Hitachi program product that conforms to the disk copy installation of JP1/ServerConductor/Deployment Manager and Hitachi Compute Systems Manager Deployment Manager Plug-in, or the copy functionality using conversion to image files that is provided by a virtual platform. About the disk copy installation, see notes on installing replicated disks in the manual JP1/Performance Management Planning and Configuration Guide.

• In Solaris or AIX, monitoring Oracle Database 11g Release 2 or later means that the Oracle Client 32-bit library is used. In this case, you have to install one of the following products on the machine and build an environment for it:

  • Oracle Database 11g Release 2 Client (32-bit) or later

  If you start PFM - Agent for Oracle with the ORACLE_HOME of Oracle Database 11g Release 2 or later,or Oracle Client 64-bit specified as the Oracle instance information item oracle_home, the following messages are output to the common message log:

  KAVF12011-E Initialization of interprocess communication failed.

  KAVF12021-E Error occurred by function function-name. (en=error-code, arg1=argument-1, arg2=argument-2, arg3=argument-3)

  Note:

  PFM - Agent for Oracle does not support Oracle Instant Client. Select either Administrator or Runtime as the Oracle Client installation type. If you have installed Instant Client on an ORACLE_HOME by mistake, do not install an Oracle Client on the same ORACLE_HOME with Administrator or Runtime selected as the installation type.

  You have to install the Oracle Client on another ORACLE_HOME, or delete the

  Instant Client before installing the Oracle Client.