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:

Overview

Concepts and mechanisms described below apply for both global and project dashboards.

Creating Dashboard

Logged users can create as many dashboards as they need:

Image Removed

Click on Manage dashboards and fill the form to create a new dashboard:

Image Removed

The newly created dashboard appears immediately in the left navigation bar and and can be customized by adding widgets.

When system administrators create dashboards, they have the ability to share them. It means that these dashboards can be followed by authenticated users. This is done by ticking Shared:

Image Removed

Customizing Dashboard

The content of a dashboard can be fully customized.

Changing Layout

To change the layout of a dashboard (e.g. three columns instead of two), click on Configure widgets and then pick a layout on the right hand side:

Image Removed

Adding a Widget

To add a widget, click on Configure widgets. The list of available widgets is shown at the top of the page. Click on Add widget to add the desired widget:

Image Removed

Customizing a Widget

Some widgets can be customized. To change their properties, click on Edit on the desired widget:

Image Removed

Moving a Widget

To move a widget within a dashboard, click on Configure widgets, then drag & drop the widget:

Image Removed

Removing a Widget

To remove a widget, click on Configure widgets and then click on Delete:

Image Removed

Managing Dashboards

Click on Manage dashboards to manage available dashboards:

Image Removed

From there you can:

  1. Follow / Unfollow a shared dashboard
  2. Change the order of the dashboards in the left navigation bar
  3. Delete a dashboard
  4. Configure widgets

Managing Default Dashboards

A system administrator can customize the list and the content of the default dashboards. The default dashboards are the ones presented to unauthenticated users as well as authenticated users that have not done any customization. This is done by logging in, going to Settings > Configuration > Default dashboards and then selecting default dashboards to display and their order,

Image Removed

...

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.

Dashboard: Default Project Dashboard Shipped with SonarQubeTM

This default dashboard The Default Dashboard gives an overview of your project (with widgets like Size, etc.) and its quality (with widgets like Rules compliance, Comments & Issues and Technical Debt, Duplications, etc.).

From The metrics in each widget click through to some sort of drilldown.  From there, you will be able to to hunt for seven different kinds of quality flowthe Developers' Seven Deadly Sins:

Duplications

Image RemovedImage Added

See See Duplications for  for detailed explanation on this quality flowflaw.

Bad

distribution

Distribution of

complexity

Complexity

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

Spaghetti

design

Design

See See Spaghetti Design for detailed explanation on this quality flowflaw.

Lack of

unit tests

Unit Tests

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

No coding standards

Coding Standards and Potential

bugs

Bugs

Image RemovedImage Added

See No Coding Standards Breach for detailed explanation on this quality flowflaw.

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

Not

enough or too many commentsImage Removed

Enough or Too Many Comments

Image Added

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

 

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

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

Many other widgets are available out of the box, just just give them a try. Even more are available through 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  it is possible to add manual events. See Events for more details.
  • Automated: a  a mechanism exists to pick automatically events and record them. This is the case for changes in quality profile and raises of alertsa quality gate status change.

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 Resource 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 issue are not displayed.

The Issues drilldown is compatible with the differential views mechanism.

By clicking on a file, you will access the Resource 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 Resource 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 SonarQubeTM instance can be displayed at will.

Global Dashboard Shipped with SonarQubeTM: Home

Image Removed