Installing and configuring HCL OneTest Server Results Data

You must install and configure IBM® Rational® Test Automation Server Results Data that is delivered as a plugin along with IBM® Rational® Test Automation Server 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 IBM® Rational® Test Automation Server in a Grafana dashboard.

Before you begin

You must have configured your installation so that Grafana server can access IBM® Rational® Test Automation Server.

Procedure

  1. Download IBM® Rational® Test Automation Server Results Data plugin from the following URL: <your server address>/artifacts/grafana/hcltechsw-otsresults-datasource.zip.
  2. Install IBM® Rational® Test Automation Server by extracting the compressed file into your Grafana plugin directory.
    Important: Before you install IBM® Rational® Test Automation Server, you must be aware that you must use an additional helm command parameter gateway.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 IBM® Rational® Test Automation Server Results Data is available in Grafana, follow these steps:
    1. Click Configuration > Plugin in the left navigation panel of Grafana.
    2. Enter HCL OneTest Server Results Data in the search bar in the Plugins tab.
    3. Click IBM® Rational® Test Automation Server Results Data in the search results.
    The IBM® Rational® Test Automation Server Results Data readme page is displayed. You can find the links to Rational® Test Automation Server documentation and the plugin's description in this page.
  6. Create an instance of data source in Grafana for IBM® Rational® Test Automation Server Results Data.
    Note: Only users with the organization admin role can add data sources.
    1. Click Configuration > Data sources in the left navigation panel.
    2. Click Add data source.
    3. In the search bar, enter HCL OneTest Server Results Data, and press Enter.

      HCL OneTest 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 IBM® Rational® Test Automation Server Results Data as the default data source in Grafana.
      Note: Ensure that IBM® Rational® Test Automation Server Results Data is accessible through a web browser.
    6. Enter a name to identify the data source.
    7. Enter Rational® Test Automation Server URL in Server.
    8. Enter the token that you created from Rational® Test Automation Server to enable third-party integrations.
    9. Click Save and test.
    If the test is successful, an instance of data source is created for IBM® Rational® Test Automation Server Results Data.

Results

IBM® Rational® Test Automation Server Results Data is displayed in the list of data sources in Grafana.

What to do next

You can retrieve the test log data in IBM® Rational® Test Automation Server by using queries.