Installing and configuring DevOps Test Hub Results Data plugin

You must install and configure DevOps Test Hub Results Data plugin that is delivered along with HCL DevOps Test Hub (Test Hub) to view and analyze the log data in Grafana. You can view the test log data that is generated when you run a test from Test Hub in a Grafana dashboard.

Before you begin

You must have configured your installation so that Grafana server can access Test Hub.

Procedure

  1. Download DevOps Test Hub Results Data plugin from the following URL: <your server address>/artifacts/grafana/devops-testhub-datasource.zip.
  2. Install DevOps Test Hub Results Data plugin by extracting the compressed file into your Grafana plugin directory.
    Important: Before you install Test Hub, you must be aware that you must use an additional helm command parameter router.allowedOrigin during the installation or you can run this command after installation too as detailed in Additional Helm parameters.
  3. Restart the Grafana server.
  4. Enter the address of the local Grafana server in your web browser:
    Important: The plugin is signed to be used with http://localhost:3000 or http://localhost:8080 URLs.
  5. To verify that DevOps Test Hub Results Data is available in Grafana, follow these steps:
    1. Click Configuration > plugin in the left navigation panel of Grafana.
    2. Enter DevOps Test Hub Results Data in the search bar in the Plugins tab.
    3. Click DevOps Test Hub Results Data in the search results.
    The DevOps Test Hub Results Data readme page is displayed. You can find the links to Test Hub documentation and the description of the plugin on this page.
  6. Create an instance of data source in Grafana for DevOps Test Hub Results Data by performing the following steps.
    Note: Users with the role as a server administrator can add data sources.
    1. Click Configuration > Data sources in the left navigation panel.
    2. Click Add data source.
    3. Enter DevOps Test Hub Results Data in the search bar, and then press Enter.

      DevOps Test Hub Results Data is displayed in the search results.

    4. Click Select.

      The data source configuration panel is displayed to enter the data source settings.

    5. Click Default if you want to define this instance of DevOps Test Hub Results Data as the default data source in Grafana.
      Note: Ensure that DevOps Test Hub Results Data is accessible through a web browser.
    6. Enter a name to identify the data source.
    7. Enter the URL of Test Hub in the Server field.
    8. Enter the token that you created from Test Hub to enable third-party integrations.
    9. Click Save and test.
    If the test is successful, an instance of data source is created for DevOps Test Hub Results Data.

Results

DevOps Test Hub Results Data is displayed in the list of data sources in Grafana.

What to do next

You can retrieve the test log data from Test Hub by using queries.