Creating dashboards

Creating custom dashboards using various widgets and filters.

This feature is in beta and is available in the Enterprise plan. We are rolling out this feature in phases with a rollout completion date expected by early December. See the Community post for additional details.

There are two ways to create a custom dashboard, by duplicating an existing dashboard or by creating 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.

duplicating a dashboard on All dashboards page
  1. Retrieve your project. See Retrieving projects for more information.

  2. Select the Main Branch from the left side menu.

  3. Click Dashboards from the top menu and select All dashboards.

  4. Click on the action menu next to the existing dashboard and select Duplicate. You can only duplicate custom dashboards.

  5. In the Duplicate dashboard modal enter the dashboard name, description and click Create duplicate. The new dashboard appears on the All dashboards page.

  6. Click on the action menu next to the duplicated dashboard and select Edit to customize it.

Creating a custom dashboard from scratch

Creating a new custom dashboard

To create a custom dashboard from scratch:

  1. Retrieve your project. See Retrieving projects for more information.

  2. Select the Main Branch from the left side menu.

  3. Click Dashboards from the top menu and select either All dashboards.

  4. Click Create custom dashboard button in the top right corner.

  5. In the Create custom dashboard modal enter the dashboard name, description and click Create. The new dashboard appears on the All dashboards page.

  6. Click on the action menu next to the new dashboard and select Edit to customize it.

Once you are in the edit mode you can select the following option at the top of the page:

Dashboards editing options
  • Add widget: Opens a modal where you can configure the widget. See Adding a widget.

  • Add section: Sections group a set of widgets together and are collapsible. See Creating dashboards

  • 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, click Add widget to open a modal. In the Add new widget modal follow these steps:

Configuring a new widget
1

Define your widget

  • Visualization: Choose the visualization that will represent the data. The options are: Count, Rating badge, Line chart, Donut chart, and Pie chart. 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 metrics available for the visualization you have 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.

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: All, Last 3 months, and Last month.

  • Additional filters appear that are relevant to the visualization and metric you selected in the previous step.

3

Customize visualization

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

  • Show trend indicator: Available only to the count visualization.

Once you are done configuring the widget:

  • Click Add to dashboard at the bottom of the modal.

  • Click 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 the edit mode and click Add section to open a modal.

  • Enter the section name and description in the modal.

  • Click Create section to add it to the dashboard.

Options for a section element
  1. Once the section appears on a dashboard, you can move it by clicking the handle located in the upper-left corner and dragging it to another location.

  2. Click Add widget to add a new widget directly from within the section.

  3. Click 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. Click Save changes at the top of the page when you are done.

Metrics

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

Metrics
Visualization
Additional information

Issues

Issue count

Count, line chart, donut chart, pie chart

See Issues

Security

Security remediation effort

Count, line chart

Security hotspots

Count, line chart

Security hotspots reviewed

Count, line chart

Security hotspot count

Donut chart, pie chart

Security rating

Rating badge

Security review rating

Rating badge

Reliability

Reliability remediation effort

Count, line chart

Reliability rating

Rating badge

Maintainability

Effort to reach maintainability rating A

Count, line chart

Technical debt ratio

Count, line chart

Technical dept ratio of new/changed code

Count, line chart

Maintainability rating

Rating badge

Coverage

Conditions to cover

Count, line chart

Coverage by tests

Count, line chart

Line coverage

Count, line chart

Lines to cover

Count, line chart

Uncovered conditions

Count, line chart

Uncovered lines

Count, line chart

Duplications

Duplicated blocks

Count, line chart

Duplicated files

Count, line chart

Duplicated lines

Count, line chart

Duplicated lines density

Count, line chart

Size

Comment lines

Count, line chart

See Size

Comment lines density

Count, line chart

See Size

Lines

Count, line chart

See Size

Line count

Donut chart, pie chart

See Size

Last updated

Was this helpful?