Harvest Entity Model Data from Enterprise Manager Cloud Control and Collect Logs
Oracle Enterprise Manager Cloud Control (EM) is Oracle's enterprise information technology (IT) management solution, which provides complete, integrated, and business-driven enterprise cloud management solution. EM 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 EM 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 EM into Oracle Logging Analytics. The entity association information is then used to construct the topology in Oracle Logging Analytics.
More information about harvesting the data from EM:
-
The EM targets which represent the on-premises resources are equivalents of entities in Oracle Logging Analytics. Therefore, you can leverage the discovered targets in EM to achieve faster onboarding in Logging Analytics instead of re-creating them.
-
The topology in EM, including that of complex composite targets, is retained and reproduced in Oracle Logging Analytics. The target associations in EM are converted to entity relations in Oracle Logging Analytics avoiding loss of information.
-
Relevant target metadata in EM is stored as entity properties in Oracle Logging Analytics enabling better monitoring of those EM resources.
-
The entity properties are periodically updated with the target information that is transferred from EM to OCI Object Storage, and in turn collected by Oracle Logging Analytics using an EM Bridge.
-
Immediately after you configure the EM Bridge, the information about EM targets and their associations is collected.
-
The periodicity of transmitting information from EM and collecting it in Oracle Logging Analytics later:
Configuration metrics and target associations: Daily
Target and target properties: Hourly
-
Overview of the workflow for harvesting data from EM:
To be able to harvest the entity data model from EM, you must first group the targets in EM for Oracle Logging Analytics service. Create a Cloud Bridge in your EM 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 Logging Analytics to import the entity information into Oracle Logging Analytics. The entities are automatically created in Oracle Logging Analytics by using the entity information collected from EM. To collect your logs from your targets in EM, associate the automatically created entities with log sources so that the logs can be collected using Management Agents.
These are the overview steps to harvest EM data and collect logs:
-
Create an OCI Object Storage Bucket to collect target data from EM. See Create a Bucket: Using Console.
-
Before setting up the EM Bridge, you must prepare the EM 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.
-
Using the compartment name and the bucket name that you specified in EM while setting up the Cloud bridge, verify in OCI Object Storage that the entity data is successfully collected. See View Bucket Details: Using Console in Oracle Cloud Infrastructure Documentation.
-
Install the Management Agents on your EM hosts to continuously collect logs from the EM entities:
See Oracle Management Agents Documentation to complete the following tasks:
-
Perform prerequisites for deploying Management Agents
-
Install Management Agents
-
-
Create IAM policies to collect the entity information from the Object Storage. See Allow Users to Perform EM Bridge Operations.
-
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 EM targets. Upon creating the EM Bridge, the entities are automatically created in Oracle Logging Analytics.
- Using console: Add an EM Bridge
- Using CLI: EM Bridge Operations Using CLI
- Using REST API: EM Bridge Operations Using REST API
Note
-
Create EM Bridge Operation:
Every EM Bridge must have a 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 EM, then the corresponding entity is not automatically deleted in Oracle Logging Analytics.
-
Changing the EM Bridge Compartment:
This operation only moves the EM Bridge resource to another compartment. The entities that are automatically created when you create the EM bridge cannot be moved to other compartments.
-
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 EM targets into Oracle 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 EM 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 Logging Analytics.
-
Define Host Preferred Credentials for all the OMS hosts.
-
Export Enterprise Manager Data to OCI by creating a Cloud 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 Logging Analytics on EM side.
Allow Users to Perform EM Bridge Operations
Individual resource-type: loganalytics-em-bridge
Part of aggregate resource-type:
loganalytics-resources-family
Use Case | IAM Policies |
---|---|
EM Bridge can be in any compartment in the tenancy |
|
EM Bridge can be in a specific compartment |
|
The above examples provide MANAGE permission for
loganalytics-em-bridge
in the tenancy or in a specific
compartment.
The following operations can be performed with each verb when you create IAM
policy for loganalytics-em-bridge
:
Inspect |
Read |
Use |
Manage |
---|---|---|---|
List the EM bridges, and their summary |
Get details about an EM bridge |
Use has the same level of permissions and API operations as Read. |
Create, update, or delete an EM bridge or move it, to a different compartment. |
Add an EM Bridge
-
From Logging Analytics, click the Administration. The Administration Overview page opens.
-
Click EM Bridges from the list of available resources.
The EM Bridges listing page will show all EM Bridges available.
-
Click Create Bridge.
The Create Bridge dialog box opens.
-
Enter the following information:
-
Bridge Name: The display name of EM Bridge
-
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.
-
Description (Optional): The description of the EM Bridge
-
Under OEM Side Bridge Configuration, section Object Storage Compartment: The compartment in Object Storage where the EM data is stored
-
Under OEM Side Bridge Configuration, section Object Storage Bucket: The name of the bucket in Object Storage where the EM data is stored
-
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,
-
Collect the namespace for your tenancy:
- Using Console: Click on your profile on the top right corner of your OCI console, click Tenancy:<tenancy_name>, and note the Object Storage Namespace value in the resulting page.
- Using CLI: See Namespace:
list
.
-
Provide appropriate permissions to LIST, GET, and USE the resource
loganalytics-em-bridge
. See Harvest Entity Model Data from Enterprise Manager Cloud Control and Collect Logs. -
For information about using the CLI, see Command Line Interface (CLI).
For a complete list of flags and options available for CLI commands, see Command Line Reference.
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 EM 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 EM 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:
-
oci log-analytics em-bridge get -ns <Namespace> --bridge-id <EM_Bridge_OCID>
-
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:
-
Create an EM Bridge: CreateLogAnalyticsEmBridge
-
Delete an EM Bridge: DeleteLogAnalyticsEmBridge
-
Get details for an EM Bridge: GetLogAnalyticsEmBridge
-
Get a summary of EM Bridge count in a specific compartment: GetLogAnalyticsEmBridgeSummary
-
Get a list of all the EM Bridges in a specific compartment: ListLogAnalyticsEmBridges
-
Update an EM Bridge: UpdateLogAnalyticsEmBridge
-
Change the compartment of an EM Bridge: ChangeLogAnalyticsEmBridgeCompartment
EM Target Types and Properties Harvested
EM Bridge supports the following target types and their properties:
EM Target Type | Corresponding Logging Analytics Entity Type | EM Target Properties | Logging Analytics Entity Properties |
---|---|---|---|
Oracle High Availability Service | Oracle Cluster Node |
-
|
|
Host |
Host (AIX) Host (HP-UX) Host (Linux) Host (Solaris) Host (Windows) |
None | None |
OC4J | OC4J |
- |
|
Oracle HTTP Server | Oracle HTTP Server |
|
|
Database Instance | Oracle Database Instance |
-
|
|
Database System | Oracle Database System |
None |
None |
Oracle Internet Directory | Oracle Internet Directory |
|
|
Listener | Oracle Database Listener |
|
|
Pluggable Database | Oracle Pluggable Database |
- |
|
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 |
|
|
Cluster Database | Oracle Database |
None |
None |
Siebel Component | Siebel Component |
-
|
|
Siebel Enterprise | Oracle Siebel Enterprise |
None |
None |
Siebel Server | Siebel Server |
- |
|
Oracle WebLogic Cluster | WebLogic Cluster |
|
|
Oracle WebLogic Domain | WebLogic Domain |
|
|
Oracle WebLogic Server | WebLogic Server |
|
|
Oracle WebLogic Node Manager | WebLogic Node Manager |
- |
|