Red Hat Enterprise Virtualization - Extractor service
Use the Red Hat Enterprise Virtualization - Extractor service ETL to collect data from a Red Hat Enterprise Virtualization (RHEV) environment. To collect data, the ETL makes calls to the REST APIs that are exposed by the RHEV Manager.
To collect data by using the Red Hat Enterprise Virtualization - Extractor Service ETL, do the following tasks:
I. Complete the preconfiguration tasks.
II. Configure the ETL.
III. Run the ETL.
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:
- Navigate to Administration > ETL & System Tasks, and select ETL tasks.
- 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.
- 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.
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.
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.
(Optional) Override the default values of properties in the following tabs:
- Click Save.
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:
- On the Add ETL page, click Advanced.
Configure the following properties:
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:
- Navigate to Administration > ETL & System Tasks, and select ETL tasks.
- On the ETL tasks page, click the ETL. The ETL details are displayed.
- In the Run configurations table, click Edit to modify the ETL configuration settings.
- On the Run configuration tab, ensure that the Execute in simulation mode option is set to Yes, and click Save.
- Click Run active configuration. A confirmation message about the ETL run job submission is displayed.
- 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. - If the ETL run status is Warning, Error, or Failed:
- On the ETL tasks page, clickin the last column of the ETL name row.
- Check the log and reconfigure the ETL if required.
- Run the ETL again.
- 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
- On the ETL tasks page, click the ETL. The ETL details are displayed.
- In the Run configurations table, click Edit to modify the ETL configuration settings. The Edit run configuration page is displayed.
- On the Run configuration tab, select No for the Execute in simulation mode option, and click Save.
- 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:
- On the ETL tasks page, click the ETL, and click Edit task. The ETL details are displayed.
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.
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
- Click Administration > ETL and System Tasks > ETL tasks.
- In the Last exec time column corresponding to the ETL name, verify that the current date and time are displayed.
- 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:
- In the Workspace tab, expand Red Hat Enterprise Virtualization - Extractor Service > Systems.
- In the left pane, verify that the hierarchy displays the Red Hat Enterprise Virtualization instances.
- Click a Red Hat Enterprise Virtualization instance, and click the Metrics tab in the right pane.
- 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.
Comments
Log in or register to comment.