1. Monitor and analyze Oracle E-Business Suite health and performance
  2. Perform Generic Prerequisite Tasks

Perform Generic Prerequisite Tasks

To set up Oracle Management Cloud to monitor your Oracle E-Business Suite environment, you need to perform a set of generic tasks.

Enable the Enterprise Edition License

Oracle Management Cloud offerings are categorized and available in different license editions, including the Enterprise Edition.

The Oracle Management Cloud – Enterprise Edition offers the following:

  • Oracle Application Performance Monitoring: Provides a platform for monitoring and managing applications.

  • Oracle Infrastructure Monitoring: Monitors the status and health of the entire information technology infrastructure from a single platform and alerts administrators about issues.

  • Oracle Orchestration: Automates cloud and on-premises infrastructure and executes tasks by calling REST APIs or by using third-party automation frameworks.

  • Oracle IT Analytics: Provides a 360-degree insight into the performance, availability, and capacity of applications and infrastructure investments.

Enable Oracle Management Cloud - Enterprise Edition for both the host Oracle Cloud Infrastructure system and for Oracle E-Business Suite.

  1. Log into the Oracle Management Cloud console as an Oracle Management Cloud Administrator.
    If the Management Cloud navigation pane isn’t displayed, then click the OMC Navigation icon on the top-left corner.
  2. From the Oracle Management Cloud console navigation pane, click Administration and then click Entity Configuration.
  3. Click Licensing and then click Select Entities.
  4. Locate and select the required entities and then click the Select button.
  5. Select Enterprise Edition for each entity listed or click License Edition and select Set All to Enterprise.
  6. Click Save.

Install the Oracle Management Cloud Agents

Install Oracle Management Cloud agents that retrieve monitoring metrics.

  • Gateway agent: Install the gateway agent on a host that has Internet access to Oracle Management Cloud and can be reached by all hosts where cloud agents are deployed. All Oracle Management Cloud agents should use a common gateway.

  • Cloud agents: Install cloud agents on each host in the Oracle E-Business Suite topology to monitor and collect data (for example, metrics, configuration information, and logs) from entities that reside on those hosts.

Before You Install Agents

Before you install agents on Oracle E-Business Suite, make sure you address the following considerations.

For the Agent Base Directory where you install an agent:

  • Ensure that only the root user and agent installation user have write permission on the Agent Base Directory and its parent directory even after the agent installation. This makes sure that all agent life cycle operations such as update or delete complete successfully.

  • If the Agent Base Directory is created before the installation, make sure that the directory is empty. The agent installation user must have write access to the directory.

  • If the Agent Base Directory is not created before installation, it is created by default under the directory where the agent software zip file is extracted. Make sure that the agent installation user has write access to the parent directory where the Agent Base Directory is created.

Create or Download a Registration Key

A registration key is issued against your identity domain and it’s used when you deploy cloud agents. Once an agent is installed with the registration key, you can remove the key from Oracle Management Cloud.

When you create a registration key, you specify a usage count for the key. A key expires when the usage count is greater or equal to the maximum usage specified when the key was created.

  1. Log into the Oracle Management Cloud console as an Oracle Management Cloud Administrator.
    If the Management Cloud navigation pane isn’t displayed, then click the OMC Navigation icon on the top-left corner.
  2. From the Oracle Management Cloud console navigation pane, click Administration and then click Agents.
  3. Click the menu on the right and then select Manage Registration Keys.
  4. Create a new registration key by entering the required details in the Registration Keys page and then clicking Create New Key.
  5. To download an existing registration key, perform the following steps:
    1. From the list of registration keys, locate the key that you want to download.
    2. Click the actions menu on the right side of the page, then select Download.
      A text file registrationKey.txt that contains the value of the registration key is downloaded to your local drive. To view the key value, open the registrationKey.txt file.
You will add the key value in the AGENT_REGISTRATION_KEY parameter in the response file.

Download the Gateway Agent

Use the Oracle Management Cloud console to download the gateway agent software install bundle ZIP files onto your host.

When you extract the gateway ZIP file, a sample response file, gateway.rsp, is provided as a template.

  1. Log into the Oracle Management Cloud console as an Oracle Management Cloud Administrator.
    If the Management Cloud navigation pane isn’t displayed, then click the OMC Navigation icon on the top-left corner.
  2. From the Oracle Management Cloud console navigation pane, click Administration and then click Agents.
  3. Click the menu on the right and select Download Agents.
  4. Click Agent Type and then select Gateway.
  5. Click Operating System and then select the operating system where you want to install the agent.
  6. Make a note of the TENANT_NAME and OMC_URL parameter values displayed under the agent link. When installing the gateway agent, you’ll need to update the response file with these values.
  7. Click the agent software link for your operating system to download the gateway software ZIP file.
  8. Verify that the downloaded ZIP file is complete by comparing the SHA1 checksum value for the downloaded file to that listed for the agent on the agent download page:
    sha1sum <agent_binary_filename>.zip
    The value of the SHA1 Checksum column in the user interface should match the output.
  9. Navigate to the directory where you have downloaded the software bundle and unzip the software.
    unzip <agent_binary_filename>.zip

Download the Cloud Agent

Use the Oracle Management Cloud console to download the cloud agent software install bundle ZIP files onto your host.

When you extract the agent ZIP file, a sample response file, agent.rsp, is provided as a template.

  1. Log into the Oracle Management Cloud console as an Oracle Management Cloud Administrator.
    If the Management Cloud navigation pane isn’t displayed, then click the OMC Navigation icon on the top-left corner.
  2. From the Oracle Management Cloud console navigation pane, click Administration and then click Agents.
  3. Click the menu on the right and select Download Agents.
  4. Click Agent Type and then select Cloud Agent.
  5. Click Operating System and then select the operating system where you want to install the agent.
  6. Make a note of the TENANT_NAME and OMC_URL parameter values displayed under the agent link. When installing the gateway agent, you’ll need to update the response file with these values.
  7. Click the agent software link for your operating system to download the gateway software ZIP file.
  8. Verify that the downloaded ZIP file is complete by comparing the SHA1 checksum value for the downloaded file to that listed for the agent on the agent download page:
    sha1sum <agent_binary_filename>.zip
    The value of the SHA1 Checksum column in the user interface should match the output.
  9. Navigate to the directory where you have downloaded the software bundle and unzip the software.
    unzip <agent_binary_filename>.zip

Install the Gateway Agent

A gateway agent acts as a secured channel between Oracle Management Cloud and all other Oracle Management Cloud agents.

To install a gateway agent:

  1. Edit the gateway response file, gateway.rsp (that you obtained when you downloaded and extracted the gateway ZIP file), in a text editor and provide values for the parameters that are required to install a gateway.

    The following table lists the parameters required for gateway installation.

    Parameter Description

    TENANT_NAME

    or

    TENANT_ID (supported in older versions and it remains backwards compatible)

    Name of the tenant where Oracle Management Cloud is running. You can get the TENANT_NAME value for an agent by navigating to Administration > Agents > Download, and selecting an agent type from the Agent Type drop-down list. The TENANT_NAME value is displayed at the bottom of the page.

    OMC_URL

    or

    UPLOAD_ROOT (supported in older versions and it remains backwards compatible)

    The absolute URL including the protocol that is required to connect to Oracle Management Cloud for uploading data for the specific TENANT_NAME. To get this value, navigate to Administration > Agents > Download, and select an agent type from the Agent Type drop-down list. The OMC_URL value is displayed at the bottom of the page.

    AGENT_REGISTRATION_KEY

    Key to validate the identity of the tenant and the authenticity of the installation. You can get the registration key from Oracle Management Cloud Dashboard, by navigating to Administration > Agents > Registration Keys.

    AGENT_BASE_DIRECTORY

    Empty directory where the agent must be installed on the host machine. If the given directory is not present, then a directory is created during installation.

    Note: For Windows, the length of the directory path including the drive letter should be less than 23 characters.

  2. Save the response file.
  3. Run a prerequisite check to validate the parameters. Use the command line interface to run the AgentInstall.sh script passing the parameter EXECUTE_PREREQ=true.
    $ ./AgentInstall.sh EXECUTE_PREREQ=true
Unzipping agent software, this may take some time...
Installing Gateway...
Executing Pre-requisite checks only for Gateway..
Gateway parameter validation started...
Gateway pre-requisite checks started...
Pre-requisite checks successfully completed for [Gateway].

    The script runs the prerequisite check. If the prerequisite check fails, then the script stops with relevant error message.

    See the log file located under <AGENT_ZIP_FILE_EXTRACTED_DIRECTORY>/AgentInstall_<timestamp>.log for more details. Fix any errors before installing the gateway.

  4. Install the agent by running the AgentInstall.sh script with the response file name as a parameter.

    ./AgentInstall.sh AGENT_RSP_FILE=<absolute path to the gateway.rsp file>

Install the Cloud Agent

A cloud agent collects the entity data from the host where you deploy the cloud agent.

Cloud agent installation requires fully qualified domain names (FQDN) for your hosts. For UNIX environments, add the FQDN in the /etc/hosts file and ensure that it maps to the correct host name and IP address of the host.

Note: Install the cloud agent on each of the application tier hosts and database hosts.

To install a cloud agent:

  1. Edit the cloud agent response file, agent.rsp (that you obtained when you downloaded and extracted the cloud agent ZIP file), in a text editor and provide values for the parameters that are required to install a cloud agent.

    The following table lists the parameters required over and above the gateway installation parameters listed earlier for a cloud agent installation that uses a gateway to communicate with Oracle Management Cloud over a proxy server.

    Parameter Description

    GATEWAY_HOST

    If cloud agent is communicating to Oracle Management Cloud using a gateway, then provide the Fully Qualified Domain Name (FQDN) of the gateway. When you install the cloud agent, make sure you provide the same gateway host name that was used to install the gateway.

    For example, when deploying the gateway, if you specify ORACLE_HOSTANME=abc.xyz.com and when installing the cloud agent, you specify GATEWAY_HOST=abc, it will result in cloud agent registration failures. A gateway agent must be installed on the host and be up and running.

    GATEWAY_PORT

    When a cloud agent uses a gateway to communicate with Oracle Management Cloud, you must specify the gateway port.

    You can obtain the port number by executing the following command:

    $Gateway_Agent_Home/agent_inst/bin/omcli status agent

    OMC_PROXYHOST

    Address of your proxy server to be used for connection. Ensure that you don't pass the https:// value with the proxy host details.

    OMC_PROXYPORT

    Port of your proxy server.

    OMC_PROXYUSER

    User name required to access your proxy server.

    OMC_PROXYPWD

    Password required to access your proxy server.

    OMC_PROXYREALM

    Authentication realm (if any) to be used to access your proxy server.

    AGENT_PORT

    The port number to which the agent process will be bound. The AgentInstall script stops the installation process if this port is occupied at the time of installation.

  2. Save the response file.
  3. Run a prerequisite check to validate the parameters. Use the command line interface to run the AgentInstall.sh script passing the parameter EXECUTE_PREREQ=true.
    $ ./AgentInstall.sh EXECUTE_PREREQ=true
Unzipping agent software, this may take some time...
Installing Gateway...
Executing Pre-requisite checks only for Gateway..
Gateway parameter validation started...
Gateway pre-requisite checks started...
Pre-requisite checks successfully completed.

    The script runs the prerequisite check. If the prerequisite check fails, then the script stops with relevant error message.

  4. Install the agent by running the AgentInstall.sh script with the response file name as a parameter.

    ./AgentInstall.sh AGENT_RSP_FILE=<absolute path to the agent.rsp file>

Verify Agent Installation

After installing the gateway and cloud agent, verify that the agents were successfully deployed.

  1. Log into the Oracle Management Cloud console as an Oracle Management Cloud Administrator.
    If the Management Cloud navigation pane isn’t displayed, then click the OMC Navigation icon on the top-left corner.
  2. From the Oracle Management Cloud console navigation pane, click Administration and then click Agents.
  3. Click the tab for the agent type, such as Gateways or Cloud Agents.
  4. Verify that the host name of your deployed gateway or cloud agent exists in the list of available agents.