|Table of Contents|
Sonar dashboards provide a way to display any kind of data through widgets.
There are two types of dashboard:
- Global dashboard: provides display of any kind of data at Sonar instance level (available since Sonar 3.1).
- Project dashboard: provides display of any kind of data at project level.
As the dashboards are customizable at instance level (and not at project level), in this documentation page, administrator means any user who is in the sonar-administrators group.
The project dashboard is the entry point when looking at a project. It presents an overview of project measures. This service is made of boxes called Widgets:
By default, Sonar ships with a pre-configured dashboard. Since Sonar 2.4 it is possible to add your own dashboards. You must first log in. Three configurations are then available at top right of dashboards :
Select Manage dashboards and you will get a form to create the new dashboard :
The newly created dashboard will appear immediately in the left navigation bar and and can be customised by adding widgets.
Press Manage dashboards to manage available dashboards :
From there you can :
- Change the order of dashboards in the left navigation bar
- Delete a dashboard
- Follow / Unfollow a shared dashboard
An administrator can customise the list and the content of default dashboards. Default dashboards are the ones presented to unauthenticated users as well as authenticated users that have not do any customisation. This is done by logging in, go to Configuration -> Default dashboards and then select default dashboards to display and their order
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 :
The content of the default dashboard can only be configured by an administrator.
To change the layout of a dashboard (e.g. three columns instead of two), you need to press Edit layout and then pick a layout :
To add a widget you need to select Configure widgets. The list of available widgets is shown at the top of the page. Pressing Add widget will add the desired widget :
To move a widget within a dashboard, you need to have selected Configure widgets. You can then drag & drop the widget.
To remove a widget you need to select Configure widgets and then press Delete :
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:
This dashboard includes one filter that lists all the projects of the Sonar instance:
This dashboard includes one filter that displays all the projects of the Sonar instance as a Treemap (size = number of lines, color = rules compliance):