SonarQube

This guide covers how to configure and use SonarQube with Software Metrics Machine (SMM).

What is supported

SMM supports SonarQube in three interfaces:

• CLI via the smm sonarqube command group
• REST API under /sonarqube/*
• Dashboard tab: SonarQube

Configuration

Set SMM_STORE_DATA_AT to the folder that contains your smm_config.json file.

export SMM_STORE_DATA_AT=/path/to/data

Example smm_config.json:

{
  "projects": [
    {
      "git_provider": "github",
      "github_repository": "owner/repo",
      "git_repository_location": "/path/to/repository",
      "sonar_url": "https://sonarqube.example.com",
      "sonar_token": "your_sonar_token",
      "sonar_project": "project_key"
    }
  ]
}

CLI commands

Fetch quality measures

smm sonarqube fetch-measures

Common options:

• --metrics: comma-separated metric keys
• --output: text or json

Example:

smm sonarqube fetch-measures --metrics coverage,complexity,sqale_rating --output json

Fetch component tree

smm sonarqube fetch-component-tree

Common options:

• --component: component key (defaults to configured project)
• --depth: depth (-1 for full traversal)
• --metrics: comma-separated metric keys
• --output: text or json

Example:

smm sonarqube fetch-component-tree --depth -1 --metrics complexity,cognitive_complexity,ncloc

Fetch historical measures

smm sonarqube fetch-historical-measures

Common options:

• --metrics: comma-separated metric keys
• --start-date: YYYY-MM-DD
• --end-date: YYYY-MM-DD
• --save: save result JSON to a file
• --output: text or json

Example:

smm sonarqube fetch-historical-measures \
  --metrics sqale_rating,coverage,duplicated_lines_density \
  --start-date 2025-01-01 \
  --end-date 2025-12-31 \
  --save sonarqube-history.json \
  --output json

Run local analysis

Run a local SonarQube server and scanner using Docker:

smm sonarqube analysis run

Options:

• --container-server-name: SonarQube container name (default: sonarqube)
• --scanner-container-name: Scanner container name (default: sonarqube-scanner)
• --container-server-image: SonarQube Docker image (default: sonarqube:community)
• --scanner-image: Scanner Docker image (default: sonarsource/sonar-scanner-cli)
• --data-dir: Host path for SonarQube data (default: ./sonarqube_data)
• --server-port: Host port for SonarQube (default: 9000)
• --scanner-host-url: Override scanner host URL
• --scanner-token: Scanner authentication token
• --properties: Raw scanner options
• --admin-user: SonarQube admin username (default: admin)
• --admin-password: SonarQube admin password (default: admin)

This command starts the SonarQube server (if not already running), executes sonar-scanner against your local repository, and automatically fetches quality measures, component tree, and historical measures once the analysis completes.

REST API

Main endpoints:

• GET /sonarqube/quality
• GET /sonarqube/component-tree

See REST API for details.

Dashboard usage

Open dashboard:

smm dashboard serve

Then open the SonarQube tab and use filters for:

• include patterns
• ignore patterns
• remove folders

SonarQube dashboard filters

Dashboard filter	Backend query parameter
sonarqubeIgnorePatternFiles	ignore_files
sonarqubeIncludePatternFiles	include_files
sonarqubeRemoveFolders	remove_folders=true

Pattern filtering notes

For include and ignore patterns:

• Plain text values perform substring match.
• Glob-like patterns are supported (*, **, ?).
• If the pattern has no /, matching is applied to file name (basename).