Adding Resource Monitoring sources to a performance schedule by using labels

You can add the Resource Monitoring sources to a performance schedule in HCL DevOps Test Performance (Test Performance) by using labels that are created in HCL DevOps Test Hub (Test Hub). After you add the Resource Monitoring sources, you can run the schedule from Test Performance.

Before you begin

You must have completed the following tasks:

  • Accessed Test Hub.

  • Configured the Resource Monitoring sources in Test Hub for your project. For more information about Resource Monitoring sources, refer to Monitoring host resources.

  • Specified the Test Hub URL in the product preferences window (Window > Preferences > Test > DevOps Test Hub > Resource Monitoring).

  • Generated an offline user token in Test Hub.

    For more information about generating an offline token, refer to Generating an offline token.

  • Selected the project in the product Preferences window from the Project to get sources from the drop-down list.

    Note: The Project to get sources from the drop-down list displays all the projects on Test Hub. The name of the team space for the project is displayed within parenthesis. You can select the appropriate project when there are identical project names in different team spaces.

About this task

After the schedule run completes, you can view the labels and the Resource Monitoring sources associated with those labels on the Resource page of the Performance Report. The Resources page also displays the Resource Monitoring sources that were unreachable or unavailable during the run time of the schedule.

You must note down the labels that you added to the Resource Monitoring sources in Test Hub. Because you must use these labels to add the Resource Monitoring sources to the performance schedule.

When you run the schedule from Test Hub, the same labels are displayed on the Results page for the schedule. You can open the schedule and go to the Details card to view the Resource Monitoring labels for the schedule that you run.

Procedure

  1. Find a schedule from the Test Navigator pane and double-click it.

    The schedule is displayed in a schedule editor.

    Note: A schedule can be a VU schedule or a Rate schedule.
  2. Perform the following steps in the Schedule Details section of the schedule editor:
    1. Select the Resource Monitoring from Service option from the Category drop-down list.
    2. Select the Enable resource monitoring from service checkbox.

      The methods of adding the Resource Monitoring sources are displayed.

  3. Select the Collect from sources matching at least one of the following labels option.
  4. Perform the following steps to select the Resource Monitoring sources to the schedule:
    1. Click Add.
      The Add Label dialog is displayed.
      Note: All labels that you added at the team space level or project level for the Resource Monitoring sources in Test Hub are available for selection.
    2. Select a label from the drop-down list.
    3. Optional: Enter a name for the label in the Enter a label field.
      You can add a label in a performance schedule, and then use the same label for the Resource Monitoring source in Test Hub before running the schedule.
    4. Click OK.
      Note: You can add multiple labels to a performance schedule if required.

    Optionally, you can edit or delete the labels that you added if required. You can select the label from the Data Source table, and then click Edit to edit an existing label. If you want to remove an existing label that you do not want to use in the schedule, you can click Remove.

  5. Enter a time duration in the Polling Time field, and then select the time unit from the drop-down list.

    The polling time is a time interval at which time the values for the Resource Monitoring source are collected when the schedule runs. For example, if you set the polling time as 5 seconds, data from the Resource Monitoring source is collected every 5 seconds.

  6. Select the Ignore invalid resources when executing the schedule checkbox to suppress any error message about the Resource Monitoring sources and continue running the schedule during the run time.
    Note: The errors can occur if the Resource Monitoring sources are unreachable or unavailable. After the schedule run completes, you can view the logs and verify the error messages.
  7. Save the schedule.

Results

You have enabled the Resource Monitoring service for a performance schedule and added the Resource Monitoring sources by using labels to the performance schedule in Test Performance.

What to do next

You can add a test to the schedule and run the schedule in Test Performance. After the run completes, you can view the labels and the Resource Monitoring sources in the Performance Report as follows:
  • The Resources page displays the following information:
    • Labels and Resource Monitoring sources associated with those labels that were monitored during the run time of the schedule.
    • All resource counters for those Resource Monitoring sources that were monitored during the run time of the schedule.
    • Unavailable Resource Monitoring sources that were unreachable or unavailable during the run time of the schedule.
  • The Performance Summary table under the Resources graph lists the following information:
    • The type of Resource Monitoring sources.
    • The most recent values of their corresponding resource counters were monitored during the run time of the schedule.