Understanding SonarQube Reports

SonarQube reports encompass three distinct dimensions: a feature within the Sonar software tool, a service provided to users, and a type of data. As a feature, SonarQube reports are built into the client interface, providing default and customizable reports for users with the appropriate licenses. The reports cover various topics, such as account changes, data usage, and inventory management, among others. These are rich with information and serve as a crucial tool for business analysis.

As a service, SonarQube offers PDF reports in its Enterprise Edition and above, giving a high-level overview of code quality and security. These reports can be scheduled for periodic delivery and shared with both SonarQube users and non-users. This service is particularly valuable for stakeholders who require regular updates on the state of the codebase.

Lastly, as a type of data, SonarQube reports provide insights into software quality and vulnerability, invoiced revenue, payments, and other financial metrics. The data in these reports is essential for maintaining code integrity, ensuring financial transparency, and making informed decisions based on the status of various business operations within Sonar.

SonarQube Report Plugins for Excel

Manual Excel Report Building

You can manually build reports in Excel by utilizing the Web API to pull data from your SonarQube instance. This involves making web service calls to retrieve the data from SonarQube.

Using Web API Services

Data for Excel can be obtained through the api/measures/component or api/measures/component_tree services provided by the SonarQube Web API. These services enable users to extract the necessary data for report generation.

Excel Plugin for SonarQube

There is an Excel plugin for SonarQube that facilitates the generation of Excel reports. This plugin simplifies the process by allowing users to create reports directly within Excel.

SonarQube Enterprise Edition Reporting

The Enterprise Edition of SonarQube offers a report feature that can export analysis reports to Excel. Additionally, it can extract a PDF report containing project information, metrics, and trend history.

Common Use Cases

• S

  
  Use case 1: Facilitating the import of SonarQube code coverage metrics into Excel using the From Web feature for analysis and record-keeping
• S

  
  Use case 2: Enabling users to utilize the SonarQube Web API to fetch JSON formatted data for Excel integration, specifically using the api/measures/component and api/measures/component_tree services
• S

  
  Use case 3: Assisting in the manual construction of comprehensive reports in Excel that aggregate code coverage metrics for all projects in SonarQube
• S

  
  Use case 4: Streamlining the process of making multiple API calls to generate a complete report of code coverage for all projects within SonarQube
• S

  
  Use case 5: Offering an alternative solution for users to query SonarQube data using SQL for Excel integration, potentially reducing the complexity of using the Web API

Frequently Asked Questions

How can I export SonarQube code coverage metrics to Excel?

You can export SonarQube code coverage metrics to Excel by using the 'From Web' feature in Excel's 'Get External Data' section. You will need to paste the SonarQube Web API URL and set the required properties to import the data.

Which SonarQube Web API endpoints are used for exporting code coverage metrics to Excel?

The Web API endpoints used for exporting code coverage metrics to Excel are api/measures/component and api/measures/component_tree.

Can I use SQL queries to export SonarQube reports to Excel?

While it is technically possible to use SQL queries to extract data from the SonarQube database, this approach is not recommended by SonarQube staff, as the database is considered a black box.

Is the Web API feature available in all editions of SonarQube for Excel integration?

Yes, the Web API feature is available in all editions of SonarQube, including the Community and Enterprise editions.

Can I generate a report in Excel that shows all projects and their code coverage using SonarQube?

Yes, generating a report in Excel that shows all projects and their code coverage is possible by making multiple API calls to SonarQube and combining the data into a single file.