Page tree
    Skip to end of metadata
    Go to start of metadata

    This topic describes how to integrate TrueSight Capacity Optimization with Atrium Discovery and Dependency Mapping (Atrium Discovery). This ETL extracts service-system and application-system relationships discovered by Atrium Discovery and Dependency Mapping (ADDM). Use this extractor to place systems in the BCO service tree using dependencies discovered by Atrium Discovery and Dependency Mapping. Configuration and performance data for the systems should be loaded using another connector. For keeping the discovered relationships up to date, this extractor needs to be run again after re-discovery. Use BMC - Atrium CMDB extractor instead for automatically keeping the relationships updated.

    Note

     BMC - Atrium Discovery and Dependency Mapping (ADDM) extractor is deprecated in version 10.7 of TrueSight Capacity Optimization. For more details, see Deprecated and dropped features and components.

    This topic contains the following sections:

    Supported versions

    Connector nameSupported version of Atrium Discovery and Dependency Mapping

    BMC Atrium Discovery and Dependency Mapping (ADDM) extractor

    8.2, 8.3, 9.0, 10.0, 10.1, 10.2, 11.0, and 11.1.

    To export data from Atrium Discovery

    1. Log in to the Atrium Discovery UI, as described in Logging in to the BMC Atrium Discovery UI.
    2. Access the Discovery tab to discover your environment. Discover data by using the BMC Atrium Discovery tool.
    3. Create an export of CSV data from Atrium Discovery, following these steps:
      1. From the Administrator tab in the model section, click on the Export link.
      2. Set up an export on the Export page as described in Setting up and Configuring an Export.
        Exporting data from the Atrium Discovery needs an Adapter and a Mapping Set.
      3. To create a Adapter, go to the Adapter Configuration tab and create a new CSV File adapter that specifies the server where the data will be exported, the protocol used for transferring the data and the login credential if required for the protocol.
      4. Configure the Adapter to export data directly to the TrueSight Capacity Optimization application server:
        1. Go to the Adapter Configuration tab and select the CSV File Configuration link.
        2. Click New to create a new CSV file Adapter.
        3. Specify a name and description to the Adapter.
        4. Select a protocol (SCP or SFTP).
        5. Specify the destination server, that is the BMC TrueSight Capacity Optimization application server.
        6. Provide the BMC TrueSight Capacity Optimization application server login credentials.
        7. Specify the path where data should be exported.
        8. Click Apply and Test to test the connection.
      5. Configure an extended RDB Mapping Set for exporting CSV data, as described in The Extended RDB Mapping Set.
      6. Create a new export by selecting the adapter configuration and mapping sets created in the previous steps, as described in Creating a New Exporter.
    4. Execute the export.
      1. After the new export is created, run it through the UI or through the CLI, as described in Running an Export.
      2. Verify the execution by checking the logs and the location where you configured the CSV files to be exported.

    The creation process (step 3) only needs to be executed once, while the execution process (step 4) can be repeated whenever you want to export data.

    Integration steps

    To integrate TrueSight Capacity Optimization with the ADDM Parser, 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 - Atrium Discovery and Dependency Mapping (ADDM) extractor.
      Module description A link in the user interface that points you to this technical document for the ETL.
      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
      Associate new entities to

      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.

      By default, a new domain is created for each ETL, with the same name of the extractor module. As the ETL is created, a new hierarchy rule with the same name of the ETL task is automatically created, with status "active"; if you update the ETL specifying a different domain, the hierarchy rule will be updated automatically.

      Select any one of the following options:

      • New domain: Create a new domain. Specify the following properties:
        • Parent: Select a parent domain for your new domain from the domain selector control.
        • Name: Specify a name for your new domain.
      • Existing domain: Select an existing domain. Make a selection for the following property:
        • Domain: Select an existing domain from the domain selector control.
          If the selected Domain is already used by other hierarchy rules, a Domain Conflict option is displayed. Select one of the following options:
          • Enrich domain tree: create a new independent hierarchy rule to add a new set of entities and/or relations not defined by other ETLs (for example this ETL is managing storage while others are managing servers).
          • ETL Migration: this configuration is recommended if new ETL manages same set of entities and/or relations (already defined in current domain tree). Typical use case is the migration from one or more ETLs to a new ETL instance. It will stop all relations imported by ETL instances and restore only valid relations after first run; this configuration reuses existing hierarchy rule to correctly manage relation updates.
      ADDM configuration
      Exported files location Specify the location where you want to keep your exported files.
      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 Scheduler: Runs on the AS
      • Generic Scheduler: 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 DayEach 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
      Datasets

      Enables you to select or deselect metric groups for which data will be populatedAvailable 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 fromAvailable datasets and click >> to move them to Selected datasets.
      3. Click Apply.
      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 modifying 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 modifying 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 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, see Accessing data using public views and Sizing and scalability considerations.

      Reduce priority

      Select either Normal or 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 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.

    ETL details

    Imported entities

    The ETL for BMC Atrium Discovery creates:

    • A domain for each Business Application Instance discovered.
    • An additional domain, "Unassociated hosts", that groups all objects not associated to a Business Application Instance.
    • A system for every server discovered; the system is associated to the domain that is using it, replicating the host information in BMC Atrium Discovery for each Business Application Instance.

    The metrics imported in BMC TrueSight Capacity Optimization for each discovered system are:

    • CPU_NUM
    • CPU_MHZ
    • CPU_MODEL
    • OS_VER
    • OS_TYPE
    • HW_MODEL
    • HW_VENDOR
    • TOTAL_REAL_MEM
    • SERIAL_NUMBER

    Note

    The BMC Atrium Discovery ETL covers only standalone servers and does not import VMware platforms.

    Lookup notes

    The BMC Atrium Discovery ETL uses the hostname as lookup information. If you want to collect performance data with another BMC TrueSight Capacity Optimization ETL, verify that:

    • The lookup table is shared between the BMC Atrium Discovery ETL and the performance data ETL.
    • The ETL that imports performance data is also using the hostname as lookup identifier.

    Note

    By default, this ETL module removes the domain suffix from the data source name. If you are sharing the Atrium Discovery connector with other ETLs, ensure that these ETLs are also configured.

    Metrics and relationships

    Entity Type

    Storage Area Network

    BCO Metric

    BCO Unit

    Data source metric

    Data source Unit

    Description

    Data source  reference

    BCO Dataset

    Aggregation level

    CPU_NUM

    QTY

    -

    Number of CPU cores

    The number of CPU cores physically on the system.

    -

    SYSCNF

    -

    CPU_MHZ

    GHz

    -

    CPU core clock frequency

    The frequency of each physical CPU core

    -

    SYSCNF

    -

    CPU_MODEL

    -

    -

    CPU hardware model

    The hardware model of CPU

    -

    SYSCNF

    -

    OS_VER

    -

    -

    OS Version

    A string representing the version of the operating system.

    -

    SYSCNF

    -

    OS_TYPE

    -

    -

    Operating System

    A string representing the name of the operating system.

    -

    SYSCNF

    -

    HW_MODEL

    -

    -

    Hardware Model

    The hardware model of the system.

    -

    SYSCNF

    -

    HW_VENDOR

    -

    -

    HW_VENDOR

    The hardware vendor of the system.

    -

    SYSCNF

    -

    TOTAL_REAL_MEM

     

    GB

    -

    Real memory

    The total amount of memory installed on the system.

    -

    SYSCNF

    -

    SERIAL_NUMBER

    -

    -

    Serial number

    The CMDB Serial Number for the System

    -

    SYSCNF

    -

    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

    2 Comments

    1.  

      1.