Deploying and configuring Pure Storage REST API ETL for TrueSight Capacity Optimization

This topic contains the following sections:

Compatibility details

TrueSight Capacity Optimization

TrueSight Capacity Optimization v11.3.01

Pure Storage flash arrays

Any Pure Storage flash array that supports Pure Storage REST API version 1.6 or higher. The ETL was tested and validated with the REST API v1.6 and v1.11.

Prerequisites

Before installing Pure Storage REST API ETL for TrueSight Capacity Optimization, you must ensure that the following requirements are met:

  • Your Pure Storage flash array supports Pure Storage REST API v1.6 or higher

  • An API Token has been created as explained below. 

Creating the API Token

Because the Pure Storage REST API uses authentication tokens to create sessions, you will have to first create an API token to be able to collect capacity information. The procedure is as follows:

  1. Log in to the Purity GUI. Default credentials are pureuser/pureuser. 
  2. Under the SYSTEM tab, navigate to Users > API Tokens.
  3. Click  and select Add API Token.
  4. Enter a Username and click Create.

  5. The API Token is now created. To view it, click  next to the username you have just added and select Show API Token:

    A pop-up is displayed. Copy the API token. This information will be required when configuring the Pure Storage REST API ETL.

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.

Configuring the ETL module

Complete the following steps to configure an ETL service and add it as an ETL task to extract capacity and performance metrics:

  1. Navigate to Administration > ETL & SYSTEM TASKS > ETL tasks.
  2. In the ETL tasks page, under the Last run tab, click Add > Add ETL. The Add ETL page is displayed.
  3. In the Run configuration tab, in the ETL module property, select Storage - Pure Storage REST API Extractor Service:

  4. Specify values for the common and advanced properties that are listed under the expandable tabs. To view or configure advanced properties, click Advanced.
    For details about the common properties, see ETL common configuration properties. The following table lists the properties that are specific to the Pure Storage REST API ETL module:
     


    Note

    Basic properties that are displayed by default in the Add ETL page are the most common properties that you can set for an ETL.
    Property Description
    Connection settings
    Hostname

    Hostname or IP address of the Pure Storage system.

    API Token

    API token to be used by the Pure Storage REST API to create sessions and collect capacity information. For more information, refer to Creating the API Token.

      ETL additional settings
     Volumes This property allows you to disable or enable volumes monitoring and fine-tune the creation of volume entities in the TrueSight Capacity Optimization environment. For more information, refer to the section "Customizing Volumes Monitoring" below.


    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.
    Property Description
    Collection level
    Levels up to

    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.
    For more information about Aging Class Mapping, refer to the topic
    Adding and managing metric profiles.

  5. Click Save. You are returned to the Last run tab under the ETL tasks page.
  6. 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.
  7. 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.
  8. 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.

Post-configuration steps

Testing the connection to the REST API

The ETL relies on the REST API to collect information about Pure Storage systems. Because some connectivity issues may exist and cause the ETL to fail, it is highly recommended to test the connection to this specific component. The procedure is as follows:

  1. Download the troubleshooting tool from EPD.
  2. Run the command java –jar <Troubleshooting_Tool_Name.jar> to launch the tool.
  3. Enter the information required to connect to the system and click Test Connection.
  4. Wait for the test to complete.
  5. If a connectivity issue is detected, an error message will appear. In this case, the issue encountered does not concern the ETL. Check your configuration to diagnose the source of the issue.
  6. Click Save As to export the connection test results into a txt file.

Hiding the API token ID

Starting with version 11.3.01, the API token ID is displayed as a hidden password.

If you are upgrading from a previous version of the ETL and wish the API token ID to be hidden, you can either:

  1. Remove the ETL task and create a new one
    or
  2. Change the ETL property that manages the API token ID display.
    In previous versions of the ETL, the API token ID display was managed by the apiToken property that made the API token to appear in clear in the console. In order to hide the API token ID, the ETL must use the new property apiToken.password, that is installed, by default, with version 11.3.01. Therefore, the apiToken property must be removed:
    1. Select the ETL task you wish to modify and click the edit icon.
    2. Expand the Connection Settings section and enter your API token.
    3. At the bottom of the page click the hyperlink this page to manually modify the ETL properties.
    4. Click the remove icon next to apiToken.
    5. Click Save.

Customizing volumes monitoring

Discovering volumes and collecting their performance metrics are resource-intensive actions that can create extra workload on the system. To reduce the system resource consumption, administrators can disable or enable the volumes monitoring at will and fine-tune the creation of volume entities into the TrueSight Capacity Optimization environment.

The following metrics are no longer collected and displayed in the console when volumes monitoring is disabled:

DatasetMetrics
STOGLB
  • ST_CONFIGURED_VOLUME_CAPACITY (Storage System Configured Capacity)
  • ST_CONFIGURED_VOLUME_CAPACITY_PCT (Storage System Configured Capacity Percentage)
  • ST_OVERSUBSCRIBED_CAPACITY (Storage Oversubscribed Capacity)
  • ST_VOLUME_CONSUMED_CAPACITY (Volume Consumed Capacity)
  • ST_VOLUME_CONSUMED_CAPACITY_PCT (Volume Consumed Capacity Percentage)
  • ST_VOLUME_HOST_VISIBLE_CAPACITY (Host Volume Visible Capacity)
  • ST_VOLUME_IO_RATE (Total number of operations per second performed on the volume)
  • ST_VOLUME_IO_READ_RATE (Number of read operations per second performed on the volume)
  • ST_VOLUME_IO_WRITE_RATE (Number of write operations per second performed on the volume)
  • ST_VOLUME_MAPPED (Volume Mapped)
  • ST_VOLUME_RESPONSE_TIME (Volume Response Time)
  • ST_VOLUME_TIME_SINCE_LAST_ACTIVITY (Volume Time Since Last Activity)
  • ST_VOLUME_TRANSFER_BYTE_RATE (Volume Transfer Byte Rate)
  • ST_VOLUME_TYPE (Storage Volume Type)
  • VOLUME_EXTERNAL_I (Volume External Unique Identifier)

To customize volumes and shares monitoring

  1. Edit the Pure Storage REST API ETL Run Configuration.
  2. Expand the ETL additional settings menu.
  3. From the Volumes pull-down lists, select one of the following options:

    OptionResult
    Disabled
    • Volumes are not discovered.
    • Volumes-related metrics are not loaded in the console.

    Note

    Use this configuration if the number of volumes to manage significantly slows down the system performance. Disabling the volumes monitoring prevents the discovery of volumes and consequently does not allow the ETL to collect, save or process their data. Note that the calculation of metrics for other sources may be impacted.
    Collected for metric computation (Default)
    • All volumes are discovered and their metrics are collected and processed.
    • Volumes-related metrics are not loaded in the console.

    Note

    Use this configuration if you wish to collect and process volume/shares-related metrics without loading this information in the console. The collected data will however be used to calculate metrics for other sources, when required. This will reduce the resource consumption of your system.

    Collected and Imported
    • All volumes are discovered and their metrics are collected and processed.
    • Volumes-related metrics are saved in the database, processed and loaded in the console.

    Note

    Use this configuration if your system is powerful enough to manage all the volumes to monitor.

  4. Click Save.

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.

Lookup details

Pure Storage REST API ETL for TrueSight Capacity Optimization defines the following lookup fields:

Entity typeLookup fields
Storage SystemDEFAULT
Storage PoolDEFAULT
Storage VolumeDEFAULT

apiToken

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

Comments