Oracle Cloud Infrastructure Documentation

Installing the Agent

Learn about how to install the Unified Monitoring Agent, whether for new instances, existing instances, or instances created from custom images, and non-Oracle Cloud Infrastructure instances.

New Oracle Cloud Infrastructure Instances

For supported operating systems, you can enable the agent directly during creation time. The Custom Logs Monitoring plugin must be enabled, and all plugins must be running. See Oracle Cloud Agent for more information.

Existing Oracle Cloud Infrastructure Instances

For existing instances with supported operating systems, the Custom Logs Monitoring plugin must be enabled, and all plugins must be running. See Oracle Cloud Agent for more information.

If you already have the monitoring plugin enabled, then your instance will be automatically patched to install the agent by September 18, 2020. Otherwise, you can follow the manual installation instructions:

Linux:

  1. Connect to the instance.

  2. You can obtain the agent by using this script, and then run the script to download the agent. For example:

    ./downloadAgent.sh centos7 
./downloadAgent.sh centos8
./downloadAgent.sh oel7
./downloadAgent.sh oel8
./downloadAgent.sh windows
./downloadAgent.sh ubuntu16
./downloadAgent.sh ubuntu18
./downloadAgent.sh ubuntu20

    Otherwise, you can download the agent for the following individual operating systems:

    For the FIPS-enabled agent:

    Note

    Performance is impacted when using the FIPS-enabled agent.
  3. Run the following command to install the RPM:
    yum install -y <rpm-name>

    For Ubuntu:

    apt install -y <deb-package-name>

Windows:

  1. Connect to the instance.
  2. Download the agent from: https://objectstorage.us-phoenix-1.oraclecloud.com/n/axmjwnk4dzjv/b/unified-monitoring-agent-win-bucket/o/unified-monitoring-agent-win-2012-0.1.2.msi.
  3. Open an elevated command prompt (running as Administrator), and run the MSI command (installation can take up to five minutes to complete):
    C:\path\to\file\unified-monitoring-agent-0.0.2.msi
  4. For a more advanced version of the preceding command (to debug MSI installation issues), run:
    msiexec /i "C:\path\to\file\unified-monitoring-agent-0.0.2.msi" /l*v "C:\unified-monitoring-agent_msi.log"

Instances Created from Custom Images and Non-Oracle Cloud Infrastructure Instances

  1. Install the agent according to the same steps in Existing Oracle Cloud Infrastructure Instances.
  2. Configure User API keys for the instance you are running on. To generate the user API key, follow the instructions described in How to Generate an API Signing Key.
    • (Linux) Step 2a. Place the ".oci" directory and its contents under /etc/unified-monitoring-agent.
    • (Windows) Step 2a. For Windows, there are a few steps that differ, so ensure to follow the appropriate steps. Create the ".oci" folder and its contents in the directory C:\oracle_unified_agent.
  3. Follow the instructions described in Creating a Profile in the Oracle Cloud Infrastructure CLI Configuration File, to create the configuration file with the modifications in the next step.
  4. After following the steps in Creating a Profile in the Oracle Cloud Infrastructure CLI Configuration File, ensure to name the profile (<profile-name>) for this section as "UNIFIED_MONITORING_AGENT".
    The following is an example of what the configuration looks like for the Unified Monitoring Agent to use for authentication with the service:
    [UNIFIED_MONITORING_AGENT]
user=ocid1.user.region..aaa...
fingerprint=<cert fingerprint>
key_file=/path/to/ocifolder/.oci/private.pem
tenancy=ocid1.tenancy.region..aaa...
region=<instances region>
pass_phrase="pashphrase1234"