sonar Analysis Parameters

source: http://docs.codehaus.org/display/SONAR/Analysis+Parameters

Table of Contents

• Mandatory Parameters
• Server
• Database
• Project Configuration
• Optional Parameters
• Project Configuration
• Configuration
• Log

Parameters to configure project analysis can be set in various places. Here is the hierarchy of parameters:

• Global analysis parameters, defined in the UI, will apply to all the projects
• Project analysis parameters, defined in the UI, will override global parameters
• Project analysis parameters, defined in project analysis configuration file or in analyzer configuration file, will override the ones defined in the UI
• Command line parameters, defined when launching an analysis, will override project analysis parameters

Note that only parameters set through the UI are stored in the database.

For example, if you set the sonar.profile parameter via command line for a specific project, it will not be stored in the database. Then, a local analysis in Eclipse will be run against the default quality profile.

Mandatory Parameters

Server

Key

Description

Default value

sonar.host.urlServer URLhttp://localhost:9000

Database

Key

Description

Default value

sonar.jdbc.url

JDBC Connection URL

jdbc:h2:tcp://localhost:9092/sonar

sonar.jdbc.username

User for the JDBC Connection

sonar

sonar.jdbc.password

Password for the JDBC Connection

sonar

Project Configuration

Key

Description

Default value

sonar.projectKey

The project key that is unique for each project.
Set through <groupId>:<artifactId> when using Maven.

 sonar.projectName

Name of the project that will be displayed on the web interface.
Set through <name> when using Maven.

 sonar.projectVersion

The project version.

Set through <version> when using Maven.

 

sonar.language

Set the language of source code. If a plugin allows to analyze another language, the associated source code analyser can be activated with this property.

java

sonar.sources

Comma-separated paths to directories containing sources.
Not compatible with Maven: source code retrieved from default location for Java Maven projects. 

 

Optional Parameters

Project Configuration

Key

Description

Default value

sonar.projectDescription

Description of the project.
Set through <description> when using Maven. 

 sonar.binaries

Comma-separated paths to directories containing binaries (in case of Java: directories with class files).
Not compatible with Maven: binaries retrieved from default location for Java Maven projects. 

 sonar.tests

Comma-separated paths to directories containing tests.
Not compatible with Maven: tests retrieved from default location for Java Maven projects.  

 sonar.libraries

Comma-separated paths to files with third-party libraries (in case of Java: JAR files). Pattern can be used.

Example:

sonar.libraries=path/to/specific/library/myLibrary.jar,path/to/library/*.jar

Note that * wildcard character is not supported for directories (only for files).

This property is used by rule engines during issues detection (mainly SonarQube engine and FindBugs engines which rely on bytecode). Having the bytecode of these libraries allows to get more information on coupling, possible null parameters when calling external APIs, etc. and thus getting more accuracy during issues detection.

 

sonar.sourceEncoding

Encoding of source files. Example of values: UTF-8, MacRoman, Shift_JIS. This property can be replaced by the standard propertyproject.build.sourceEncoding in Maven projects.

The list of available encodings depends on your JVM. See http://docs.oracle.com/javase/1.5.0/docs/guide/intl/encoding.doc.html.

System encoding

sonar.importSources

Sometimes, for security or other reasons, project sources must not be stored and displayed.

true

sonar.projectDate

When starting to analyze a new project, you may want to feed your SonarQube instance with the quality snapshots of the last versions of this project. In order to get some information on quality trend over the last versions.

When moving from one database engine to another, it is highly recommended (even mandatory) to start from a fresh new database schema. In this case, you will lose your whole history. So, you may also want to feed the new SonarQube instance with some historical data.

To answer those use cases, you can use the sonar.projectDate property. Format is yyyy-MM-dd, for example: 2010-12-01.

The process is the following:

• Retrieve a specific version of the source code of your application from the SCM (from a specific tag, whatever)
• Run a SonarQube analysis on this project by setting the sonar.projectDate property. Example: sonar-runner -Dsonar.projectDate=2010-12-01

• Retrieve another version of the source code of your application from the SCM and run another analysis by properly setting the sonar.projectDate property. And so on for all the versions of your application you're interested in.

Note: first analyze the latest version and then move in chronological order to the newest one.

 

Current date

sonar.exclusions

Exclude files from analysis. See Project Administration#ExcludingFiles for more details. This page also details sonar.tests.exclusions, sonar.inclusions,sonar.tests.inclusions, sonar.global.exclusions, sonar.global.tests.exclusions.

 

sonar.skippedModules

Some project modules should not be analyzed and consolidated with global project measures, for instance samples, integration tests or generated code.
If a module's artifactId differs from its module name (the directory name): it is the artifactId that should be use instead of the module name. Format is a comma-separated list of modules: module1_to_exclude,module2_to_exclude.

 

sonar.includedModules

Comma-separated list of the modules to analyse, all other modules are automatically ignored. Be careful: the root project must be added to the list. 
If a module's artifactId differs from its module name (the directory name): it is the artifactId that should be use instead of the module name.

 

sonar.branch

Manage SCM branches. Two branches of the same project are considered as different projects in SonarQube.

 

sonar.profile

Through the web interface, you can define as many quality profiles as you want and you can easily associate one of these quality profiles to a given project.

Default profile for the given language

sonar.skipDesign

To skip the computation of design metrics and dependencies.

Currently only available for Java.

false

sonar.phase

When SonarQube needs a Maven phase or goal to be executed prior to the analysis, this parameter can be used. For example sonar.phase=generate-sources. This property is used only for Maven analysis.

 

sonar.dynamicAnalysis

Dynamic analysis relates to unit tests. By default, those unit tests are executed but you can optionally decide to do only static analysis or to reuse existing reports which have been previously generated. Possible values are true, false, reuseReports.

See the Code Coverage by Unit Tests tutorial for details and examples.

true

sonar.working.directory

To set the working directory for the SonarQube Runner or the SonarQube Ant Task (versions greater than 2.0).

Beware: the specified folder is deleted before running each analysis.

.sonar

Configuration

Key

Description

Default value

sonar.host.connectTimeoutMs sonar.host.readTimeoutMs

Increasing HTTP timeouts of requests to server. The Maven plugin executes some HTTP requests to the server. Two timeouts makes the call fails if the server connection is too slow. In such a case the timeouts can be increased from Maven properties.

Respectively 30,000 and 60,000 milliseconds

Log

KeyDescriptionDefault valuesonar.showProfilingDisplay logs to know where time is spentfalsesonar.showSqlDisplay all the SQL requests executed on batch sidefalsesonar.showSqlResultsDisplay the result of all SQL requests executed on batch sidefalsesonar.verboseActivation of the DEBUG mode on batch sidefalse