SonarQube

SonarQube Server is an on-premise analysis tool designed to detect coding issues in 30+ languages, frameworks, and IaC platforms. For detailed information, please refer to the SonarQube’s official documentation.

Integration Method: Data Collector (API Ingest)

Tables: Detection Finding (2004)

This integration supports the following type of events.

This integration supports the following versions.

Prerequisites

• Access to login into SonarQube environment as an administrator user. The username and password will be used when configuring DataBee.

• The user should have a compatible version of the system in which we can configure the data collector.

• The user should have access to DataBee console.

Configuration Overview

1. Configure the Data Collector.

2. Create SonarQube Data Feed in the DataBee console.

   DataBee Parameter	Azure Parameter
   Username	Username of an admin user.
   Password	Password of the admin user
   Base URL	http://<host_ip>:<port> (e.g. http://localhost:9000)

Data Collector Configuration

To receive logs from SonarQube, a Data Collector must be installed and configured. The data collector will receive logs from SonarQube and send them back to DataBee. For more information refer to the DataBee website.

Add Data Collector

1. Login to the DataBee UI, click on the settings icon at the top right corner of the UI and navigate to the System.

   
   

2. From the left sidebar, select Data Collectors.

   
   

3. To create a new data collector, scroll to the bottom of the page and click on the Add Data Collector.

   
   

4. Fill in the required fields to add data collector:

   • Collector Name: enter the name of your Data Collector.

   • OS: select OS type of your host machine in which we are going to configure data collector.
     Click Next to proceed to the next step. Installation steps windows will appear.

     
     

5. Copy the following details using Copy to Clipboard for later use, then click on Close.

   • Install Script

   • Tenant ID

   • Receiver URL

   • Collector ID

   • API Key (Click Show API Key to view it)
      

Install Data Collector on Windows

This section describes installing the data collector on a Windows machine. Refer to DataBee help pages to get the flow for installing on Linux.

1. Open the PowerShell terminal as the Administrator on the host machine where we want to install data collector.

   Note:

   Use PowerShell version 7 or above, as lower versions are not compatible.

2. Run the installation script command.

   
   

3. Enter the collector configuration details that you have copied in the previous step.

   
   

4. On successful installation, you will see the following message on the terminal: Installation completed successfully.

   
   

DataBee Configuration

1. Login to the DataBee UI, navigate to Data > Data Feeds and click the Add New Data Feed button.
    

2. Search for the SonarQube and click it as shown below.
    

3. Click on the Data Collector for collection method.
    

4. Select API Ingest as the polling mechanism.
    

5. Enter feed contact information, select collector which we have created previously and click Next. 
    

6. Add the base URL of the appliance where the SonarQube instance is installed. With Issues and Hotspots as the event type. Then click on Next.
    

7. Select the Basic Auth option from the Authorization Method dropdown. Then, enter ‘Username’ and ‘Password’.
    

8. Click on Submit.
    

Troubleshooting Tips

• Unable to open the log files of the data collector due to permission issue.
  Screenshot (Error):
   

  Solution: open the terminal and execute the following command to solve the issue.
  chown <user> <path-of-file>

• Incorrect credential values were entered for authorization details while configuring data feed or credentials got expired.
  Screenshot (Error logs):
   
  Solution: Edit the Data source configuration with correct credentials.

• If you encounter any issues regarding log forwarding, refer to the DataBee troubleshooting document for detailed guidance.