Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
iconfalse
titleTable of Contents
Table of Contents
maxLevel2

Dashboards provide a way to display any kinds of data through widgets at different levels:

...

Project Dashboards

...

Each box on this page is called a widget. Any widget can be added to a project dashboard. Thus, any kinds of information from a project or from the SonarQube instance can be displayed at will, although project dashboards typically contain only project widgets.

Project dashboards are the entry point when looking at a project. They display an overview of the project data: measures, issues, etc.

Image Modified

The

"

Default Dashboard

" default dashboard

gives an overview of your project (with widgets like Size, etc.) and its quality (with widgets like

Rules compliance

Issues and Technical Debt, Duplications, etc.).

Image Modified

From

The metrics in each widget click through to some sort of drilldown.  From there, you will be able to hunt for

seven different kinds of quality flaw

the Developers' Seven Deadly Sins:

Duplications

Image Modified

See Duplications for detailed explanation on this quality flaw.

Bad

distribution

Distribution of

complexity

Complexity

Image Modified

See Bad Distribution of Complexity for detailed explanation on this quality flaw.

Spaghetti

design

Design

Image Modified

See Spaghetti Design for detailed explanation on this quality flaw.

Lack of

unit tests

Unit Tests

Image Modified

See Lack of Unit Tests for detailed explanation on this quality flow.

No coding standards

Coding Standards and Potential

bugs

Bugs

Image Removed

Image Added

See 

No

Coding Standards Breach for detailed explanation on this quality flaw.

See Bugs and Potential Bugs for detailed explanation on this quality flaw.

Not

enough or too many comments

Enough or Too Many Comments

Image Modified

See Not Enough or Too Many Comments for detailed explanation on this quality flaw.

 

Clicking on any measure opens the Measures Drilldown, zooming on the chosen measure.

All the widgets above are compatible with differential views to help you focus on quality flows on new code.

Many other widgets are available out of the box, just give them a try. Even more are available through plugins.

Events

The Events widget is used to highlight events occurring during the lifetime of the project. There are two kinds of events:

  • Manual: it is possible to add manual events. See Events for more details.
  • Automated: a mechanism exists to pick automatically events and record them. This is the case for changes in quality profile and
raises of alerts
Image Modified

Treemap

Image Modified

The Treemap is a generic component that adapts depending on the structure of the project: modules, packages and files. 

It shows the components that are at the top level, regardless of the type. It is then possible to drill down into any component to get a view on the component.

Three actions are available in the treemap:

  1. Click on a component name to access the component dashboard
  2. Left click on a box to zoom in a component
  3. Right click on a box to zoom out of a component 

Hunting Services

Measures Drilldown

Wherever in a project, it is always possible to access the Measures Drilldown by clicking on a measure:

Image Removed
The component structure is displayed: hierarchy is represented from left (higher) to right (lower).

Components are sorted in a descending way, worst measures for the metric first. Note that components having the best value for the metric are not displayed.

By clicking on a file, you will access the Component Viewer.

Issues Drilldown

Wherever in a project, it is always possible to access the Issues Drilldown through the left menu:
Image Removed

The component structure is displayed: hierarchy is represented from left (higher) to right (lower).

Components are sorted in a descending way, the one with the most issues first. Note that components with no issues are not displayed.

The Issues drilldown is compatible with the differential views mechanism.

By clicking on a file, you will access the Component Viewer. Anchordashboardcloudsdashboardclouds

Clouds

Wherever in a project, it is always possible to access the Clouds through the left menu:

Image Removed

On the Top risk tab, the size represents the average complexy by method in the file.

On the Quick wins tab: the size represents the lines of code in the file.

Regarding the color, blue indicates good quality according to Coverage or Rules compliance (depending the selected value in the drop down list), red indicates bad quality.

By clicking on a file, you will access the Component Viewer.

Components

Wherever in a project, it is always possible to access the Components dashboard through the left menu.

From there you can access the dashboard of a specific component. You will get the same information as for the project but restricted to the scope of the component.

Image Removed

Anchorglobaldashboardglobaldashboard

Global Dashboards

Overview

Global dashboards are available at instance level and can be accessed through the menu on the left. One of the global dashboards is set as your home page.

Any widget can be added to a global dashboard. Thus, any kinds of information from a project or from the SonarQube instance can be displayed at will.

Global Dashboard Shipped with SonarQube: Home

Image Removed