Oracle - Enterprise Manager extractor

Use the Oracle Enterprise Manager Extractor to collect the configuration and performance data of Oracle Enterprise Manager (OEM) Cloud Control solution. The collected data is used for analyzing and optimizing the capacity of the OEM Cloud Control solution. 

The OEM ETL imports the following types of entities:

  • Host: database server and monitored server
  • Cluster
  • Database instance
  • Database rack

For information about entities, metrics, and lookup details for the OEM ETL, see Entities, metrics, and lookup details for Oracle Enterprise Manager.

The ETL supports the following versions of OEM Cloud Control:

  • 13c - 13.1.0.0, 13.2.0.0
  • 12c - 12.1.0.1, 12.1.0.3, 12.1.0.4, 12.1.0.5
  • 12.2.0.1
  • 18c - 12.2.0.2
  • 19c - 12.2.0.3
  • 11g

Collecting data by using the OEM ETL

To collect data by using the Oracle Enterprise Manager ETL, do the following tasks:

I. Complete the preconfiguration tasks.

II. Configure the ETL.

Step I. Complete the preconfiguration tasks

Ensure that you create a database user and assign the appropriate rights. During ETL configuration, specify these user details so that the ETL can connect to the database for extracting data.

StepDetails

To access the database as a repository owner, create a user account with the VIEW ALL profile or with access to the following views:

  • SYSMAN.MGMT$METRIC_DETAILS
  • SYSMAN.MGMT$METRIC_HOURLY
  • SYSMAN.MGMT$METRIC_DAILY
  • SYSMAN.MGMT$ALERT_HISTORY
  • SYSMAN.MGMT$TARGET_PROPERTIES
  • SYSMAN.MGMT$DB_SGA
  • SYSMAN.MGMT$DB_INIT_PARAMS
  • SYSMAN.MGMT$TARGET
  • SYSMAN.MGMT$TARGET_ASSOCIATIONS
  • SYSMAN.MGMT$OS_HW_SUMMARY
  • SYSMAN.MGMT$TEMPLATE_METRICCOLLECTION
 Steps to create a user and assign rights
    1. Log on to the Oracle Enterprise Management database as an administrator.
    2. In the OEM interface, click  > Security > Administrators.
    3. On the Administrators tab, click Create.
      The Create Administrator wizard is launched.

    4. On the Properties page, specify the name and password, and click Next
      The following page shows some sample values.

    5. On the Roles tab, select roles as indicated in the image below, and click Next.

    6. On the Target Privileges page, select View any Target, and click Next.
    7. On the Resource Privileges page, click Next.
    8. On the Review page, review the specified settings, and click Finish.

Step II. Configure the ETL

You must configure the ETL to connect to OEM for collecting the OEM metrics. ETL configuration includes specifying the basic and optional advanced properties. While configuring the basic properties is sufficient, you can optionally configure the advanced properties for additional customization.

A. Configuring the basic properties

Some of the basic properties display default values. You can modify these values when required.

To configure the basic properties:

  1. In the TrueSight Capacity Optimization console, navigate to Administration ETL & System Tasks, and select ETL tasks.
  2. On the ETL tasks page, click Add > Add ETL. The Add ETL page displays the configuration properties. You must configure properties in the following tabs: Run configuration, Entity catalog, Oracle OEM Configuration, and Connection parameters

  3. On the Run Configuration tab, do the following:

    1. Select Oracle Enterprise Manager Extractor from the ETL module list. The name of the ETL is displayed in the ETL task name box. You can edit this field to customize the name.

    2. Specify whether you want to import the performance and configuration metrics for all entities or import only performance metrics for database instances and RAC clusters.
  4. Click the Entity catalog tab, and select one of the following options:
    • Shared Entity Catalog: Select if other ETLs access the same entities that are used by the OEM ETL. This is the default selection.

      • From the Sharing with Entity Catalog list, select the entity catalog name that is shared between ETLs.
    • Private Entity Catalog: Select if only this ETL is used for extracting data from the OEM resources.

  5. Click the Oracle OEM Configuration tab, and configure the following properties:

    PropertyDescription
    Import database dataSpecify whether you want to import the database data.
    Import server data

    Specify whether you want to import data from the monitored hosts. The ETL imports data from the following types of hosts:

    • Database server
    • Instances without an Oracle database running on them
    Data resolutionSpecify whether you want to aggregate data before importing it. Select one of the following options:
    • RAW: Data is imported without aggregation.
    • HOUR: Data is aggregated hourly and imported.
    • DAY: Hourly data is aggregated daily and imported.
    Extraction mode (Enabled when you select DAY under Data resolution)Specify a period for data extraction.
    • REGULAR - daily import: Select to import data every day.
    • HISTORICAL - import historical data (do not use for daily scheduling): Select if you want to import historical data, and specify a date and time to import it.

  6. Click the Connection parameters tab, and configure the following properties so that the ETL can connect to the database:

    • An existing data source or a custom data source to which the ETL must connect
    • The database credentials and other details, such as data source name and connection URLs depending on the selected custom data source
  7. (Optional) Override the default values of properties in the following tabs:

     Run configuration
    PropertyDescription
    Module selection

    Select one of the following options:

    • Based on datasource: This is the default selection.
    • Based on Open ETL template: Select only if you want to collect data that is not supported by TrueSight Capacity Optimization.
    Module descriptionA short description of the ETL module.
    Execute in simulation modeBy default, the ETL execution in simulation mode is selected to validate connectivity with the data source, and to ensure that the ETL does not have any configuration issues. In the simulation mode, the ETL does not load data into the database. This option is useful when you want to test a new ETL task. To run the ETL in the production mode, select No.
    BMC recommends that you run the ETL in the simulation mode after ETL configuration and then run it in the production mode.

     Object relationships
    PropertyDescription
    Associate new entities to

    Specify the domain to which you want to add the entities created by the ETL.

    Select one of the following options:

    • Existing domain: This option is selected by default. Select an existing domain from the Domain list. If the selected domain is already used by other hierarchy rules, select one of the following Domain conflict options:
      • Enrich domain tree: Select to create a new independent hierarchy rule for adding a new set of entities, relations, or both that are not defined by other ETLs.
      • ETL Migration: Select if the new ETL uses the same set of entities, relations, or both that are already defined by other ETLs.
    • New domain: Select a parent domain, and specify a name for your new domain.

    By default, a new domain with the same ETL name is created for each ETL. When the ETL is created, a new hierarchy rule with the same name of the ETL task is automatically created in the active state. If you specify a different domain for the ETL, the hierarchy rule is updated automatically.

     ETL task properties
    PropertyDescription
    Task groupSelect a task group to classify the ETL.
    Running on schedulerSelect one of the following schedulers for running the ETL:
    • Primary Scheduler: Runs on the Application Server.
    • Generic Scheduler: Runs on a separate computer.
    • Remote: Runs on remote computers.
    Maximum execution time before warningIndicates the number of hours, minutes, or days for which the ETL must run before generating warnings or alerts, if any.
    Frequency

    Select one of the following frequencies to run the ETL:

    • Predefined: This is the default selection. Select an hourly, daily, or weekly frequency, and then select a time and a day to start the ETL run accordingly.
    • Custom: Specify a custom frequency, select an appropriate unit of time, and then specify a day and a time to start the ETL run.

  8. Click Save.
    The details of the newly configured OEM ETL are displayed.

(Optional) B. Configuring the advanced properties

You can configure the advanced properties to change the way the ETL works and to define the data collection period.

To configure the advanced properties:

  1. On the Add ETL page, click Advanced.
  2. Configure the following additional properties:

     Oracle OEM configuration
    PropertyDescription
    Schema to use
    Entity black list
    Entity white list

     Additional properties
    PropertyDescription
    List of properties

    Specify additional properties for the ETL that act as user inputs during run. You can specify these values now or you can do so later by accessing the "You can manually edit ETL properties from this page" link that is displayed for the ETL in the view mode.

    1. Click Add.
    2. In the etl.additional.prop.n field, specify an additional property.
    3. Click Apply.
      Repeat this task to add more properties.

    You can configure the following additional properties if you have configured the ETL to collect data from multiple AWS accounts:

    • To create a separate AWS_Cloud entity for each additional account, and to display the associated instances below the respective entity, add the extract.aws.create.cloudentity.forlinkedaccounts property and set its value to true. If this property is set to false, all the instances associated with the additional accounts are displayed below the domain that is associated to the main account, that is, AWS_Cloud cloud entity.
    • To display the attached volumes below the instance and the detached volumes below the Volumes folder, add the extract.aws.display.attached.volumes property and set its value to false. If this property is set to true, the attached volumes are displayed below the instance as well as in the Volumes folder.

     Loader configuration
    PropertyDescription
    Empty dataset behaviorSpecify the action for the loader if it encounters an empty dataset:
    • Warn: Generate a warning about loading an empty dataset.
    • Ignore: Ignore the empty dataset and continue parsing.
    ETL log file nameThe name of the file that contains the ETL run log. The default value is: %BASE/log/%AYEAR%AMONTH%ADAY%AHOUR%MINUTE%TASKID
    Maximum number of rows for CSV outputA numeric value to limit the size of the output files.
    CSV loader output file nameThe name of the file that is generated by the CSV loader. The default value is: %BASE/output/%DSNAME%AYEAR%AMONTH%ADAY%AHOUR%ZPROG%DSID%TASKID
    Capacity Optimization loader output file nameThe name of the file that is generated by the TrueSight Capacity Optimization loader. The default value is: %BASE/output/%DSNAME%AYEAR%AMONTH%ADAY%AHOUR%ZPROG%DSID%TASKID
    Detail mode
    Specify whether you want to collect raw data in addition to the standard data. Select one of the following options:
    • Standard: Data will be stored in the database in different tables at the following time granularities: Detail (configurable, by default: 5 minutes), Hourly, Daily, and Monthly.
    • Raw also: Data will be stored in the database in different tables at the following time granularities: Raw (as available from the original data source), Detail (configurable, by default: 5 minutes), Hourly, Daily, and Monthly.
    • Raw only: Data will be stored in the database in a table only at Raw granularity (as available from the original data source).
    For more information, see Accessing data using public views and Sizing and scalability considerations.
    Remove domain suffix from datasource name (Only for systems) Select True to remove the domain from the data source name. For example, server.domain.com will be saved as server. The default selection is False.
    Leave domain suffix to system name (Only for systems) Select True to keep the domain in the system name. For example: server.domain.com will be saved as is. The default selection is False.
    Update grouping object definition (Only for systems) Select True if you want the ETL to update the grouping object definition for a metric that is loaded by the ETL. The default selection is False.
    Skip entity creation (Only for ETL tasks sharing lookup with other tasks) Select True if you do not want this ETL to create an entity and discard data from its data source for entities not found in Capacity Optimization. It uses one of the other ETLs that share a lookup to create a new entity. The default selection is False.

     Scheduling options
    PropertyDescription
    Hour maskSpecify a value to run the task only during particular hours within a day. For example, 0 – 23 or 1, 3, 5 – 12.
    Day of week maskSelect the days so that the task can be run only on the selected days of the week. To avoid setting this filter, do not select any option for this field.
    Day of month maskSpecify a value to run the task only on the selected days of a month. For example, 5, 9, 18, 27 – 31.
    Apply mask validationSelect False to temporarily turn off the mask validation without removing any values. The default selection is True.
    Execute after timeSpecify a value in the hours:minutes format (for example, 05:00 or 16:00) to wait before the task is run. The task run begins only after the specified time is elapsed.
    EnqueueableSpecify whether you want to ignore the next run command or run it after the current task. Select one of the following options:
    • False: Ignores the next run command when a particular task is already running. This is the default selection.
    • True: Starts the next run command immediately after the current running task is completed.

  3. Click Save.
    The ETL tasks page shows the details of the newly configured OEM ETL.

Step III. Run the ETL

After you configure the ETL, you can run it to collect data. You can run the ETL in the following modes:

A. Simulation mode: Only validates connection to the data source, does not collect data. Use this mode when you want to run the ETL for the first time or after you make any changes to the ETL configuration.

B. Production mode: Collects data from the data source.

A. Running the ETL in the simulation mode

To run the ETL in the simulation mode:

  1. In the TrueSight Capacity Optimization console, navigate to Administration ETL & System Tasks, and select ETL tasks.
  2. On the ETL tasks page, click the ETL. The ETL details are displayed.



  3. In the Run configurations table, click Edit  to modify the ETL configuration settings.
  4. On the Run configuration tab, ensure that the Execute in simulation mode option is set to Yes, and click Save.
  5. Click Run active configuration. A confirmation message about the ETL run job submission is displayed.
  6. On the ETL tasks page, check the ETL run status in the Last exit column.
    OK Indicates that the ETL ran without any error. You are ready to run the ETL in the production mode.
  7.  If the ETL run status is Warning, Error, or Failed:
    1. On the ETL tasks page, click  in the last column of the ETL name row.
    2. Check the log and reconfigure the ETL if required.
    3. Run the ETL again.
    4. Repeat these steps until the ETL run status changes to OK.

B. Running the ETL in the production mode

You can run the ETL manually when required or schedule it to run at a specified time.

Running the ETL manually

  1. On the ETL tasks page, click the ETL. The ETL details are displayed.
  2. In the Run configurations table, click Edit  to modify the ETL configuration settings. The Edit run configuration page is displayed.
  3. On the Run configuration tab, select No for the Execute in simulation mode option, and click Save.
  4. To run the ETL immediately, click Run active configuration. A confirmation message about the ETL run job submission is displayed.
    When the ETL is run, it collects data from the source and transfers it to the TrueSight Capacity Optimization database.

Scheduling the ETL run

By default, the ETL is scheduled to run daily. You can customize this schedule by changing the frequency and period of running the ETL.

To configure the ETL run schedule:

  1. On the ETL tasks page, click the ETL, and click Edit. The ETL details are displayed.

  2. On the Edit task page, do the following, and click Save:

    • Specify a unique name and description for the ETL task.
    • In the Maximum execution time before warning field, specify the duration for which the ETL must run before generating warnings or alerts, if any.
    • Select a predefined or custom frequency for starting the ETL run. The default selection is Predefined.
    • Select the task group and the scheduler to which you want to assign the ETL task.
  3. Click Schedule. A message confirming the scheduling job submission is displayed.
    When the ETL runs as scheduled, it collects data from the source and transfers it to the TrueSight Capacity Optimization database.

Step IV. Verify data collection

Verify that the ETL ran successfully and the data is refreshed in the TrueSight Capacity Optimization console.

To verify whether the ETL ran successfully:

  1. In the TrueSight Capacity Optimization console, click Administration > ETL and System Tasks > ETL tasks.
  2. In the Last exec time column corresponding to the ETL name, verify that the current date and time are displayed.

To verify whether the data is refreshed:

  1. Log in to the TrueSight Capacity Optimization console.
  2. Expand (domain name) > (entities) > Systems > Instances.
  3. In the left pane, verify that the hierarchy displays the new and updated instances of OEM.
  4. Click an instance and click the Metrics tab in the right pane.
  5. Check if the Last Activity column in the Configuration data and Performance metrics tables displays the current date.

The following image shows sample metrics data:

Was this page helpful? Yes No Submitting... Thank you

Comments