Creating dashboards

Creating custom dashboards using various widgets and filters.

This feature is available in the Enterprise plan.

There are two ways to create a custom dashboard: duplicate an existing dashboard or create one from scratch.

Duplicating an existing dashboard

You can duplicate an existing dashboard and use it as a starting point. Sometimes, this is the fastest way to get started.

1. Retrieve your portfolio. See Retrieving a portfolio for more information.
2. Go to Dashboards > All dashboards. The All dashboards page opens and lists all available dashboards.
3. In the action menu next to the existing dashboard, select Duplicate. You can duplicate both custom and built-in dashboards.
4. In the Duplicate dashboard modal, enter the dashboard name and description, then select Create duplicate. The new dashboard appears on the All dashboards page.
5. In the action menu next to the duplicated dashboard, select Edit dashboard to customize it.

Creating a custom dashboard from scratch

To create a custom dashboard from scratch:

1. Retrieve your portfolio. See Retrieving a portfolio for more information.
2. Go to Dashboards > All dashboards.
3. Select Create custom dashboard in the top-right corner.
4. In the Create custom dashboard modal, enter the dashboard name and description, then select Create. The new dashboard appears on the All dashboards page.
5. In the action menu next to the new dashboard, select Edit dashboard to customize it.

In edit mode, you can use the following options at the top of the page:

• Add widget: Opens a modal where you can configure the widget. See Adding a widget for details.
• Add section: Sections group a set of widgets together and are collapsible. See Adding a section for details.
• Cancel and exit: Exits the edit mode without saving the changes.
• Save changes: Saves the current changes.

Adding a widget

In the dashboard’s edit mode, select Add widget to open a modal. In the Add new widget modal, follow these steps:

Step 1: Define your widget

• Visualization: Choose the visualization that represents the data. The options are Count, Badge, Line chart, Donut chart, Pie chart, and Top list. See Viewing dashboards for more information about the chart options.
• Metric: Choose the metric you want to visualize. The metric drop-down list is filtered by the metrics available for the visualization you selected. See Metrics for a list of available metrics and associated visualizations.
• Slice by: This option appears only for pie and donut charts. Available options depend on the metric you have chosen.

Step 2: Apply filters

Depending on the metric you have selected in the previous step, appropriate filters are displayed. Feel free to explore the filters and combine them with various metrics to find the desired results.

• Scope: For the count, rating badge, pie, and donut chart visualizations, you can choose between Overall code or New code. For the line chart, Overall code is the only option and is applied by default.
• Time range: This option appears only for the line chart because it is a time-based chart. The options are Last 12 months, Last 6 months, Last 3 months, and Last month.
• Additional filters appear that are relevant to the visualization and metric you selected in the previous step.

Step 3: Customize visualization

• Show legend: Select this option to display a legend for a visualization. This applies to line, donut, and pie charts.
• Show trend indicator: Available only for the count visualization.

Once you are done configuring the widget:

• Select Add to dashboard at the bottom of the modal.
• Select Save changes at the top of the dashboard page, if you are done editing.

Adding a section

Sections help you organize and group your widgets on a dashboard.

To create a section:

• Enter edit mode and select Add section to open a modal.
• Enter the section name and description in the modal.
• Select Create section to add it to the dashboard.

1. Once the section appears on the dashboard, you can move it by clicking the handle in the upper-left corner and dragging it to another location.
2. Select Add widget to add a new widget directly from within the section.
3. Select the action menu located in the upper right corner of the section to edit or delete the section.
4. Collapse or Expand the section to change its visibility. This feature works even after you save the changes and exit edit mode.
5. Select Save changes at the top of the page when you are done.

Historical data availability

Portfolio dashboard line charts display historical data recorded for the portfolio over time. When you create a new portfolio dashboard, historical data may not be available immediately for older periods, even if the projects in the portfolio were analyzed before the dashboard or portfolio configuration was created. In these cases, the dashboard begins showing history from the time portfolio-level data starts being recorded.

As a result, newly created portfolio dashboards can initially appear with limited or no historical line chart data. More data becomes available as new analyses are processed for the projects included in the portfolio.

Metrics

The following table shows a list of metrics and associated visualizations.

Metrics	Visualization	Additional information
Issues
Issue count	Count, line and multi-line chart, donut chart, pie chart, top list	Shows the number of issues in all states. See Issues
Issue density	Count, line chart	Shows the number of issues per 1000 lines of code. See Issues
Closed issues	Count, line chart	Shows the number of issues that no longer appear in a later analysis. See Issues
Mean time to resolve (MTTR) issues	Count, line chart	Shows the average time between an issue being detected and resolved. See Issues
Mean time to resolve (MTTR) newly detected issues	Count, line chart	Shows the average time between an issue being detected and resolved, within 30 days. See Issues
Security
Security remediation effort	Count, line chart	Shows the effort to fix all vulnerabilities. See Security
Security hotspots	Count, line chart	Shows the number of security hotspots. See Security review
Security hotspots reviewed	Count, line chart	Shows the percentage of security hotspots that have been reviewed. See Security review
Security hotspot count	Donut chart, pie chart	Shows the number of security hotspots. See Security review
Security rating	Badge	Rating related to security. See Security
Security review rating	Badge	Rating based on the percentage of reviewed security hotspots. See Security review
Reliability
Reliability remediation effort	Count, line chart	Shows the effort to fix all reliability issues. See Reliability
Reliability rating	Badge	Rating related to reliability. See Reliability
Maintainability
Effort to reach maintainability rating A	Count, line chart	Shows the effort required to reach maintainability rating A. See Maintainability
Technical debt ratio	Count, line chart	Shows the ratio between the cost to develop the software and the cost to fix it. See Maintainability
Technical debt ratio of new/changed code	Count, line chart	Shows the technical debt ratio for new code. See Maintainability
Maintainability rating	Badge	Rating related to the value of the technical debt ratio. See Maintainability
Coverage
Conditions to cover	Count, line chart	Shows the number of conditions that could be covered by unit tests. See Coverage
Coverage by tests	Count, line chart	Shows a mix of line coverage and condition coverage. See Coverage
Line coverage	Count, line chart	Shows the percentage of lines covered by unit tests. See Coverage
Lines to cover	Count, line chart	Shows the number of lines of code that could be covered by unit tests. See Coverage
Uncovered conditions	Count, line chart	Shows the number of conditions that are not covered by unit tests. See Coverage
Uncovered lines	Count, line chart	Shows the number of lines of code that are not covered by unit tests. See Coverage
Duplications
Duplicated blocks	Count, line chart	Shows the number of duplicated blocks of lines. See Duplications
Duplicated files	Count, line chart	Shows the number of files involved in duplications. See Duplications
Duplicated lines	Count, line chart	Shows the number of lines involved in duplications. See Duplications
Duplicated lines density	Count, line chart	Shows the percentage of duplicated lines. See Duplications
Size
Comment lines	Count, line chart	Shows the number of lines containing either a comment or commented-out code. See Size
Comment lines density	Count, line chart	Shows the percentage of comment lines. See Size
Lines	Count, line chart	Shows the number of physical lines. See Size
Line count	Donut chart, pie chart	Shows the number of physical lines. See Size
Dependency risks
Dependency risks	Count, line chart	Shows the total number of dependency risks found in your project or portfolio. See Advanced security (SCA)
Dependency security risks	Count, line chart	Shows total dependency risks that affect security, such as vulnerable or malicious packages. See Advanced security (SCA)
Vulnerable dependency risks	Count, line chart	Shows total third-party packages with a publicly reported vulnerability. See Advanced security (SCA)
Malicious package dependency risks	Count, line chart	Shows total third-party packages known to be malicious. See Advanced security (SCA)
Prohibited license dependency risks	Count, line chart	Shows total packages whose license is not allowed by your organization’s license policy. See Advanced security (SCA)
Dependency risk rating	Badge	Rating related to dependency risks. See Advanced security (SCA)
Mean time to resolve (MTTR) for dependency risks	Count, line chart	Shows the average time to resolve dependency risks in the last 30 days. It includes risks that are fixed or marked safe during that period. See Advanced security (SCA)

Dashboards include metrics related to dependency risks. To view dependency risks, you need access to SonarQube Advanced Security. See Subscribing to the Advanced Security product for signup instructions.

Portfolio specific metrics

Metrics	Visualization	Additional information
Releasability rating	Count, badge	Rating based on the proportion of projects in the portfolio that have passed their quality gate. See Releasability
Project count	Count, line chart, donut chart, pie chart	The number of projects in a portfolio.

See Portfolio metrics for additional information.

Related pages

• Portfolio dashboards

• Viewing and managing dashboards