Dashboard

Dashboard Overview

A guided tour of the Technical Debt Radar dashboard. Understand every page, its purpose, and how to use the dashboard for ongoing technical debt governance.

Dashboard Overview

The Technical Debt Radar dashboard is your central view into codebase health across all monitored repositories. It surfaces violations, trends, and risk areas so tech leads and engineering managers can make informed decisions without reading every line of code.

The dashboard sidebar organizes pages into three groups:

Core Pages (available now):

  • Overview
  • Violations
  • Hotspots
  • Trends
  • PR History
  • Runtime Risks
  • Policy Config
  • First Scan Report

Advanced Pages (V1.5+):

  • Visual Policy Editor
  • Architecture Graph
  • Rule Pack Browser

Account Pages:

  • Team Management
  • Billing
  • Settings

Page-by-Page Tour

Overview

The landing page after login. Shows a high-level health snapshot for the selected project.

What you see:

  • Health score gauge --- a circular gauge showing the current project debt score (0--100). Green zone (0--30) means healthy, yellow (31--60) means attention needed, red (61--100) means critical debt accumulation.
  • Violation counters --- four cards showing total violations by severity: Critical, Warning, Info, and Suppressed. Each card is color-coded and shows the delta since last analysis.
  • Category breakdown --- a horizontal bar chart showing violation distribution across the five debt categories (Architecture, Runtime Risk, Performance, Reliability, Maintainability).
  • Recent PRs --- a table of the 10 most recent pull request analyses with columns for PR number, title, debt score, gate result (PASS/FAIL badge), and timestamp.
  • Hotspot modules --- a list of the top 5 modules ranked by complexity multiplied by change frequency. These are the files most likely to introduce bugs.

The overview page refreshes automatically when a new analysis completes.

Violations

A filterable, sortable log of all detected violations across the project.

What you see:

  • Filter bar --- dropdowns for category (Architecture, Runtime Risk, Performance, Reliability, Maintainability), severity (Critical, Warning, Info), module, and file path search.
  • Violation table --- columns for file path, line number, rule ID, category, severity, and a truncated description. Click any row to expand the full violation detail including the offending code snippet and fix instructions.
  • Bulk actions --- suppress or acknowledge violations in bulk. Suppressed violations stop blocking merges but remain visible with a "suppressed" badge.

Hotspots

Complexity-times-churn ranking to identify the riskiest files in the codebase.

What you see:

  • Scatter plot --- X axis is cyclomatic complexity, Y axis is change frequency (commits in the last 90 days). Files in the top-right quadrant are high-complexity, high-churn --- the most dangerous hotspots.
  • Ranked list --- files sorted by hotspot score (complexity multiplied by churn), with sparklines showing the complexity trend over the last 10 analyses.

Three time-series charts that reveal whether the codebase is improving or degrading. See the dedicated Trends page for full documentation.

PR History

A searchable history of every pull request Radar has analyzed. See the dedicated PR History page for full documentation.

Runtime Risks

A focused view of runtime risk and reliability violations, grouped by module.

What you see:

  • Module cards --- each card represents a module with its runtime risk and reliability violation counts. Cards are sorted by total risk score (highest first).
  • Violation list per module --- expanding a card reveals the specific violations: sync I/O in handlers, unbounded JSON parsing, fire-and-forget promises, missing timeouts, and other runtime/reliability patterns.
  • Severity indicators --- critical violations are marked with a red indicator, warnings with yellow. Modules with zero violations show a green checkmark.

Policy Config

A read-only viewer for the project's radar.yml configuration.

What you see:

  • Syntax-highlighted YAML --- the full radar.yml file with line numbers.
  • Parsed summary --- a sidebar showing the detected framework, ORM, architecture preset, module list, and volume declarations extracted from the config.
  • Validation status --- a green checkmark if the config is valid, or a list of validation errors with line numbers.

Tip: To edit the policy, use the Visual Policy Editor (V1.1+) or modify radar.yml directly in your repository.

First Scan Report

The initial analysis results for a newly connected project. See the dedicated First Scan Report page for full documentation.

Visual Policy Editor (V1.1+)

An interactive editor for building and modifying your radar.yml without writing YAML manually. See the dedicated Visual Policy Editor page for full documentation.

Architecture Graph (V1.5+)

An interactive force-directed graph showing module dependencies and architecture violations. See the dedicated Architecture Graph page for full documentation.

Getting the Most Out of the Dashboard

Daily Workflow (Developers)

  1. Check the Overview page after your PR is analyzed
  2. If the gate result is FAIL, click through to the violation details
  3. Use the fix instructions to resolve violations before re-pushing

Weekly Review (Tech Leads)

  1. Review Trends to see if the codebase is improving or regressing
  2. Check Hotspots to identify files that need refactoring attention
  3. Review PR History to spot developers or modules that consistently introduce violations
  4. Use Runtime Risks to prioritize event-loop safety work

Sprint Planning (Engineering Managers)

  1. Use Trends to set debt reduction targets for the sprint
  2. Export the First Scan Report or violation data to discuss with the team
  3. Review the Architecture Graph to understand dependency health before major refactoring

Project Switching

If you have multiple projects connected, use the project selector dropdown in the top-left corner of the dashboard. Each project maintains its own violation history, trends, and configuration.

Data Freshness

Dashboard data updates in real time when a new analysis completes. The overview page shows the timestamp of the last analysis in the top-right corner. If data appears stale, verify that your GitHub App or CI pipeline is triggering analyses on new PRs.

Technical Debt Radar Documentation