Harvest Entity Model Data from Enterprise Manager Cloud Control and Collect Logs

Oracle Enterprise Manager Cloud Control (EMCC) is Oracle's enterprise information technology (IT) management solution, which provides complete, integrated, and business-driven enterprise cloud management solution. EMCC collects additional information about entities such as configuration information necessary to locate log files and relationships between entities to provide topological views of applications. These topological views across application stack components help to easily troubleshoot issues with application availability and performance. The existing users of EMCC can set up the EM Bridge and benefit from the automated set up that imports their entity model data like the entity associations, and properties information from EMCC into Oracle Cloud Logging Analytics. The entity association information is then used to construct the topology in Oracle Cloud Logging Analytics.

More information about the EMCC Harvester:

  • The EMCC targets which represent the on-premises resources are equivalents of entities in Oracle Cloud Logging Analytics. Therefore, you can leverage the discovered targets in EMCC to achieve faster onboarding in Logging Analytics instead of re-creating them.

  • The topology in EMCC, including that of complex composite targets are retained and reproduced in Oracle Cloud Logging Analytics. The target associations in EMCC are converted to entity relations in Oracle Cloud Logging Analytics avoiding loss of information.

  • Relevant target metadata in EMCC is stored as entity properties in Oracle Cloud Logging Analytics enabling better monitoring of those EMCC resources.

  • The entity properties are periodically updated with the target information that is transferred from EMCC to OCI Object Storage, and in turn collected by Oracle Cloud Logging Analytics using EM Bridge.

Overview of EMCC harvester workflow:


EMCC Harvester Overview

To be able to harvest the entity data model from EMCC, you must first group the targets in EMCC for Oracle Cloud Logging Analytics service. Create an OCI bridge in your EMCC monitored environment to export the target information to OCI Object Storage. After confirming that the entity data is collected in the Object Storage, create an EM Bridge between Object Storage and Oracle Cloud Logging Analytics to import the entity information into Oracle Cloud Logging Analytics. The entities are automatically created in Oracle Cloud Logging Analytics by using the entity information collected from EMCC. To collect your logs from your targets in EMCC, associate the automatically created entities with log sources so that the logs can be collected using Management Agents.

  1. Create an OCI Object Storage Bucket to collect target data from EMCC. See Create a Bucket: Using Console.

  2. Before setting up the EM Bridge, you must prepare the EMCC environment to export the required information to OCI. See Prerequisites for Creating the EM Bridge.

    At this point, the OCI connectivity is set up, and your target data is automatically uploaded at frequent intervals to OCI Object Storage.

  3. Using the compartment name and the bucket name that you specified in EMCC while setting up the OCI bridge, verify in OCI Object Storage that the entity data is successfully collected. See View Bucket Details: Using Console in Oracle Cloud Infrastructure Documentation.

  4. Install the Management Agent on your EMCC hosts to continuously collect logs from the EMCC entities:

    See Oracle Management Agents Documentation to complete the following tasks:

    • Perform prerequisites for deploying Management Agents

    • Install Management Agent

  5. Create IAM policies to collect the entity information from the Object Storage. Create a dynamic group and provide permissions for the dynamic group to access the data in the above Object Storage compartment. Additionally, add policies to use the loganalytics-em-bridge resource, which is part of loganalytics-resources-family.

    Example rule where the resource can be in any compartment in tenancy:

    ALL {resource.type='loganalyticsembridge'}

    Example rule with specific resource compartment OCID:

    ALL {resource.type='loganalyticsembridge', resource.compartment.id=<loganalyticsembridge_resource_compartment_OCID>}

    Example policy to allow the dynamic group READ access to the object store bucket:

    allow dynamic-group <group_name> to read objects in compartment <compartment_name>
  6. Now that the entity information is available in OCI Object Storage, create an EM Bridge to collect it and create the entity data model which helps to perform a complete log analysis for monitoring the EMCC targets. Upon creating the EM Bridge, the entities are automatically created in Oracle Cloud Logging Analytics.

    Note

    • Create EM Bridge Operation:

      Every EM Bridge must have an unique display name in a specific tenancy.

      There can only be one EM Bridge for a specific OCI object store bucket in a given tenancy.

    • Delete EM Bridge Operation:

      If you delete an EM Bridge, then the entities that were automatically created using the EM Bridge will not be deleted.

      If a target is deleted in EMCC, then the corresponding entity is not automatically deleted in Oracle Cloud Logging Analytics.

    • Changing the EM Bridge Compartment:

      This operation only moves the EM Bridge resource to another apartment. The entities that are automatically created when you create the EM bridge cannot be moved to other compartments.

  7. Ensure to enable the auto-association feature for the specific sources that you want to associate with the EM entities. See Enable Auto-Association for a Source. After the creation of EM Bridge, the eligible entities are automatically associated with the relevant sources.

At this point, the logs will start collecting from the EMCC targets into Oracle Cloud Logging Analytics. You can view them in the log explorer.

Prerequisites for Creating the EM Bridge

Before you create the EM Bridge to collect the entity data from the Object Storage, you must perform the following tasks in the Enterprise Manager (EMCC) environment. For detailed steps, see Integrating Enterprise Manager with OCI Services in Enterprise Manager Cloud Control Administrator's Guide.

  • Define a Global Named Credential in Enterprise Manager for OCI.

  • Set up an exclusive user for the Enterprise Manager login.

  • Create an Enterprise Manager group containing the targets for which you want to export data to Oracle Cloud Logging Analytics.

  • Define Host Preferred Credentials for all the OMS hosts.

  • Export Enterprise Manager Data to OCI by creating an OCI bridge. Select Logging Analytics as the OCI Service which will consume the data and specify the target group that you created earlier.

  • Verify data upload status for Oracle Cloud Logging Analytics on EMCC side.

Add an EM Bridge

  1. From Logging Analytics, click the Administration > Administration Overview page opens.

  2. Click EM Bridges from the list of available resources.

    The EM Bridges listing page will show all EM Bridges available.

  3. Click Create Bridge.

    The Create Bridge dialog box opens.

  4. Enter the following information:

    1. Bridge Name: The display name of EM Bridge

    2. Bridge Compartment: The compartment where the EM Bridge resource must be created. This is automatically set to the compartment that you select in the EM Bridges listing page.

    3. Description (Optional): The description of the EM Bridge

    4. Under OEM Side Bridge Configuration > Object Storage Compartment: The compartment in Object Storage where the EMCC data is stored

    5. Under OEM Side Bridge Configuration > Object Storage Bucket: The name of the bucket in Object Storage where the EMCC data is stored

    6. Entity Compartment: The compartment where the entities must be created

    Click Create.

EM Bridge Operations Using CLI

Before you start using the CLI to perform EM Bridge operations,

List the Available EM Bridge Operations

See em-bridge.

Create an EM Bridge

To create an EM Bridge, see em-bridge: create. For example:

oci log-analytics em-bridge create -ns <Namespace> -c <Object_Storage_Compartment_OCID> --display-name <EM_Bridge_Name> --bucket-name <Object_Storage_Bucket_Name> --description "<EM_Bridge_Description>" --em-entities-compartment-id <Entity_Compartment_OCID>

In the above CLI command example:

  • Namespace: Namespace of your tenancy

  • Object_Storage_Compartment_OCID: OCID of the compartment in Object Storage where the EMCC data is stored

  • EM_Bridge_Name: The display name of EM Bridge

  • Object_Storage_Bucket_Name: The name of the bucket in Object Storage where the EMCC data is stored

  • EM_Bridge_Description: The description of the EM Bridge

  • Entity_Compartment_OCID: OCID of the compartment where the entities must be created

Get the Details About an EM Bridge

To get the details about the EM Bridge, see em-bridge: get.

Example commands for getting more details about EM Bridge:

  1. oci log-analytics em-bridge get -ns <Namespace> --bridge-id <EM_Bridge_OCID>
  2. oci log-analytics entity get -ns <Namespace> --bridge-id <EM_Bridge_OCID>

List the EM Bridges

To list the EM Bridges, see em-bridge: list.

Example command to list the EM Bridges:

oci log-analytics em-bridge list -ns <Namespace> -c <EM_Bridge_Compartment_OCID>

EM Bridge Operations Using REST API

You can perform the following EM Bridge operations using API:

EMCC Target Types and Properties Harvested

EMCC Harvester for Oracle Cloud Logging Analytics supports the following target types and their properties:

EMCC Target Type Corresponding Logging Analytics Entity Type EMCC Target Properties Logging Analytics Entity Properties
Oracle High Availability Service Oracle Cluster Node

NodeName

-

OracleHome

node_name

omc_crs_base

oracle_home

Host

Host (AIX)

Host (HP-UX)

Host (Linux)

Host (Solaris)

Host (Windows)

None None
OC4J OC4J

-

omc_server_log_path

Oracle HTTP Server Oracle HTTP Server

{DOMAIN_HOME}{OracleInstance}

ComponentName

ohs_home

component_name

Database Instance Oracle Database Instance

-

MachineName

Port

ADRHome

SID

ServiceName

OracleHome

diagnostic_dest

audit_file_dest

audit_dest

host_name

port

adr_home

sid

service_name

oracle_home

DIAGNOSTIC_DEST

AUDIT_FILE_DEST

Database System Oracle Database System

None

None

Oracle Internet Directory Oracle Internet Directory

IASInternalName

OracleInstance

ias_internal_name

oracle_instance

Listener Oracle Database Listener

OracleHome

ADRHome

{ORACLE_HOME}/../diag/tnslsnr/*/{LSNR_ALIAS}/alert

Machine

{ORACLE_HOME}/../diag/tnslsnr/*/{LSNR_ALIAS}/trace

oracle_home

adr_home

log_dir_path

host_name

trace_dir_path

Pluggable Database Oracle Pluggable Database

Name

MachineName

Port

SID

ServiceName

-

pdb_name

host_name

port

sid

service_name

domain_name

Oracle VM Manager Oracle VM Manager

None

None

Oracle VM Server Pool Oracle VM Server Pool

None

None

Cluster ASM Automatic Storage Management

None

None

Automatic Storage Management Automatic Storage Management Instance

AdrHome

adr_home

Cluster Database Oracle Database

None

None

Siebel Component Siebel Component

-

SARMLogDirectory

siebel_component_log_file_name

siebel_component_sarm_log_directory

Siebel Enterprise Oracle Siebel Enterprise

None

None

Siebel Server Siebel Server

filesystem:installdir

filesystem:logdir

-

siebel_server_install_dir

siebel_server_log_dir

siebel_component_sarm_log_directory

Oracle WebLogic Cluster WebLogic Cluster

DOMAIN_HOME

omc_weblogic_cluster_home

Oracle WebLogic Domain WebLogic Domain

DOMAIN_HOME

WebLogicHome

domain_home

weblogic_home

Oracle WebLogic Server WebLogic Server

DOMAIN_HOME

ServerNames

domain_home

server_names

Oracle WebLogic Node Manager WebLogic Node Manager

-

omc_nodemanager_home