BMC - TrueSight Operations Management 9.0/9.5/9.6/10.0 Generic View Extractor

This topic describes how to configure and use the Integration with PATROL Generic View Extractor. This is an open extractor tool. It can extract PATROL parameter data from a BMC ProactiveNet Performance Management Sybase database. Use this extractor to load data collected by a PATROL Knowledge Module.

Note

This extractor supports TrueSight Operations Management versions 9.0, 9.5, 9.6, and 10.0.


Best Practice

ProactiveNet Performance Management or TrueSight Infrastructure Management has a scheduled refresh of its data once a day. By default, the refresh starts at 3:30 A.M. Ensure that the ETL run is scheduled after this refresh completes.

 

This topic contains the following sections:

Integration steps

To integrate TrueSight Capacity Optimization with the Generic View Extractor, perform the following task:

  1. Navigate to Administration >  ETL & SYSTEM TASKS > ETL tasks.
  2. In the ETL tasks page, click Add > Add ETL under the Last run tab.
  3. In the Add ETL page, set values for the following properties under each expandable tab.

    Note

    Basic properties are displayed by default in the Add ETL page. These are the most common properties that you can set for an ETL, and it is acceptable to leave the default selections for each as is.

    Basic properties

    Property Description
    Run configuration
    ETL task name By default, this field is populated based on the selected ETL module. You can specify a different name for the ETL Task. Duplicate names are allowed.
    Run configuration name Default name is already filled out for you. This field is used to differentiate different configurations you can specify for the ETL task. You can then run the ETL task based on it.
    Deploy status You can select Production or Test to mark the ETL tasks. For example, you can start by marking the task as Test and change it to Production after you have seen that you are getting what you wanted.
    Description (Optional) Enter a brief description for this ETL.
    Log level Select how detailed you want the ETL log to be. The log includes Error, Warning and Info type of log information.
    • 1 - Light: Add bare minimum activity logs to the log file.
    • 5 - Medium: Add medium-detailed activity logs to the log file.
    • 10 - Verbose: Add detailed activity logs to the log file. Info,

    Note: Log levels 5 and 10 are typically used for debugging or troubleshooting ETL issues. Using a log level of 5 is general practice, however, you may choose level 10 to get a high level of detail while troubleshooting.

    Execute in simulation mode Select Yes if you want to to validate the connectivity between the ETL engine and the target, and to ensure that the ETL does not have any other configuration issues.
    When set to Yes, the ETL will not store actual data into the data warehouse. This option is useful while testing a new ETL task.
    Module selection

    Ensure that the Based on datasource option is selected.

    Note

    If you select Based on Open ETL template, BMC TrueSight Capacity Optimization is integrated with a Generic extractor based on the selected Open ETL template. For more information, see  Generic ETL based on a template.

    ETL module (BMC recommends you to make this selection first) Select BMC - TrueSight Operations Management 9.0/9.5/9.6/10.0 Generic view extractor.
    Module description A link in the user interface that points you to this technical document for the ETL.
    Datasets

    Enables you to select or deselect metric groups for which data will be populated Available datasets. The OpenStack connector allows you to choose only from the given list of datasets, and you cannot include additional datasets to the run configuration of the ETL.

    1. Click Edit.
    2. Select one (click) or more (shift+click) datasets that you want to exclude from Available datasets and click >> to move them to Selected datasets.
    3. Click Apply.
    Entity catalog
    Sharing status Select any one:
    • Shared entity catalog: Select this option if, for the same entities, data is coming from multiple sources. For example, BPA ETL.
      • Sharing with Entity Catalog : Select an entity catalog from the drop-down list.
    • Private entity catalog: Select this option if, for the same entity, data is coming from a single source
    Object relationships
    After import

    Specify the domain where you want to add the entities created by the ETL. You can select an existing domain or create a new one.

    Select any one of the following options:

    • leave all new entities in 'Newly Discovered'.
    • move all new entities in a new Domain.
      • New domain: Create a new domain. Specify the following properties under New domain:
        • Parent: Select a parent domain for your new domain from the domain selector control.
        • Name: Specify a name for your new domain.
    • move all new entities in an existing Domain 
      • Domain: Select an existing domain from the domain selector control.
    SQL query
    SQL query This tab is only available when a custom database query has to be built in order to get the data from a generic source. The form allows you to configure the following properties. A text area in which you can type the SQL extraction query.
    Connection parameters
    Datasource type Select any one:
    • Select existing datasource
      • Datasource: Select a datasource from the drop down list.
    • Custom datasource
      • Database type: Select a database type from the drop down list.

      • Database user: Type in the database user name.

      • Database password: Enter the database password.

      • Database TNS name (Applies to Oracle): Type in the Database TNS name.

      • Data source name (Applies to Microsoft SQL Server/Sybase): Type in the data source name.

      • Database name (Applies to Microsoft SQL Server/Sybase): Type in the database name.

      • Connection URL (Applies to Other database): Enter the connection URL.

    ETL task properties
    Task group Select a task group to classify this ETL into. it is not necessary to group it into a task group.
    Running on scheduler Select the scheduler over which you want to run the ETL. The type of schedulers available are:
    • Primary: Runs on the AS
    • Generic: Runs on a separate machine
    • Remote: Runs on different remote machines.
    Maximum execution time before warning The number of hours, minutes or days to execute the ETL for before generating warnings or alerts, if any.
    Frequency Select the frequency for ETL execution. Available options are:
    • Predefined: Select a Predefined frequency from Each Day, Each Week, or Each Month.
    • Custom: Enter a Custom frequency (time interval) as the number of minutes, hours, days, or weeks to run the ETL in.
    Start timestamp: hour\minute (Applies to Predefined frequency) The HH:MM start timestamp to add to the ETL execution running on a Predefined frequency.
    Custom start timestamp Select a yyyy-mm-dd hh:mm timestamp to add to the ETL execution running on a Custom frequency.

    Note

    To view or configure Advanced properties, click Advanced. You do not need to set or modify these properties unless you want to change the way the ETL works. These properties are for advanced users and scenarios only.

    Advanced properties

    Property Description
    Run configuration
    Default last counter Set the default last counter in dd/mm/yyy hh:mm:ss format.
    Extract resolution Default value is filled out for you.
    Collection level
    Metric profile selection

    Select any one:

    • Use Global metric profile: Select this to use an out-of-the-box global profile, that is available on the Adding and managing metric profiles page. By default, all ETL modules use this profile.
    • Select a custom metric profile: Any metric profiles you add in the Add metric profile page (Administration  >  DATAWAREHOUSE  >  Metric profiles).

    For more information, see Adding and managing metric profiles.

    Levels up to

    The metric level defines the amount of metric imported into the data warehouse. If you increase the level, additional load is added to the data warehouse while decreasing the metric level reduces the number of imported metrics.

    Choose the metric level to apply on selected metrics:

    • [1] Essential
    • [2] Basic
    • [3] Standard
    • [4] Extended

    For more information, see Aging Class mapping.

    Metric filter
    Metric list <for selected dataset>

    Click Edit and select the metrics that will be loaded for each dataset that you selected under Run configuration > Datasets. If no metric is specified, all metrics will be loaded.

    Additional properties
    List of properties

    Additional properties can be specified for this ETL that act as user inputs during execution. You can specify values for these properties either at this time, or from the "You can manually edit ETL properties from this page" link that is displayed for the ETL in view mode.

    1. Click Add.
    2. Add an additional property in the etl.additional.prop.n box.
    3. Click Apply.
      Repeat this task to add more properties.
    Loader configuration
    Empty dataset behavior Choose one of the following actions if the loader encounters an empty dataset:
    • Warn: Warn about loading an empty dataset.
    • Ignore: Ignore the empty dataset and continue parsing.
    ETL log file name Name of the file that contains the ETL execution log; the default value is: %BASE/log/%AYEAR%AMONTH%ADAY%AHOUR%MINUTE%TASKID
    Maximum number of rows for CSV output A number which limits the size of the output files.
    CSV loader output file name Name of the file 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 Name of the file generated by the BMC TrueSight Capacity Optimization loader; the default value is: %BASE/output/%DSNAME%AYEAR%AMONTH%ADAY%AHOUR%ZPROG%DSID%TASKID.
    Detail mode Select the level of detail:
    • Standard: Data will be stored on the database in different tables at the following time granularities: Detail (configurable, by default: 5 minutes), Hourly, Daily, Monthly.
    • Raw also: Data will be stored on 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, Monthly.
    • Raw only: Data will be stored on the database in a table only at Raw granularity (as available from the original data source).

    For more information on granularities, see Accessing data using public views and Sizing and scalability considerations.

    Reduce priority
    • Normal:
    • High:
    Remove domain suffix from datasource name (Only for systems) If set to True, the domain name is removed from the data source name. For example, server.domain.com will be saved as server.
    Leave domain suffix to system name (Only for systems) If set to True, the domain name is maintained in the system name. For example: server.domain.com will be saved as such.
    Update grouping object definition If set to True, the ETL will be allowed to update the grouping object definition for a metric loaded by an ETL.
    Skip entity creation (Only for ETL tasks sharing lookup with other tasks) If set to True, this ETL does not create an entity, and discards data from its data source for entities not found in BMC TrueSight Capacity Optimization. It uses one of the other ETLs that share lookup to create the new entity.
    Scheduling options
    Hour mask Specify a value to execute the task only during particular hours within the day. For example, 0 – 23 or 1,3,5 – 12.
    Day of week mask Select the days so that the task can be executed only during 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 execute the task only during particular days within a month. For example, 5, 9, 18, 27 – 31.
    Apply mask validation By default this property is set to True. Set it to False if you want to disable the preceding Scheduling options that you specified. Setting it to False is useful if you want to temporarily turn off the mask validation without removing any values.
    Execute after time Specify a value in the hours:minutes format (for example, 05:00 or 16:00) to wait before the task must be executed. This means that once the task is scheduled, the task execution starts only after the specified time passes.
    Enqueueable Select one of the following options:
    • False (Default): While a particular task is already running, if the next execution command arises – it is ignored.
    • True: While a particular task is already running, if the next execution command arises – it is placed in a queue and is executed as soon as the current execution ends.
  4. Click Save.
    You return to the Last run tab under the ETL tasks page.
  5. Validate the results in simulation mode: In the ETL tasks table under ETL tasks > Last run, locate your ETL (ETL task name), click  to run the ETL.
    After you run the ETL, the Last exit column in the ETL tasks table will display one of the following values:
    • OK: The ETL executed without any error in simulation mode.
    • WARNING: The ETL execution returned some warnings in simulation mode. Check the ETL log.
    • ERROR: The ETL execution returned errors and was unsuccessful. Edit the active Run configuration and try again.
  6. Switch the ETL to production mode: To do this, perform the following task:
    1. In the ETL tasks table under ETL tasks > Last run, click the ETL under the Name column.
    2. In the Run configurations table in the ETL details page, click  to edit the active run configuration.
    3. In the Edit run configuration page, navigate to the Run configuration expandable tab and set Execute in simulation mode to No.
    4. Click Save.
  7. Locate the ETL in the ETL tasks table and click  to Run it, or schedule an ETL run.
    After you run the ETL, or schedule the ETL for a run, it will extract the data form the source and transfer it to the BMC TrueSight Capacity Optimization database.

Query structure

The query has to be formatted according to the following structure:

SELECT scfg.{ENTNM_FIELD} as SYSNM,
       scfg.{ENTNM_FIELD} as DS_SYSNM,
       [ss.{SUBENTNM_FIELD} as SUBOBJNM,]
       [ss.{SUBENTNM_FIELD} as DS_SUBOBJNM,]
       (ss.TIMERECORDED - mod(ss.TIMERECORDED,<<RESO>>) as TS,
       AVG(ss.{FIELD}) AS {BCO_METRIC}
FROM   {CONFIG_VIEW} scfg JOIN
	     {ST_VIEW} ss  ON ss.MOINSTID=scfg.MOINSTID
WHERE  convert(datetime, ctime(ss.TIMERECORDED)) > ?
			 [{OTHER_WHERE_CONDITIONS}]
GROUP BY DS_SYSNM, SYSNM, TS
ORDER BY DS_SYSNM, SYSNM, TS ASC

The following example extracts DISK_TRANSFER_RATE and DISK_IO_RATE from an Oracle database for the Microsoft Windows NT platform:

SELECT lower(scfg.DEVICENAME) as SYSNM,
       lower(scfg.DEVICENAME) as DS_SYSNM,
       ss.TIMERECORDED - mod(ss.TIMERECORDED,<<RESO>>) as TS,
       AVG((SS.READSEC + SS.WRITESEC)/1024) AS DISK_TRANSFER_RATE,
       AVG(AVGDISKTRAN) as DISK_IO_RATE
FROM   NTDISKPERF_CFG_VIEW scfg JOIN
	     NTDISKPERF_ST_VIEW ss  ON ss.MOINSTID=scfg.MOINSTID
WHERE  to_date(ss.TIMERECORDED,'YYYY-MM-DD HH24:Mi:SS') > ?
			 AND SCFG.INSTNAME = '_Total'
			 AND SS.READSEC >= 0 and SS.WRITESEC >= 0
GROUP BY DS_SYSNM, SYSNM, TS
ORDER BY DS_SYSNM, SYSNM, TS ASC

The following table lists the available and mandatory fields that can be used in the query:

Field name

Mandatory

Description

Default

SYSNM

Yes

System name

DS_SYSNM

Yes

System name as reported by data source (used for lookup)

SUBOBJNM

No

Subobject identifier

GLOBAL

DS_SUBOBJNM

No

Subobject identifier as reported by data source

GLOBAL

TS

Yes

Timestamp as reported by data source 1

SYSTYPENM

No

BMC TrueSight Capacity Optimization System type

For more information on mandatory columns, see Dataset reference for ETL tasks.

1 The <<RESO>> (or :RESO) macro has to be inserted in the query structure in order to floor data source timestamps. Aggregation resolution (set to 1 hour as default) can be changed in the General configuration tab (Advanced Mode) and will be used as sample duration.

How to find view names in the BPPM database

The following tables show patterns for naming the views that are used to store PATROL data.

For BPPM version 9.5 and later:

View name pattern
Contents
_PATROL__appclassname_ST_VIEWraw stats
_PATROL__appclassname_RT_VIEW  rate stats
_PATROL__appclassname_BL_VIEW  baseline data
_PATROL__appclassname_CFG_VIEW  instance information on all config attributes

Example:

Application class name = VSM_MEMORY_V2

Hierarchy for application class = /VSM/VSM_VC/VSM_DATACENTER/VSM_CLUSTER/VSM_RESOURCE_POOL/VSM_VM

View name for stats data is: _PATROL__VSM_MEMORY_V2_ST_VIEW

For BPPM version 9.0:

View name pattern
Contents
_PATROL__full-path-appclassname_ST_VIEWraw stats
_PATROL__full-path-appclassname_RT_VIEW rate stats
_PATROL__full-path-appclassname_BL_VIEW baseline data
_PATROL__full-path-appclassname_CFG_VIEW instance information on all config attributes

Example:

Application class name = VSM_MEMORY_V2

Hierarchy for application class =  /VSM/VSM_VC/VSM_DATACENTER/VSM_CLUSTER/VSM_RESOURCE_POOL/VSM_VM

View name for stats data is: _PATROL__VSM_VSM_VC_VSM_DATACENTER_VSM_CLUSTER_VSM_RESOURCE_POOL_VSM_VM_VSM_MEMORY_V2_ST_VIEW

Related topics

Using ETL datasets

Developing custom ETLs

Dataset reference for ETL tasks

Horizontal and Vertical datasets

Viewing datasets and metrics by dataset and ETL module

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

Comments