×
 
 
  •  
$helper.renderConfluenceMacro('{bmc-global-announcement:$space.key}')

   

This documentation supports releases of BMC Helix Continuous Optimization up to December 31, 2021. To view the latest version, select the version from the Product version menu.
BMC Helix Continuous Optimization 21.3 ... Collecting data Out-of-the-box ETLs On-premises ETLs Integrating with TrueSight Operations Management

BMC - TrueSight Operations Management 10.7/11.0/11.3 Generic extractor

Use the BMC - TrueSight Operations Management 10.7/11.0/11.3 Generic extractor to collect the configuration and performance data of the TrueSight Operations Management entities. The collected data is used for analyzing and optimizing the capacity of the TrueSight Operations Management resources. To collect data, this Java-based ETL makes the REST API calls to the Data Integration APIs of TrueSight Operations Management. 

This ETL supports the following platforms:

  • IBM AIX
  • Oracle Solaris
  • Stand-alone hosts supported for Windows, Linux, AIX, HP-UX, and Solaris
  • Hyper-V (Clusters, hosts, and virtual machines)
  • KVM

Collecting data by using the BMC TrueSight Operations Management Generic ETL

To collect data by using the BMC TrueSight Operations Management Generic ETL, do the following tasks:

I. Complete the preconfiguration tasks.

II. Configure the ETL.

III. Run the ETL.

IV. Verify data collection.

 

Step I. Complete the preconfiguration tasks

Depending on the platform that you want to monitor, create a platform definition JSON file.

The JSON file defines the mapping of the source (TrueSight Operations Management) devices, instance types, and parameters to the destination (BMC Helix Continuous Optimization) entities and metrics. It enables you to extract data from a set of Knowledge Modules (KM) for a new platform through the TrueSight Operations Management.

Perform the following tasks to create the JSON file:

PATROLTrueSight Operations Management

BMC Helix Continuous Optimization

ParameterAttributeMetric
PATROL Agent/Remote Server/Application Instance with metadataDeviceEntity (system/business driver)
Application classMonitorDevicetype
InstanceInstanceRelationship/child Entity (system/business driver)

StepDetails
1Analyze the TrueSight Operations Management Knowledge Module (KM) to understand the hierarchy of devices and instances.
  1. Log on to the Views tab. Click the Monitoring tab and select Devices.
  2. Click a device tile to access the monitors and monitor instances associated with that device.



Access the PATROL console and verify the hierarchy tree to identify which node in the tree maps to a device, application, or monitoring instance.

2Analyze the KM to understand the configuration and performance parameters to be extracted. Check the KM PSL output to understand the mapping.
KM propertyBMC Helix Continuous Optimization mapping
MetaFQDNsystem name/lookup field
MetaEntityTypeentitytype
MetaTokenIDlookup field
Instancesrelationships/child devices
Config variablesconfiguration metrics
3

Check the KM properties by using the Agent Query Actions on the TrueSight Operations Management or the PSL commands on the PATROL console.

The table provides details of the KM properties, how to retrieve it by using PSL commands, an example for the VMware VSphere KM and how to map it to BMC Helix Continuous Optimization.

KM property and descriptionPSL command and example
MetaFQDN

DNS name/IP address

DNS name and forward slash (/) are mandatory; IP address is not.

%PSL print(get("/<APPLICATION_CLASS>/<INSTANCE_ID>/MetaFQDN"));

Example:

OS>%PSL print(get("/VSM_VM/vw-pun-bpm-qa54@vm-62_vw-vc-qa54-vm2/MetaFQDN"));

Output: vw-vc-qa54-vm2/10.129.56.174

Map DNS Name and IP Address to BMC Helix Continuous Optimization system name and a possible lookup field.
MetaEntityType

String that identifies the type of devices.

Example:

  • Amazon.EC2 for AWS EC2
  • VmWare.Host for VMware Host
  • VmWare.Virtual_Machine for VMware VM, and so on

%PSL print(get("/<APPLICATION_CLASS>/<INSTANCE_ID>/MetaEntityType"));

Example:

OS>%PSL print(get("/VSM_VM/vw-pun-bpm-qa54@vm-62_vw-vc-qa54-vm2/MetaEntityType"));

Output: VmWare.Virtual_MachineMap existing device types and MetaEntityType with existing BMC Helix Continuous Optimization entity types.

MetaTokenID

String that represents the token ID. Through token IDs, the same devices that are monitored via various KMs are reconciled and data is used for correlation. It uses the CMDB token ID format.

Example

  • EC2-UUID:<InstanceID> for AWS EC2
  • hostname:domain (test-123:bmc.com), and so on.

%PSL print(get("/<APPLICATION_CLASS>/<INSTANCE_ID>/MetaTokenID"));

Example:

OS>%PSL print(get("/VSM_VM/vw-pun-bpm-qa54@vm-62_vw-vc-qa54-vm2/MetaTokenID"));

Output: VI-UUID:4237b33f-30a4-da23-afd4-9fa3163e7370

Map this output to a BMC Helix Continuous Optimization lookup field in the JSON file.

Instances

Each running copy of an application discovered by PATROL is called an instance of the particular application class.

%PSL print(get("/<APPLICATION_CLASS>/instances"));

Example:

OS>%PSL print(get("/VSM_VM/instances"));

Output: vw-pun-bpm-qa54@vm-62_vw-vc-qa54-vm2

Map instances in the KM to relationships or child devices in BMC Helix Continuous Optimization.

Configuration variables

The configuration variables are found in the KM XML file. These are defined with the configVariables attribute.

Example: configVariables="osName"

Map configuration variables in KM to configuration metrics in BMC Helix Continuous Optimization.

Navigate to Administration > DATA WAREHOUSE > Datasets & metrics and look for a suitable configuration metric (or create a custom one) to map the configuration variable.

4Verify the KM parameters to the TrueSight Operations Management mapping and add it to the JSON file.

  1. Check the parameters in the KM XML file. 
    The default location is <TrueSight Presentation Server installedDirectory>\truesightpserver\modules\cma\pproxy\depot_directory\bmc_products\kmfiles\<KM name>\lib\knowledge.

    From the Applications tag in the XML, identify the application class that contains the list of metrics (parameters). The highlighted parameters are column names that contain the metric and its values.

  2. After you identify the application class name, prefix _PATROL__ to the application class name to form the view name that you need to add in the custom JSON file. This is the source view name that contains the metric and its value.
    Example: "src_monitor_type": "_PATROL__VSM_CPU_VM"

    The entry _PATROL__VSM_CPU_VM corresponds to a table name in the TrueSight Operations Management SAP SQL Anywhere (Sybase) database, where the data is located. If the database is Oracle, the name is similar, but with an ID inside. This is due to an Oracle database table name limitation of 32 characters.

    The parameter name corresponds to a column in the same table and needs to be inserted in the JSON file as a value of src_metric.
    Example: "src_metric": "CPU_Guaranteed"

  3. To identify the BMC Helix Continuous Optimization metric that is equivalent to the KM parameter, navigate to Administration > DATA WAREHOUSE > Datasets & metrics and look for a suitable metric (or create a custom one) to map the attribute.

    To filter the metric name, see the following example.



    The name of the BMC Helix Continuous Optimization metric chosen or created needs to be entered in the JSON file as a value of dst_metric.
    Example: "dst_metric": "BYGMCPU_CPU_GUARANTEED"


5Download the sample JSON file.
6Update the corresponding information in the JSON file.
  1. Define a platform “type” name for the JSON file. Example: "VMware KM”.
  2. Specify entity-level structure details:
    1. Source-to-Destination mapping
    2. Children for the entity
    3. Lookup entries for the Destination
  3. Specify metric-level mapping details for Basic metrics:
    1. Basic metrics are a 1:1 mapping between the Source and the Destination metric with a conversion formula, if required
    2. Specify how to map “BY” metrics and how to filter sub objects using criteria

  4. Define the Derived and Aggregated metrics, if required.

    • “Derived” metrics are computed at an entity level by using more than one metric of the same entity, using formula.
    • “Aggregated” metrics are computed at an entity level by using metrics of different entities that can be children, parent or subject, using formula.

7

Save the JSON file to your local computer.

Example: <platformname>-platform-def.json.


8Upload the file to a folder on the ETL Engine server.

Step II. Configure the ETL

You must configure the ETL to connect to TrueSight Operations Management 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

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

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. The Add ETL page displays the configuration properties. You must configure properties in the following tabs: Run configuration, Entity catalog, and TrueSight Operations Management Connection.
  3. On the Run configuration tab, select BMC - TrueSight Operations Management 10.7/11.0/11.3 Generic 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.


  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.

  5. Click the TrueSight Operations Management Connection tab, and configure the following properties:

    PropertyDescription
    Data Integration API URLSpecify the host name and port number of the Presentation Server in the provided URL format: 
    • If you are using the host name to connect to the Presentation Server specify:
      https://<host>/tsws. Replace <host> with the host name.
    • If you are using the host name and port number to connect to the Presentation Server specify:
      https://<host>:<port>/tsws. Replace <host> with the host name and <port> with port number.
    UsernameType the user name to connect to the Presentation Server. You can use the default user, apiuser.
    PasswordType the password for the specified user name to connect to the Presentation Server.
    Tenant nameSpecify the name of the tenant for which the data needs to be extracted. The tenants are configured on the Presentation Server. By default, * is provided.
    Platform definition JSON file pathSpecify the path where you saved the JSON file that has the platform specific entity definition, configuration, and performance metrics mapping.

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

    PropertyDescription
    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.

    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:

    • New domain: This option is selected by default. Select a parent domain, and specify a name for your new domain.
    • Existing domain: Select an existing domain from the Domain list. 

    By default, a new domain with the same ETL name is created for each ETL. 

    PropertyDescription
    Task groupSelect a task group to classify the ETL.
    Running on schedulerSelect a scheduler for running the ETL. For cloud ETLs, use the scheduler that is preconfigured in Helix. For on-premises ETLs, use the scheduler that runs on the Remote ETL Engine.
    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 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.

  7. Click Save.
    The ETL tasks page shows the details of the newly configured BMC TrueSight Operations Management ETL.

(Optional) B. Configuring the advanced properties

You can configure the advanced properties to change the way the ETL works or to collect additional metrics.

To configure the advanced properties:

  1. On the Add ETL page, click Advanced.

  2. Configure the following properties:

    PropertyDescription
    Run configuration nameSpecify 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 statusSelect 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 levelSpecify 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.

    PropertyDescription
    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.


    PropertyDescription
    Connect TimeoutThe duration up to which the ETL attempts to connect to the Presentation Server before the timeout occurs. The default timeout is 15 seconds.
    Read TimeoutThe duration up to which data is read from the Presentation Server before the timeout occurs. The default timeout is 15 seconds.

    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.

    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

    Continuous Optimization loader output file name

    The name of the file that is generated by the Continuous Optimization loader. The default value is: %BASE/output/%DSNAME%AYEAR%AMONTH%ADAY%AHOUR%ZPROG%DSID%TASKID

    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 Continuous Optimization. It uses one of the other ETLs that share a lookup to create a new entity. The default selection is False.

    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 BMC TrueSight Operations Management 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. 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 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 BMC Helix Continuous Optimization database.

Step IV. Verify data collection

Verify that the ETL ran successfully and check whether the TrueSight Operations Management 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 TrueSight Operations Management data is refreshed:

  1. In the Workspace tab, expand BMC TrueSight Operations Management 10.7/11.0/11.3 Generic extractor > Systems.
  2. In the left pane, verify that the hierarchy displays the TrueSight Operations Management instances.
  3. Click a TrueSight Operations Management instance, and click the Metrics tab in the right pane.
  4. Check if the Last Activity column in the Configuration metrics and Performance metrics tables displays the current date.

The following image shows sample metrics data.

Related topics

Platform definition JSON file structure

Was this page helpful? Yes No Submitting... Thank you
Last modified by Shweta Patil on Nov 08, 2021
reference connectors integration bppm tsom etls wide-layout

Comments

Log in or register to comment.

Entities, metrics, lookup information, and API calls for the BMC - TrueSight Operations Management 10.7/11.0/11.3 extractor
Platform definition JSON file structure
© Copyright 2019 - 2022 BMC Software, Inc. © Copyright 2019 - 2022 BladeLogic, Inc.
Legal notices

Powered by Atlassian Confluence and Scroll Viewport

© Copyright 2005-2024 BMC Software, Inc. Use of this site signifies your acceptance of BMC’s Terms of Use . BMC, the BMC logo, and other BMC marks are assets of BMC Software, Inc. These trademarks are registered and may be registered in the U.S. and in other countries.