Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 64 Next »

Table of Contents

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

Overview

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

Creating Dashboard

Logged users can create as many dashboards as they need.

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

The newly created dashboard will appear immediately in the left navigation bar and and can be customised by adding widgets.

When administrators create a dashboard, they have the ability to share it. This means that this dashboard can be followed by authenticated users and can also be used as a default dashboard. This is done by ticking Shared:

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:

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:

Moving a Widget

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


Removing a Widget

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

Managing Dashboards

Click on Manage dashboards to manage available dashboards:

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

An administrator can customise 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, go to Configuration > Default dashboards and then select default dashboards to display and their order,

 

Project Dashboards

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

Dashboard: Default Project Dashboard Shipped with Sonar

This default dashboard gives an overview of your projects (with widgets like Size, etc.) and its quality (with widgets like Violations, Comments & Duplications, etc.).

From there, you will able to hunt for the 7 quality flows below:

  • Duplications
  • Bad distribution of complexity
  • Spaghetti design
  • Lack of unit tests
  • No coding standards
  • Potential bugs
  • Not enough or too many comments

Duplications

See Duplications for detailed explanation on this quality flow.

Bad distribution of complexity

Spaghetti design

Lack of unit tests

No coding standards and Potential bugs

Not enough or too many comments

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

All the widget 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.

Other Project Dashboards Shipped with Sonar

Measures Drilldown

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



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

Components are sorted in a descending way, worst measure for the metric first.

An optimisation mechanism is in place whereby Sonar does not display components with best value for the metric.

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

Violations Drilldown

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

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 violations first.

An optimisation mechanism is in place whereby Sonar does not display components with no violations.

The Violations drilldown is compatible with the differential views mechanism.

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

 

 

To determine the creation date of a violation, during each Sonar analysis, Sonar executes the following algorithm :

  • For each violation, if there was a violation on the same rule, with the same line number and with the same hash (but not necessarily with the same message) -> MATCH
  • For each violation, if there was a violation on the same rule, with the same message and with the same hash (but not necessarily with the same line) -> MATCH
  • For each violation, if there was a violation on the same rule, with the same message and with the same line number (but not necessarily with the same hash) -> MATCH

In any other case, the violation is a new one.

Global Dashboards

Overview

Global dashboards are available at instance level and can be accessed through the menu on the left.

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

Global Dashboards Shipped with Sonar

By default, Sonar is shipped with three global dashboards:

My favourites

This dashboard includes one filter that lists all the resources that have been flagged as favourite by the logged user. See this tutorial to know how to flag a resource as favourite:

Projects

This dashboard includes one filter that lists all the projects of the Sonar instance:

Treemap

This dashboard includes one filter that displays all the projects of the Sonar instance as a Treemap (size = number of lines, color = rules compliance):

  • No labels