Red Hat Enterprise Virtualization - Extractor service

1. Make sure that you are collecting data from the supported versions of RHEV: 4.4 (with compatibility version 4.7), 4.3, 4.2, 4.1, 4.0
2. Create an ETL user and assign the login permissions to the user. The ETL uses this user and the API calls to connect to RHEV for data collection.
   1. Log into the Red Hat Virtualization Manager terminal.
   2. Run the following command to create a new user:
      ovirt-aaa-jdbc-tool user add bmcETL --attribute=firstName=bmc_etl

1. 1. Change the password of the user by using the following command:
      ovirt-aaa-jdbc-tool user password-reset bmcETL --password=pass:<new password>

1. 1. Ensure you can log in to the RHEV console using the ETL user you created. If you are unable to log in, you might need to unblock the user using the following command:
      ovirt-aaa-jdbc-tool user unlock bmcETL
   2. Log in to the RHEV console as an admin. Navigate to Portals > Administration Portal.
   3. From the left navigation pane, go to Administration > Users section. 
   4. Click Add and search for the newly added bmcETL user from the list of users. Click Add to save the changes. 
   5. Create a role for the bmcETL user. 
      1. Navigate to Administration > Configure > Roles section.
      2. Click New. 
      3. Enter the name and the description, and from Account Type, select Admin. 
      4. In the Check boxes to Allow Action section, expand System > Configure System. Verify that only the Login Permissions are available to the bmcETL user. 
      5. Click OK to save the role. 
      6. Navigate to the System Permissions section, and click Add. 
      7. On the Add System Permission to User screen, search for the bmcETL user and select it. From the Role to Assign dropdown list, select the name of the role that you have created in step 2g (iii). 
      8. Click OK to save the preferences. 

The ovirt-aaa-jdbc-tooltool is used for managing users, groups, permissions, and other authentication and authorization aspects. When you have a Red Hat Virtualization environment up and running, the necessary components, including the ovirt-aaa-jdbc-tool, are typically installed as part of the overall deployment.

You must configure the ETL to connect to Red Hat Enterprise Virtualization for data collection. 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

To configure the basic properties:

1. Navigate to Administration > ETL & System Tasks, and select ETL tasks.
2. On the ETL tasks page, click Add > Add ETL under the Last run tab. The Add ETL page displays the configuration properties. You must configure properties in the following tabs: Run configuration, Entity catalog, and RHEV Manager API Connection.
3. On the Run configuration tab, select Red Hat Enterprise Virtualization - Extractor Service from the ETL module list. The name of the ETL is displayed in the ETL task name field. You can edit this field to customize the name.
   
4.  Click the Entity catalog tab, and select one of the following options:
   • Shared Entity Catalog: Select if the other ETLs access the same entities that are used by this ETL.
     • From the Sharing with Entity Catalog list, select an entity catalog name that is shared between ETLs.
   • Private Entity Catalog: Select if you want to use this ETL independently.
     If you are collecting business services data, we recommend that you select Shared Entity Catalog to avoid duplication of entities.
5. Click the RHEV Manager API Connection tab, and configure the following properties:
   • The name of the host where the RHEV-M console is installed and the port number for the RHEV-M API.
   • Transport type as HTTP or HTTPS. The default is HTTPS.
   • The user name, domain the user belongs to, and the password to connect to the RHEV-M API. 

6. (Optional) Override the default values of properties in the following tabs:

   The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
   This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.*Scheduler compatible with this ETL: Remote ETL Engine.

7. Click Save.
8. The ETL tasks page shows the details of the newly configured Red Hat Enterprise Virtualization - Extractor Service ETL.
   

(Optional) B. Configuring the advanced properties

You can configure the advanced properties to change the way the ETL works.

To configure the advanced properties:

1. On the Add ETL page, click Advanced.

2. Configure the following properties:
   

   Run configuration

   Property	Description
   Run configuration name	Specify the name that you want to assign to this ETL task configuration. The default configuration name is displayed. You can use this name to differentiate between the run configuration settings of ETL tasks.
   Deploy status	Select the deploy status for the ETL task. For example, you can initially select Test and change it to Production after verifying that the ETL run results are as expected.
   Description	A short description of the ETL module.
   Log level	Specify the level of details that you want to include in the ETL log file. Select one of the following options: 1 - Light: Select to add the bare minimum activity logs to the log file. 5 - Medium: Select to add the medium-detailed activity logs to the log file. 10 - Verbose: Select to add detailed activity logs to the log file. Use log level 5 as a general practice. You can select log level 10 for debugging and troubleshooting purposes.

   Collection level

   Property	Description
   Metric profile selection	Select the metric profile that the ETL must use. The ETL collects data for the group of metrics that is defined by the selected metric profile. Use Global metric profile: This is selected by default. All the out-of-the-box ETLs use this profile. Select a custom metric profile: Select the custom profile that you want to use from the Custom metric profile list. This list displays all the custom profiles that you have created. For more information about metric profiles, see Adding-and-managing-metric-profiles.
   Levels up to	Specify the metric level that defines the number of metrics that can be imported into the database. The load on the database increases or decreases depending on the selected metric level.To learn more about metric levels, see Adding-and-managing-metric-profiles.

   RHEV Manager API Connection

   
   

   Property	Description
   Aggregation period	Depending on the time interval you need between data aggregation, select the required period. The recommended aggregation period is 30 minutes or longer.
   Hierarchy import period	Select the time interval after which you want to refresh the BMC Helix Continuous Optimization hierarchy. For example, refresh the hierarchy after a RHEV VM is moved to another RHEV host.
   Data collection	Depending on your requirement, select whether you want full or partial data collection: Full: Extracts the cloud relationship and all configuration metrics available from the RHEV-M API. Partial: Extracts the cloud relationship and a partial set of configuration metrics to be used in conjunction with the Capacity Agent.

   Additional properties

   Property	Description
   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. Click Add. In the etl.additional.prop.n field, specify an additional property. Click Apply. Repeat this task to add more properties.

   Loader configuration

   Property	Description
   Empty dataset behavior	Specify 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.
   Maximum number of rows for CSV output	A numeric value to limit the size of the output files.
   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.
   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 . It uses one of the other ETLs that share a lookup to create a new entity. The default selection is False.

   Scheduling options

   Property	Description
   Hour mask	Specify 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 mask	Select 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 mask	Specify a value to run the task only on the selected days of a month. For example, 5, 9, 18, 27 – 31.
   Apply mask validation	Select False to temporarily turn off the mask validation without removing any values. The default selection is True.
   Execute after time	Specify 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.
   Enqueueable	Specify 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 Red Hat Enterprise Virtualization - Extractor Service 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. To run the ETL in the simulation mode

To run the ETL in the simulation mode:

1. 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, clickin 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. To run the ETL in the production mode

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

To run 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 runs, it collects data from the source and transfers it to the BMC Helix Continuous Optimization database.

To schedule the ETL run in the production mode

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 task. 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 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 BMC Helix Continuous Optimization database.

Verify that the ETL ran successfully and check whether the Red Hat Enterprise Virtualization data is refreshed in the Workspace.

To verify whether the ETL ran successfully

1. 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.
3. In the Last exit column corresponding to the ETL name, verify that the status is OK.
   In case of WARNING or ERROR, click in the last column of the ETL name row to review the log files.

To verify that the Red Hat Enterprise Virtualization data is refreshed:

1. In the Workspace tab, expand Red Hat Enterprise Virtualization - Extractor Service > Systems.
2. In the left pane, verify that the hierarchy displays the Red Hat Enterprise Virtualization instances.
3. Click a Red Hat Enterprise Virtualization instance, and click the Metrics tab in the right pane.
4. 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.

To learn more about these metrics, see Entity-relationship-and-metrics-for-Red-Hat-Enterprise-Virtualization-Extractor-Service.