Monitoring metrics exposed by an OpenMetrics exporter

With HCL OneTest™ Server, you can monitor your system resources by using metrics data that are exposed by an OpenMetrics or a Prometheus exporter through metric counters while executing a schedule.

Before you begin

You must have at least one exporter or software to expose monitoring metrics with an OpenMetrics or Prometheus format.

You must have created a project in HCL OneTest™ Server.

About this task

The following procedure describes how to select and create OpenMetrics counters in HCL OneTest™ Server. You must set a connection between HCL OneTest™ Server and the OpenMetrics exporter to select counters.

Procedure

  1. Click Add a source and select Add an OpenMetrics exporter .
  2. In the New OpenMetrics exporter dialog box that opens, enter the OpenMetrics exporter details to access its exposition endpoint as follows:
    1. In Target host, enter the IP address or host name and port number of the host where the server is installed.
    2. Enter the Path to the exposition endpoint to point to the application where the data performance results must be stored. As the path depends on the type of exporter used, refer to the exporter's documentation and configuration to indicate the right path.
    3. In Security, enter the security parameters if required.
    4. Click Add to close the dialog box.
      The source is created successfully in the background. A dialog box opens to select the OpenMetrics counters.
  3. Click the checkboxes to select counters in the Select OpenMetrics counters dialog box.
  4. Follow these steps to create a counter:
    1. Click Add a counter.
    2. Enter a name for the new counter, in the OpenMetrics counter.
    3. Select metrics in the drop-down list or enter a keyword in the Dimensions field to enable the dynamic input help. You can also use the search field that appears in the list of metrics.
      Search for metrics
    4. Select Dimensions from the dynamic fields when they are required.
      Select different types of dimensions
    5. Select the appropriate OpenMetrics counter that you are looking for.
    6. Click Create.
      Create an OpenMetrics counter dialog box
  5. Follow these steps to duplicate a counter:
    1. Select a counter in the list, and click the Duplicate icon image of duplicate icon.
    2. Modify the name of the counter and the Dimensions.
    3. Click Create.
  6. Proceed as follows to modify a new counter:
    1. Click the Modify icon.
    2. Modify the name, Metrics, and Dimensions of the counter in the Modify the OpenMetrics counter.
    3. Click Update.
    Note: You can create, duplicate, or update a counter only if the name of the counter is not already used.
  7. Click Save and close the Select OpenMetrics counters dialog box.
    Note: You can delete counters, but only the ones that you created or duplicated.

Results

The Resource Monitoring page displays the total number of sources you have added to your project and the number of sources ordered by type in cards.

What to do next

Click the links in the cards to go to the sources page and see the performance metrics for each source you added to your project. For more details, see Viewing the performance metrics.