Installing and configuring the DevOps Test Hub Results Data plugin

You must install and configure the DevOps Test Hub Results Data plugin that is packaged 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 installed Grafana on your computer.

Procedure

  1. Perform the following steps to install the DevOps Test Hub Results Data plugin:
    1. Download the DevOps Test Hub Results Data plugin from the following URL:

      <your server address>/test/artifacts/grafana/devops-testhub-datasource.zip

    2. Install the DevOps Test Hub Results Data plugin by extracting the compressed file into your Grafana plugin directory.
    3. Restart the Grafana server.
  2. Perform the following steps to configure the data source by using the DevOps Test Hub Results Data plugin:
    1. Enter the address of the local Grafana server in your web browser:
      Important: You must sign in with http://localhost:3000 or http://localhost:8080 URLs to use the plugin.
    2. Follow these steps to verify that the DevOps Test Hub Results Data plugin is available in Grafana:
      1. Click Administration > Plugins and data > Plugins 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 page is displayed. You can find the links to Test Hub documentation and the description of the plugin on this page.

    3. Perform the actions indicated in the following table to create an instance of a data source in Grafana by using the DevOps Test Hub Results Data plugin on the DevOps Test Hub Results Data page:
      Note: Users with the role of a server administrator can add data sources.
      Options Actions
      If you want to create an instance of the data source in Grafana by using the proxy connection Perform the following steps:
      1. Click Add new data source.

        The data source configuration panel is displayed.

      2. Click Default if you want to set the data source as the default data source in Grafana.
      3. Enter a name to identify the data source.
      4. Enter the URL of Test Hub in the Server field.
      5. Enter the token that you created in Test Hub.
        Note: The Use proxy is enabled by default.
      6. Click Save and test.
        Note: If the server certificate is self-signed, an error message is displayed. You must add the CA certificate to establish the connection with the server.
      7. Perform the following steps to add the CA certificate:
        1. Enable With CA Cert by using the toggle icon.
        2. Add the CA certificate in the CA Cert field that you saved during the installation of Test Hub.
        3. Click Save and test.
      If you want to create an instance of the data source in Grafana with additional Helm parameters
      Important: Before you install Test Hub, you must use an additional Helm command parameter router.allowedOrigin during the installation. You can also run this command after installation. See the Additional Helm parameters topic in the related information section.
      		Perform the following steps:
      1. Click Add new data source.

        The data source configuration panel is displayed.

      2. Click Default if you want to set the data source as the default data source in Grafana.
      3. Enter a name to identify the data source.
      4. Enter the URL of Test Hub in the Server field.
      5. Enter the token that you created in Test Hub.
      6. Disable Use proxy by using the toggle icon.
      7. Click Save and test.

Results

You have installed and configured the DevOps Test Hub Results Data plugin in Grafana.

What to do next

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