---
title: "SonarQube"
slug: "sonarqube"
updated: 2025-03-26T17:08:18Z
published: 2025-03-26T17:08:18Z
canonical: "docs.databee.buzz/sonarqube"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.databee.buzz/llms.txt
> Use this file to discover all available pages before exploring further.

# 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](https://docs.sonarsource.com/sonarqube-server/latest/).

**Integration Method:** Data Collector (API Ingest)

**Tables**: Detection Finding (2004)

This integration supports the following type of events.

| **Event** | **Description** |
| --- | --- |
| Issues | Get all the issues in the code of a Project. |
| Hotspots | Get the details of a security hotspot in the code. |

This integration supports the following versions.

| SonarQube Version | 9.9 |
| --- | --- |
| SonarQube API version | Web API |

## 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](https://docs.databee.buzz/docs/data-collector#configure-data-collector-in-databee) 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](/user-manual/docs/sonarqube#data-collector-configuration).
2. Create [SonarQube Data Feed](/user-manual/docs/sonarqube#databee-configuration) 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](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](https://docs.databee.buzz/docs/data-collector#configure-data-collector-in-databee).

### 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.**

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/sonarqube-mar2025-image-1bg5r6ya.png?sv=2026-02-06&spr=https&st=2026-10-30T12%3A19%3A21Z&se=2026-10-30T13%3A19%3A21Z&sr=c&sp=r&sig=UoXZadpd9%2FsX75owhCnIuigGwF3ueAdFn81H37mdc2k%3D)
2. From the left sidebar, select **Data Collectors**.

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/sonarqube-mar2025-image-9rsfzln1.png?sv=2026-02-06&spr=https&st=2026-10-30T12%3A19%3A21Z&se=2026-10-30T13%3A19%3A21Z&sr=c&sp=r&sig=UoXZadpd9%2FsX75owhCnIuigGwF3ueAdFn81H37mdc2k%3D)
3. To create a new data collector, scroll to the bottom of the page and click on the **Add Data Collector**.

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/sonarqube-mar2025-image-dmzojgm3.png?sv=2026-02-06&spr=https&st=2026-10-30T12%3A19%3A21Z&se=2026-10-30T13%3A19%3A21Z&sr=c&sp=r&sig=UoXZadpd9%2FsX75owhCnIuigGwF3ueAdFn81H37mdc2k%3D)
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.

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/sonarqube-mar2025-image-j77dhxg9.png?sv=2026-02-06&spr=https&st=2026-10-30T12%3A19%3A21Z&se=2026-10-30T13%3A19%3A21Z&sr=c&sp=r&sig=UoXZadpd9%2FsX75owhCnIuigGwF3ueAdFn81H37mdc2k%3D)
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) ![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/sonarqube-mar2025-image-fcjojycx.png?sv=2026-02-06&spr=https&st=2026-10-30T12%3A19%3A21Z&se=2026-10-30T13%3A19%3A21Z&sr=c&sp=r&sig=UoXZadpd9%2FsX75owhCnIuigGwF3ueAdFn81H37mdc2k%3D)

### 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]
> Note:
> 
> Use PowerShell version 7 or above, as lower versions are not compatible.
2. Run the installation script command.

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/sonarqube-mar2025-image-p68rswhz.png?sv=2026-02-06&spr=https&st=2026-10-30T12%3A19%3A21Z&se=2026-10-30T13%3A19%3A21Z&sr=c&sp=r&sig=UoXZadpd9%2FsX75owhCnIuigGwF3ueAdFn81H37mdc2k%3D)
3. Enter the collector configuration details that you have copied in the previous step.

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/sonarqube-mar2025-image-11v013eq.png?sv=2026-02-06&spr=https&st=2026-10-30T12%3A19%3A21Z&se=2026-10-30T13%3A19%3A21Z&sr=c&sp=r&sig=UoXZadpd9%2FsX75owhCnIuigGwF3ueAdFn81H37mdc2k%3D)
4. On successful installation, you will see the following message on the terminal: **Installation completed successfully**.

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/sonarqube-mar2025-image-r4932vqd.png?sv=2026-02-06&spr=https&st=2026-10-30T12%3A19%3A21Z&se=2026-10-30T13%3A19%3A21Z&sr=c&sp=r&sig=UoXZadpd9%2FsX75owhCnIuigGwF3ueAdFn81H37mdc2k%3D)

## DataBee Configuration

1. Login to the DataBee UI, navigate to **Data** > **Data Feeds** and click the **Add New Data Feed** button. ![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/sonarqube-mar2025-image-v3jyxcdr.png?sv=2026-02-06&spr=https&st=2026-10-30T12%3A19%3A21Z&se=2026-10-30T13%3A19%3A21Z&sr=c&sp=r&sig=UoXZadpd9%2FsX75owhCnIuigGwF3ueAdFn81H37mdc2k%3D)
2. Search for the **SonarQube** and click it as shown below. ![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/sonarqube-mar2025-image-n2fh13co.png?sv=2026-02-06&spr=https&st=2026-10-30T12%3A19%3A21Z&se=2026-10-30T13%3A19%3A21Z&sr=c&sp=r&sig=UoXZadpd9%2FsX75owhCnIuigGwF3ueAdFn81H37mdc2k%3D)
3. Click on the **Data Collector** for collection method. ![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/sonarqube-mar2025-image-uxtq8t79.png?sv=2026-02-06&spr=https&st=2026-10-30T12%3A19%3A21Z&se=2026-10-30T13%3A19%3A21Z&sr=c&sp=r&sig=UoXZadpd9%2FsX75owhCnIuigGwF3ueAdFn81H37mdc2k%3D)
4. Select **API Ingest** as the polling mechanism. ![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/sonarqube-mar2025-image-jxsk88dg.png?sv=2026-02-06&spr=https&st=2026-10-30T12%3A19%3A21Z&se=2026-10-30T13%3A19%3A21Z&sr=c&sp=r&sig=UoXZadpd9%2FsX75owhCnIuigGwF3ueAdFn81H37mdc2k%3D)
5. Enter feed contact information, select collector which we have created [previously](/user-manual/docs/sonarqube#add-data-collector) and click **Next**. ![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/sonarqube-mar2025-image-bpb5bfhv.png?sv=2026-02-06&spr=https&st=2026-10-30T12%3A19%3A21Z&se=2026-10-30T13%3A19%3A21Z&sr=c&sp=r&sig=UoXZadpd9%2FsX75owhCnIuigGwF3ueAdFn81H37mdc2k%3D)
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**. ![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/sonarqube-mar2025-image-cd3di3p8.png?sv=2026-02-06&spr=https&st=2026-10-30T12%3A19%3A21Z&se=2026-10-30T13%3A19%3A21Z&sr=c&sp=r&sig=UoXZadpd9%2FsX75owhCnIuigGwF3ueAdFn81H37mdc2k%3D)
7. Select the Basic Auth option from the Authorization Method dropdown. Then, enter ‘Username’ and ‘Password’. ![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/sonarqube-mar2025-image-1u4q9tyw.png?sv=2026-02-06&spr=https&st=2026-10-30T12%3A19%3A21Z&se=2026-10-30T13%3A19%3A21Z&sr=c&sp=r&sig=UoXZadpd9%2FsX75owhCnIuigGwF3ueAdFn81H37mdc2k%3D)
8. Click on **Submit**. ![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/sonarqube-mar2025-image-0fp2ldf8.png?sv=2026-02-06&spr=https&st=2026-10-30T12%3A19%3A21Z&se=2026-10-30T13%3A19%3A21Z&sr=c&sp=r&sig=UoXZadpd9%2FsX75owhCnIuigGwF3ueAdFn81H37mdc2k%3D)

## Troubleshooting Tips

- Unable to open the log files of the data collector due to permission issue. **Screenshot (Error)**: ![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/sonarqube-mar2025-image-rpfw1v07.png?sv=2026-02-06&spr=https&st=2026-10-30T12%3A19%3A21Z&se=2026-10-30T13%3A19%3A21Z&sr=c&sp=r&sig=UoXZadpd9%2FsX75owhCnIuigGwF3ueAdFn81H37mdc2k%3D)

**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)**: ![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/sonarqube-mar2025-image-2x6f8j2n.png?sv=2026-02-06&spr=https&st=2026-10-30T12%3A19%3A21Z&se=2026-10-30T13%3A19%3A21Z&sr=c&sp=r&sig=UoXZadpd9%2FsX75owhCnIuigGwF3ueAdFn81H37mdc2k%3D) **Solution:** Edit the Data source configuration with correct credentials.
- If you encounter any issues regarding log forwarding, refer to the [DataBee troubleshooting document](https://docs.databee.buzz/docs/troubleshooting) for detailed guidance.