Dell EMC Elastic Cloud Storage (ECS) ETL for TrueSight Capacity Optimization

Use the Dell EMC Elastic Cloud Storage (ECS) ETL for TrueSight Capacity Optimization to poll and collect configuration and performance data via EMC ECS REST API. The ETL uses the Storage – Dell EMC Elastic Cloud Storage (ECS) REST API Extractor Service task to collect all the metrics required for performing critical capacity optimization tasks, such as: analysis, trending, simulation and analytic modeling.

Collecting data by using Dell EMC Elastic Cloud Storage (ECS) ETL for TrueSight Capacity Optimization

To collect data by using the Dell EMC Elastic Cloud Storage (ECS) ETL 11.5.01 for TrueSight Capacity Optimization, perform the following tasks:

I. Complete the preconfiguration tasks.

II. Configure the ETL.

III. Run the ETL.

IV. Post-configuration steps.


Step I. Complete the preconfiguration tasks

The ETL is compatible with EMC ECS REST API v3.0.00.

A. Configure a Dell EMC ECS Endpoint

Before installing Dell EMC Elastic Cloud Storage (ECS) ETL for TrueSight Capacity Optimization, you must ensure that the following requirements are met:

  1. Make sure to have access to a Dell EMC ECS Endpoint

  2. Configure a management user with System Monitor role:

B. Deploying the ETL module

Complete the following steps to deploy the ETL Module:

  1. Navigate to Administration > SYSTEM > Maintenance.
  2. Verify the installation status of the already uploaded packages. If their status is "READY" or "RUNNING", wait for the installation to complete before proceeding.
  3. At the bottom of the Maintenance page, locate the Upload patch or additional package file section.
  4. Click Browse.
  5. Locate and select the ETL installation package.
  6. Click Upload.
  7. Read the Overview and click Next to continue.
  8. Read and accept the End User License Agreement.
  9. Select the server on which the operation must be executed; that is the server on which the package will be saved. Click Proceed to continue.
  10. A successful installation will result in a green line in the Additional Packages table.

    Note

     In case of unsuccessful outcome (e.g. a yellow WARNING line), click the  icon to inspect the deployment log.


Step II. Configure the ETL

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. In the TrueSight Capacity Optimization console, navigate to Administration > ETL & SYSTEM TASKS > ETL tasks.
  2. On the ETL tasks page, under the Last run tab, click Add > Add ETL. The Add ETL.The Add ETL page displays the configuration properties. You must configure properties in the following tabs: Run configuration, Entity catalog, and ETL additional settings.
  3. On the Run configuration tab, select Storage – Dell EMC Elastic Cloud Storage (ECS) REST API 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.
  4. 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 Dell EMC ECS 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 Dell EMC ECS resources.
  5. Click the Connection Settings tab, and configure the following properties:

    PropertyDescription
    Hostname

    Hostname or IP address of the Dell EMC ECS Storage system.

    Port

    Port number used by the Dell EMC ECS RESTful API Service (default: 4443).

    Connect As

    Username to connect to the Dell EMC ECS RESTful API Service.

    Password

    Password to connect to the Dell EMC ECS RESTful API Service.

  6. Click Save. You are returned to the Last run tab under the ETL tasks page. 
    1. 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.
      • 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. 
    1. Switch the ETL to production mode: Perform the following steps:
      1. In the ETL tasks table under ETL tasks > Last run, click the ETL under the Name column.
      2. In the Run configuration 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 from the source and transfer it to TrueSight Capacity Optimization database. You can see the entity hierarchy in the left Navigation pane, under Workspace.

(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

     Connection settings

    PropertyDescription
    Hostname

    Hostname or IP address of the Dell EMC ECS Storage system.

    Port

    Port number used by the Dell EMC ECS RESTful API Service (default: 4443).

    Connect As

    Username to connect to the Dell EMC ECS RESTful API Service.

    Password

    Password to connect to the Dell EMC ECS RESTful API Service.

  2. Configure the following properties

     Configuration properties

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

    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.

     Collection level

    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.

    By default, extended level metrics are not imported by the ETL. To import them, you will have to customize the collection level and set it to [4] Extended.

    To learn more about metric levels, see Aging Class mapping.

     Additional properties

    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.

    Click Add.

    In the etl.additional.prop.n field, specify an additional property.

    Click Apply.
    Repeat this task to add more properties.


     Loader configuration

    PropertyDescription
    Empty dataset behavior

    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.


    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
    Capacity Optimization loader output file nameThe 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
    Detail modeSpecify 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.

  3. Click Save. The ETL tasks page shows the details of the newly configured Dell EMC Elastic Cloud Storage ETL.
  4. Complete the procedure by performing steps 6 to 8 from the Configuring the basic properties procedure.

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. Running the ETL in the simulation mode

To run the ETL in the simulation mode:

  1. In the TrueSight Capacity Optimization console, navigate to Administration ETL & System Tasks, and select ETL tasks.
  2. On the ETL tasks page, click the ETL. The ETL details are displayed.


  1. In the Run configurations table, click Edit to modify the ETL configuration settings.
  2. On the Run configuration tab, ensure that the Execute in simulation mode option is set to Yes, and click Save.
  3. Click Run active configuration. A confirmation message about the ETL run job submission is displayed.
  4. 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.
  5.  If the ETL run status is Warning, Error, or Failed:
    1. On the ETL tasks page, click  in 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. Running the ETL in the production mode

You can run the ETL manually when required or schedule it to run at a specified time.

a. Running 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 is run, it collects data from the source and transfers it to the TrueSight Capacity Optimization database.

b. Scheduling the ETL run

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. 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 TrueSight Capacity Optimization database.



Step IV. Post-configuration steps

Running the Extractor Service task

 Click here to expand...

 

An ETL task can be run manually to retrieve performance metrics. Please note that the steps listed in this section are not mandatory and are only required if the ETL is not already scheduled for execution.

To run the ETL task:

  1. Access the TrueSight Capacity Optimization Console.
  2. In the Administration tab, select ETL & System Tasks > ETL Tasks.
  3. Click  to execute the ETL task.

When the execution is complete, the value of the Status column in the ETL tasks table changes to SERVICE_ON.

Setting the collect frequency

 Click here to expand...

 

The collect frequency is the rate at which data is collected. Collect frequency is set to 15 minutes by default, which means that it only applies to entities with an average duration of 900 seconds. It can however be modified to include more entities and performance metrics.

To know the average duration, under the Worskpace tab, select one entity, click the Metrics tab, and verify the Average duration column of the performance metrics.

To set the collect frequency:

  1. Edit the ETL Run Configuration:
    1. In the Administration tab, click ETL & System Tasks > ETL tasks.
    2. Click the link of the ETL task for which you wish to set the collect frequency.
    3. Click the Stop button to stop the service execution; then click the  Edit button available in the Run configuration section.
  2. Click the link You can manually edit ETL properties from this page provided at the bottom of the page to display a list of editable options.
  3. Locate the service.period option, and enter the number of milliseconds corresponding to the frequency at which data will be collected. If you want the collect frequency to include both storage systems and storage pools for example, you will have to set the collect frequency to 7200000 milliseconds (2 hours).
  4. Click Save.
  5. Start the ETL.



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

Comments