You must configure the ETL to connect to Azure 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. Some of the basic properties display default values. You can modify these values if required. To configure the basic properties: - In the TrueSight Capacity Optimization console, navigate to Administration > ETL & System Tasks, and select ETL tasks.
- 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, and Microsoft Azure Connection.
- On the Run configuration tab, select Microsoft Azure - Azure API Extractor 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 other ETLs access the same entities that are used by the Azure API ETL.
- From the Sharing with Entity Catalog list, select the entity catalog name that is shared between ETLs.
- Private Entity Catalog: Select if this is the only ETL that extracts data from the Azure resources.
Click the Microsoft Azure Connection tab, and configure the following properties: | |
|---|
| Depending on your Azure subscription mode, select Single or Multiple. You must use the values that you obtained during the preconfiguration procedure. | | (For single subscription) Specify the ID of the subscription for which you want to retrieve data. | Multiple subscription file path | (For multiple subscriptions) Do one of the following to let the ETL use the file containing the subscriptions IDs. - Upload the file from the UI.
- Copy the file to the server where the ETL Engine runs, and specify its path.
For information about creating this file, see Creating the file. When you run the ETL, it retrieves data for all the subscriptions that are specified in the file. | | Select the Azure deployment model that you are using, either Resource manager or Classic, or both. | | For the Resource manager deployment model, configure the following properties: - The Tenant ID from your Azure Active Directory properties
- The Application ID from the App registrations in the Azure Active Directory
- The Authentication key that you generated after creating the web application in Azure Active Directory
- If you are using the Azure Government cloud, select Yes to extract data from it.
If you want to create and view Azure data by business services, retain the default selection of Create Business Service hierarchy based on specified tag key. Specify the appropriate tag key name. For example, Service.
Otherwise, select Do not create Business Service hierarchy. Example scenario:
You have VMs that are tagged as follows: - AS1: {user=John, Purpose=Dev, Service=Data Solutions}
- vl-pub-bco-qa35: {user=Adam, Purpose=Production, Service=Data Solutions}
- vl-pun-bco-qa20: {user=Jane, Purpose=QA, Service=Data Solutions}
When you run the ETL, data is displayed in a hierarchy as follows:
If you do not use business services, data is displayed as follows:
- The Data resolution at which the performance data will be collected from the Azure APIs. Select one of the following options:
- 15 minutes: Data is collected every 15 minutes (granular level)
- 1 hour: Data is collected every 1 hour (default)
Important: The Data resolution option is available only when you apply Cumulative Hotfix 5 or later on Patch 2 (20.02.02) of TrueSight Capacity Optimization 20.02. High-mark metrics will continue to be collected with 1 minute resolution. The aggregation will be according to the selected resolution. High mark metrics can be displayed as 15-minute or 1-hour resolution. The 15-minute resolution is applicable for all performance metrics. However, you need to manually enable data collection at the 15-minute resolution for the guest OS diagnostics. For details, see Collecting-additional-metrics-using-Guest-OS-diagnostics. This functionality is available only when you apply Cumulative Hotfix 7 or later on Patch 2 (20.02.02) of TrueSight Capacity Optimization 20.02.
| Is target Azure Government Cloud | If you are using the Azure Government Cloud account, specify Yes to collect data from the Government cloud entities. | | For the Classic deployment model, configure the following properties: - The path to the keystore file that is stored on the computer where TrueSight Capacity Optimization is installed. For example, /opt/bmc/BCO/secure/cotruststore.ts
The keystore file contains the certificate entry for Azure authentication. - The password that is required to access the keystore file.
| | Specify whether you want to configure a proxy server, and provide the following details. The default selection is No. - The fully qualified domain name and the port number of the proxy server host.
- The protocol for communicating with the proxy server. The default protocol is HTTPS.
- If the proxy server requires authentication, select Yes, and specify the proxy server user name and password.
|
(Optional) Override the default values of properties in the following tabs:
Run configuration
| |
|---|
| 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.
| | A short description of the ETL module. | Execute in simulation mode | By 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
| |
|---|
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
| |
|---|
| Select a task group to classify the ETL. | | Select 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 warning | Indicates the number of hours, minutes, or days for which the ETL must run before generating warnings or alerts, if any. | | Select one of the following frequencies to run the ETL: - Predefined: This is the default selection. Select a daily, weekly, or monthly frequency, and then select a time to start the ETL run accordingly.
- Start timestamp: hour\minute: Select the HH:MM start timestamp to add to the ETL execution running on a Predefined frequency.
- Custom: Specify a custom frequency, select an appropriate unit of time, and then specify a day and a time to start the ETL run.
- Custom start timestamp: Select a YYYY-MM-DD HH:MM timestamp to add to the ETL execution running on a Custom frequency.
|
- Click Save.
The ETL tasks page shows the details of the newly configured Azure API ETL.
You can configure the advanced properties to change the way the ETL works or to collect additional metrics. To configure the advanced properties: - On the Add ETL page, click Advanced.
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. | 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. | Datasets | Specify the datasets that you want to add to the ETL run configuration. The ETL collects data of metrics that are associated with these datasets.- Click Edit.
- Select one (click) or more (shift+click) datasets from the Available datasets list and click >> to move them to the Selected datasets list.
- Click Apply.
The ETL collects data of metrics associated with the datasets that are available in the Selected datasets list. |
| |
|---|
| 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. | | 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. | | 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. | | Specify the datasets that you want to add to the ETL run configuration. The ETL collects data of metrics that are associated with these datasets. - Click Edit.
- Select one (click) or more (shift+click) datasets from the Available datasets list and click >> to move them to the Selected datasets list.
- Click Apply.
The ETL collects data of metrics associated with the datasets that are available in the Selected datasets list. |
Collection level
| |
|---|
| 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. | | 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 Aging Class mapping. |
Microsoft Azure Connection
| |
|---|
Instance type definition JSON file path | Do one of the following:
- Upload the JSON file that contains the instance type configuration metrics.
- Click Choose file and navigate to the directory that contains the file.
- Click Upload.
- Specify the path to the directory where the JSON file is saved.
For more information about using this JSON file, see Collecting-data-for-additional-instance-type-configuration-metrics. | Classic VM OS family definition JSON file path | Do one of the following:
- Upload the JSON file that contains the OS metrics of virtual machine instances that you want to import.
- Click Choose file and navigate to the directory that contains the file.
- Click Upload.
- Specify the path to the directory where the JSON file is saved.
|
Additional 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
| |
|---|
| 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.
| | The 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 output | A numeric value to limit the size of the output files. | CSV loader output file name | The 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 name | The 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 | | 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. |
| |
|---|
| 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.
| | The 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 output | A numeric value to limit the size of the output files. | CSV loader output file name | The 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 name | The 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 | | 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: 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
| |
|---|
| Specify a value to run the task only during particular hours within a day. For example, 0 – 23 or 1, 3, 5 – 12. | | 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. | | Specify a value to run the task only on the selected days of a month. For example, 5, 9, 18, 27 – 31. | | Select False to temporarily turn off the mask validation without removing any values. The default selection is True. | | 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. | | 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.
|
- Click Save.
The ETL tasks page shows the details of the newly configured Azure API ETL.
|
to modify the ETL configuration settings.
in the last column of the ETL name row.
