Prerequisites for Installing a Data Collector

Before you install a data collector, you must meet a set of prerequisites.

This section lists the key considerations and prerequisites for deploying data collectors and covers the following:

General Guidelines

Follow these guidelines for deploying data collectors:

  • You can deploy a data collector without a gateway.

  • You can deploy a data collector on a host on which the Oracle Management Repository is present or on another host that has SSH access to the remote host. You do not require an Oracle Enterprise Manager agent to deploy the data collector on either host.

  • Before you deploy data collectors to access Oracle Real Application Cluster (RAC) databases running the Oracle Management Repository (OMR), ensure that

    • The staging directory location specified for each RAC database node is the same location that was specified at the time of deploying the data collector.

    • The Oracle database user has read and write privileges on the staging directory.

    • The Oracle Management Repository host user (with SSH privileges to the Oracle Management Repository host) has read write privileges on the staging directory.

Common Prerequisites

Ensure that the common prerequisites listed in Common Prerequisites for Deploying Oracle Management Cloud Agents are met.

System and Port Requirements

The following table outlines the system requirements for a typical data collector deployment.

RAM Heap Size Kernel Parameters Oracle Management Repository Free Space (Data files) Oracle Management Repository Free Space (File system) Port Number
8 GB 1536 MB Hard nofile 65536; Ulimit value for maximum user processes >=4000 2.5 GB 3 GB Any available port number

Prerequisites Check

Before you install the data collector, you can check if you have met all the prerequisites to perform a seamless agent installation. The automated prerequisite check is embedded in the AgentInstall.sh script. The AgentInstall.sh script reads the parameters from the agent.rsp file to install the agent.

Perform the following steps to run the automated prerequisite check:

  1. On your Linux host, navigate to the installer directory where you have the agent.rsp file.

  2. Open the file using any standard editor.

  3. Enter values for all the mandatory parameters such as TENANT_ID, UPLOAD_ROOT, AGENT_REGISTRATION_KEY, AGENT_BASE_DIRECTORY, DATA_COLLECTOR_USERNAME, DATA_COLLECTOR_USER_PASSWORD, OMR_USERNAME, OMR_USER_PASSWORD, OMR_HOST_USERNAME, OMR_STAGE_DIR, OMR_HOST_USER_PASSWORD, OMR_HOSTNAME, OMR_PORT, and OMR_SID.

  4. Locate the parameter, EXECUTE_PREREQ and set the parameter value to true.

    For example, EXECUTE_PREREQ=true

  5. Save the response file.

  6. Run the AgentInstall.sh script.

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

    You can also pass the required parameter values using the command line interface to perform the prerequisite check.

    For example, ./AgentInstall.sh/bat TENANT_ID=<TENANT_ID> UPLOAD_ROOT=<UPLOAD_ROOT> AGENT_REGISTRATION_KEY=<AGENT_REGISTRATION_KEY> AGENT_BASE_DIRECTORY=<AGENT_BASE_DIRECTORY> DATA_COLLECTOR_USERNAME=<DATA_COLLECTOR_USERNAME> DATA_COLLECTOR_USER_PASSWORD=<DATA_COLLECTOR_USER_PASSWORD> OMR_USERNAME=<OMR_USERNAME> OMR_USER_PASSWORD=<OMR_USER_PASSWORD> OMR_HOST_USERNAME=<OMR_HOST_USERNAME> OMR_STAGE_DIR=<OMR_STAGE_DIR> OMR_HOST_USER_PASSWORD=<OMR_HOST_USER_PASSWORD> OMR_HOSTNAME=<OMR_HOSTNAME> OMR_PORT=<OMR_PORT> OMR_SID=<OMR_SID> EXECUTE_PREREQ=true

Data Collection Scenarios

By default, a data collector harvests metrics data, such as availability, configuration, and performance from all the entities that are managed and monitored by an existing on-premises Oracle Enterprise Manager Cloud Control. However, you can also collect data from selected entities defined in an on-premises Enterprise Manager Cloud Control. This helps you view data from only the entities that you want to monitor, which lets you to troubleshoot problems faster.

See:

Collecting Data for All Entities

If you want to collect metrics from all entities that are monitored by an existing on-premises Oracle Enterprise Manager Cloud Control:

  1. Ensure that you adhere to the General Guidelines and meet the Common Prerequisites and System and Port Requirements.

  2. Install the Oracle Management Cloud agents in the following order:

What Data Is Collected?

Scenario 1: If you’re an existing customer and have purchased standalone Oracle Management Cloud services (such as Oracle Infrastructure Monitoring, Oracle IT Analytics, and so on), the data collector will harvest:

  • All entity data; consists of entity information, entity properties, and associations.

  • All metrics for all entities; consists of all availability, configuration, and performance metrics and includes historical and current data after the entity has been discovered.

Scenario 2: If you’re a new customer and have purchased Oracle Management Cloud licensed editions (such as Standard Edition or Enterprise Edition):

  • Have purchased Oracle Management Cloud Standard Edition:

    • All entity data

    • Current metrics (consists of current availability, configuration, and performance metrics after the entity is enabled or licensed; no history is collected.) only for enabled entities ( entities that have been enabled for IT Analytics.)

  • Have purchased Oracle Management Cloud Enterprise Edition:

    • All entity data

    • All data only for enabled entities

Collecting Data for Selected Entities

If you do not add the entities (host, agent, listener, database machine, and so on ) to the omcgroup, you cannot enable IT Analytics.

The process of collecting metrics data from selected entities is:

  1. Create a dynamic group (See Creating a Dynamic Group in Your On-Premises Enterprise Manager) called omcgroup in your on-premises Enterprise Manager Cloud Control that will contain only those member entities whose data you want to collect and upload. The Enterprise Manager Agent must also be part of the omcgroup.

    If you had not created the omcgroup before the data collector was deployed, you can create it after deployment and the entities in the newly created omcgroup will be included in the next data collection. You do not have to restart the data collector.

    A member entity can be a single entity or a group that contains nested entities and groups. Oracle Management Cloud supports collecting and uploading data from the direct members of omcgroup and nested members.

    Note:

    All the entities on which you want to enable Oracle IT Analytics should exist as members of omcgroup.

  2. Ensure that you adhere to the General Guidelines and meet the Common Prerequisites and System and Port Requirements.

  3. Install the Oracle Management Cloud agents in the following order:

What Data Is Collected?

Depending on the type of the Oracle Management Cloud offerings that you've subscribed to, selective data collection varies.

Scenario 1: If you’re a new customer and have purchased Oracle Management Cloud licensed editions (such as Standard Edition or Enterprise Edition), even if the omcgroup has been created, the metrics will not be loaded until you enable Enterprise Edition (EE) on the entities. However, all entities will be added whether you create a group or not.

Status of omcgroup Standard Edition (SE) Enabled Enterprise Edition (EE) Enabled
omcgroup defined
  • Entity data for entities in omcgroup collected

  • Current data only for SE enabled entities

  • Entity data for entities in omcgroup collected

  • All data for EE enabled entities

omcgroup deleted after initial creation
  • Entity data collection changed from omcgroup to all entities

  • No change in current metrics collection (defined by SE enabled entities)

  • Entity data collection changed from omcgroup to all entities

  • No change in all metrics collection (defined by EE enabled entities)

omcgroup created later
  • Entity data updates changed from all entities to omcgroup only

  • No change in current metrics collection (defined by SE enabled entities)

  • Entity data updates changed from all entities to omcgroup only

  • No change in all metrics collection (defined by EE enabled entities)

Scenario 2: If you’re an existing customer and have purchased standalone Oracle Management Cloud services (such as Oracle Infrastructure Monitoring, Oracle IT Analytics, and so on), the data collector will harvest all entities if omcgroup is not created. If you create an omcgroup later, then it will harvest just the group, but the entities would have already been harvested and added, and metrics loaded.

Status of omcgroup Data Collection Use case
omcgroup defined
  • Entity data for entities in omcgroup

  • All metrics for entities in omcgroup

omcgroup deleted after initial creation
  • Entity data collection changed from omcgroup only to all entities

  • All metrics collection changed from omcgroup only to all entities

omcgroup created later
  • Entity data updates changed from all entities to omcgroup only

  • All metrics collection changed from all entities to omcgroup only

Creating a Dynamic Group in Your On-Premises Oracle Enterprise Manager

The owner of a dynamic group specifies the membership criteria during dynamic group creation (or modification) and membership in the group is determined solely by the criteria specified. Membership in a dynamic group cannot be modified directly. Enterprise Manager automatically adds targets that match the membership criteria when a dynamic group is created. It also updates group membership as new targets are added or target properties are changed and the targets match the group's membership criteria.

To create a dynamic group:

  1. Sign in to your on-premises Enterprise Manager Cloud Control as a user with administrative rights.

  2. In your on-premises Enterprise Manager Cloud Control, from the Groups page, click Create and then select Dynamic Group from the drop-down list. Alternately, you can choose Add Target from the Setup menu and then select Group.

  3. On the General tab of the Create Dynamic Group page, enter omcgroup as Name of the dynamic group you want to create. To create a regular dynamic group, the View any Target system wide privilege is required as the group owner must be able to view any target that can potentially match the membership criteria.

  4. In the Define Membership Criteria section, define the criteria for the dynamic group membership by clicking Define Membership Criteria.

    The Define Membership Criteria page appears where you can Add or Remove properties of targets to be included in the group. Group members must match one value in each of the populated target properties. Use the Member Preview section to review a list of targets that match the criteria. Click OK to return to the General page.

    At least one of the criteria on the Define Membership Criteria page must be specified. You cannot create a dynamic group without at least one of the target types, on hosts or target properties specified. Use the following criteria for dynamic groups:

    • Target type

    • Department

    • On Host

    • Target Version

    • Lifecycle Status

    • Operating System

    • Line of Business

    • Platform

    • Location

    • CSI

    • Cost Center

    • Contact

    • Comment

  5. You can add or remove properties using the Add or Remove Target Properties button on the Define Membership Criteria page.

  6. Click OK to create the dynamic group.

Install the Cloud Agent as an On-premises Oracle Enterprise Manager Agent Host User

You can install the cloud agent as an on-premises Oracle Enterprise Manager (EM) agent host user. If the cloud agent is installed as a different host user but in the same user group, ensure that the required permissions are provided.

The cloud agent obtains the monitoring credentials from the on-premises EM agent from the following files:
  • AGENT_HOME/agent_inst/sysman/emd/targets.xml

  • AGENT_HOME/agent_inst/sysman/config/private.properties

Where AGENT_HOME is the EM agent installation directory.

If the cloud agent is installed as a different host user, read access to these files must be provided.

For read access, log in to the host as an on-premises EM agent host user and grant the following permissions:

cd $AGENT_HOME/agent_inst    # AGENT_HOME is the EM agent installation directory
chmod g+x sysman
chmod g+x sysman/emd
chmod g+x sysman/config

By default, users in the same group should have read permissions on the sysman/emd/targets.xml and sysman/config/private.properties files. If not, grant the following permissions while still logged in as the EM agent host user:

cd $AGENT_HOME/agent_inst    # AGENT_HOME is the EM agent installation directory
chmod g+r sysman/emd/targets.xml
chmod g+r sysman/config/private.properties

Granting execution permissions allows all users in a group to access directories and read the monitoring credentials for other targets. To ensure security, we recommend that you install the cloud agent using the same user as the EM agent.