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 105 Next »

Table of Contents

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

  • Global dashboards display data at instance level
  • Project dashboards display data at project level.

Project Dashboards

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

The Dashboard default dashboard gives an overview of your project (with widgets like Size, etc.) and its quality (with widgets like Rules compliance, Duplications, etc.).

From there, you will be able to hunt for the Developers' Seven Deadly Sins:

Duplications

See Duplications for detailed explanation on this quality flaw.

Bad distribution of complexity

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

Spaghetti design

See Spaghetti Design for detailed explanation on this quality flaw.

Lack of unit tests

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

No coding standards and Potential bugs

See No Coding Standards for detailed explanation on this quality flaw.

See Potential Bugs for detailed explanation on this quality flaw.

Not enough or too many comments

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.

Treemap

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:



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:

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.

Clouds

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

On the Top risk tab, the size represents the average complexity 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.

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

  • No labels