QuerySurge Ready For Analytics using Metabase setup guide

Versions: 8.0+

Overview

The QuerySurge add on 'Ready for Analytics' gives users access to the QuerySurge backend MySQL database. 

• Access to QuerySurge historical data that can be queried and analyzed to identify patterns, bottlenecks, or recurring data quality issues.

• Users can create custom dashboards using external BI tools based on QuerySurge test data.

• You can define and track key performance indicators (KPIs) related to data quality and testing success/failure rates over time

With the Ready for Analytics add on users can connect to the backend QuerySurge database using there companies BI solution, such as Power BI, Tableau and Strategy (formerly MicroStrategy). However, since many users do not have access or a license to the BI solution, QuerySurge recommends Metabase as a free open-source BI tool for setting up custom reports and dashboards in there environment.

Metabase is an open-source business intelligence (BI) tool that allows users to create dashboards and data visualizations. It's designed to be user-friendly, allowing individuals without extensive technical knowledge to explore and visualize data.

Prerequisites

• A QuerySurge instance Licensed with the add-on ‘Ready for Analytics’

  • To Verify you have the add-on license:

    1. Login to QuerySurge

    2. Navigate to 'Administration'

    3. Select 'License Information'

    4. Verify 'Ready for Analytics' is enabled

• We recommend version 21 of JRE from Eclipse Temurin with HotSpot JVM. You can run Metabase wherever Java 21 runs. Earlier Java versions aren’t supported.

Setup QuerySurge Back-end Access

1. Navigate to Knowledge base article: Ready for Analytics: QuerySurge Back-end Access

2. Follow the steps in the article to get access to the back-end of QuerySurge

3. Make sure to keep your new password saved for later steps

Note: You must be logged into the knowledge base with a user that has access to the ‘Ready for Analytics’ articles. Please visit QuerySurge support if access has not yet been granted. QuerySurge Support

Download and Setup MySql Workbench (Optional)

Note: Setup provided for users that do not have a preferred SQL Analyzer. Is not required for QuerySurge 'Ready For Analytics'.

1. Navigate to MySQL WorkBench

2. Download and install MySQL Workbench

3. Launch MySQL Workbench

4. Select Database -> Manage Connections

5. Click New to create a new connection

6. Enter QuerySurgeDB in the connection name field

7. Enter the hostname for the QuerySurge MySQL database (localhost if your MySQL database is on your local machine)

8. Enter biuser in the username field

9. Click Test Connection

10. Enter credentials for user biuser (Password: From previous step)

 

Download and Install Metabase

There are 3 basic ways to install Metabase.

• Self hosted as a Jar

• Self hosted in Docker

• In the Metabase Cloud

For the purpose of a POC or trial QuerySurge recommends the self hosted java install. Review the different ways here: Metabase Install

Self Hosted Java Install

1. Download Metabase

2. Create a new directory and move the Metabase JAR into it.

3. Open a command line window

4. Change into your new Metabase directory and run the JAR:

java --add-opens java.base/java.nio=ALL-UNNAMED -jar metabase.jar

Note: We recommend version 21 of JRE from Eclipse Temurin with HotSpot JVM. You can run Metabase wherever Java 21 runs. Earlier Java versions aren’t supported.

Note: If you do not have java installed on your machine follow the Metabase setup instructions here: Running the Metabase OSS JAR file

Configure Metabase to Connect to QuerySurge

1. Open a browser and navigate to http://<Server IP>:3000/
   • Example for localhost: http://localhost:3000/
2. Click 'Let's get started'
3. Select your language preference and click 'Next'

4. Enter 'What shall we call you?' information including email and password. Click 'Next'                                                

   Note: Ensure you save your email and password information you will need this each time you sign in to Metabase.

5. Enter 'What will you use Metabase for?' information and click 'Next'
6. Select 'MySQL' on the 'Add your Data' step
7. Enter a 'Display Name' for your connection (Recommended name 'QuerySurgeDB')

8. Enter the QuerySurge DB hostname or IP and Port. (Default Port for QuerySurge is 3306)

   

9. Enter 'qsdbglobal' in the database name field
10. Enter the QuerySurge database user 'biuser'

11. Enter the QuerySurge database password (Your password you set above when performing the 'Setup QuerySurge Back-end Access' steps

    

12. Click 'Connect database'
13. Select your 'Usage data preferences' and click 'Finish'
14. Click 'Take me to Metabase'

Congratulations you have now setup Metabase for QuerySurge!