Code Health Dashboard

The Code Health dashboard is your central hub for monitoring the quality, maintainability, and security of your code. This dashboard is populated by the SonarQube integration and provides a high-level overview of your engineering standards.

The Code Health dashboard is composed of three main sections:

• Metric Widgets: A series of top-level widgets that show the current snapshot of your most important code quality metrics.
• Trends Graph: An interactive line chart that plots your code health metrics over time, allowing you to track progress and spot regressions.
• Filters: A filter panel that lets you scope the entire dashboard view to specific projects.

Key metrics

The dashboard displays several key metrics from SonarQube.

How to use the Dashboard

This dashboard is interactive, allowing you to analyze data in different ways.

Analyze Metric Trends

The Trends graph shows the historical data for your metrics. You can toggle which metric is displayed on the graph.

1. Locate the Trends graph at the bottom of the dashboard.
2. Click on a metric name (e.g., Open Bugs, Line Coverage, Open Code Smells) in the legend above the graph.
3. The graph will update to display the historical trend for that specific metric. This helps you see if your code quality is improving or declining over time.

Filter the Dashboard by project

You can focus the entire dashboard on one or more specific repositories.

1. Click the Filter icon in the top-right corner of the dashboard.
2. A Filters sidebar will open.
3. Under the Project section, check the boxes for the repositories you want to view.

The dashboard will automatically reload, and all widgets and trends will reflect data only for the selected projects.

Set Alerts on Metrics

You can configure alerts to be notified when a metric crosses a specific threshold.

1. Find the metric widget you want to set an alert.
2. Click the three-dot menu (…) in the top-right corner of the widget.
3. Select Set alert.
4. In the Set up alert dialog, configure your alert:
   • Alert name: A descriptive name (e.g., New Vulnerabilities Found).
   • Applicable to: Choose All teams or Selected teams.
   • Alert condition: Set the threshold (e.g., When in a month, Open Vulnerabilities is more than 0).
   • Send email to: Select the users or groups to notify.
5. Click Save.

Add Code Health widgets to other Dashboards

You can use any Code Health metric as a widget on your Home dashboard or on any custom dashboard.

Add to the Home Dashboard

1. Navigate to your Home dashboard from the left sidebar.
2. Find an empty widget slot or click the three-dot menu (…) on an existing widget you want to replace.
3. Select Replace metric.
4. In the Replace metric dialog modal, scroll to the Code Health metrics category.
5. Select the metric you want to add (e.g., Line Coverage).

The widget will be added to your Home dashboard.

Add to a Custom Dashboard

1. Navigate to Dashboards and open the custom dashboard you want to edit.
2. Click Add Widget.
3. In the Add widget dialog, select the Code Health category from the left menu.
4. Click on the widget you want to add.
5. Configure the widget details.
6. Click Done.