Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
iconfalse
titleTable of Contents

Table of Contents
maxLevel2

SonarQube Platform Overview

Image Added

The SonarQube platform is made of 3 components:

  1. One Databaseto store:
    • the configuration of the SonarQube instance (security, plugins settings, etc.)
    • the quality snapshots of projects, views, etc.
  2. One Web Server for users to browse quality snapshots and configure the SonarQube instance
  3. One or more Clients Analyzers to analyze projects

Notes:

  • The SonarQube platform cannot have more than one a single web server and one a single database.
  • For optimal performance, each each component (Database, Web Server, ClientsAnalyzers) should be installed on a dedicated machine. However However, the the Server and the Database can be installed on the same machine.
  • Clients Analyzers will scale by adding machines.
  • The Database and the Clients must Analyzers must be located in the same network.
  • The Database and the Clients must Analyzers should not be installed on the same machine.
  • All the machines must be time synchronized.

Anchor
installingDatabase
installingDatabase
Installing the Database

Several database engines are supported.

To give it a quick try, you can use the H2 database that is shipped with SonarQube. It doesn't require any installation. Note that H2 must NOT be used to set up a production instance.

To use the database engine of your choice, just create Create an empty schema and a sonarqube user. Grant this sonarqube user permissions to create, update and delete objects for this schema. The charset of the database has to be set to "UTF-8" and the language (database and user) to "English". Here is a sample script for MySQL.

...

Microsoft SQL Server

Note that collation must be case-sensitive (CS) and accent-sensitive (AS).

MySQL

There are two well-known engines that can be used in MySQL: MyISAM and InnoDB. MyISAM is the oldest of the two engines and is being progressively replaced by InnoDB. InnoDB is clearly faster and scales better with SonarQube

...

as the number of projects under quality control increases. If you

...

were an early adopter of SonarQube, you probably have a series of table that are still using MyISAM. To improve performances, you should change the engine for all tables to InnoDB.

Once all SonarQube tables are using the InnoDB engine, the first thing to do is allocate a maximum amount of RAM to your MySQL instance with the innodb_buffer_pool_size parameter and give at least 15Mb to the query_cache_size parameter. Read this article about InnoDB Performance Optimization Basics

...

for more information.

Oracle

When having two SonarQube schemas on the same Oracle instance, especially if they are of two different versions, SonarQube gets confused and picks the first it finds. To fix this issue:

  • Either privileges associated to the SonarQube Oracle users should be decreased
  • Or a trigger should be defined on Oracle side to automatically alter the SonarQube Oracle user session when establishing a new connection:

    Code Block
    languagetext
    ALTER SESSION SET current_schema="MY_SONARQUBE_SCHEMA"

PostgreSQL

If you want to use a custom schema and not the default "public" one, the PostgreSQL search_path property must be set:

Code Block
languagetext
ALTER USER mySonarUser SET search_path to mySonarQubeSchema

Anchor
installingWebServer
installingWebServer
Installing the Web Server

First, check the requirements.

Then download and unzip the distribution (do not unzip into a directory starting with a digit). Note that native packages are also available for Linux distributions.

<install_directory> (below) refers to the path to the directory where the SonarQube distribution has been unzipped.

Setting the access to the Database

If you're not using the embedded H2 database, you need to edit SONARQUBE_HOMEEdit <install_directory>/conf/sonar.properties to configure the database settings. Templates are available for every supported database. Just uncomment and configure the template you need and comment out the lines dedicated to H2:

Code Block
titleExample for PostgreSQL
languagenone
sonar.jdbc.username:  =sonarqube
sonar.jdbc.password:  =mypassword
sonar.jdbc.url:       =jdbc:postgresql://localhost/sonarqube

Adding the JDBC Driver

Drivers for the supported databases (except Oracle) are already provided. Do not replace the provided drivers; they are the only ones supported.

For Oracle, copy the JDBC driver into the SONARQUBE<install_HOMEdirectory>/extensions/jdbc-driver/oracle directory.

Starting the Web Server

By default, SonarQube starts an embedded Jetty web server. The default port is "9000" and the context path is "/". Parameters These values can be changed in the SONARQUBE<install_HOMEdirectory>/conf/sonar.properties file:

Code Block
titlesonar.properties
languagenone
sonar.web.host: =192.0.0.1
sonar.web.port: =80
sonar.web.context: =/sonar


Execute the following script to start the server:

...

You can now browse SonarQube at at http:\\//localhost:9000 (default System administrator credentials are admin/admin).

Tuning the Web Server

By default, SonarQube is configured to run on any computer with a simple Java JRE. The

For better performance, the first thing to do when installing a production instance is to use a Java JDK and activate the server mode by uncommenting/setting the following line in SONARQUBE<install_HOMEdirectory>/conf/wrappersonar.confproperties:

Code Block
languagenone
wrappersonar.javaweb.additional.3javaOpts=-server

To change the Java JVM used by SonarQube, simply edit SONARQUBE<install_HOMEdirectory>/conf/wrapper.conf and update the following line:

Code Block
languagenone
wrapper.java.command=/path/to/my/jdk/bin/java

Advanced Installation Features

Anchor
InstallingClient
InstallingClient
Installing the

...

Analyzers

Multiple analysis clients are analyzers are available:

  • SonarQube Runner: recommended for all non-Maven projects
  • Maven: recommended for all projects built with Maven
  • SonarQube Ant Task: to integrate with projects built with Ant
  • Gradle: to integrate with projects built with Gradle
  • CI Engine: see Jenkins plugin or Hudson plugin or Bamboo or Bamboo plugin or AnthillPro plugin. Note that other CI engines can be used even if there is no SonarQube plugin available.

We do not recommend to use an antivirus on the machine where a SonarQube analysis runs, it could generate unpredictable behavior.

FAQ

Failed to launch the SonarQube service on Windows platform with a LocalSystem account

This error happens when the temporary file path specified for the Local System doesn't exist. Assuming that environment variables have their default settings and that Windows is installed on the C drive, the following paths should exist:

  • Windows Server 2003, Windows XP: C:\Windows\system32\config\systemprofile\Local Settings\Temp
  • Windows Server 2008, Windows 7, Windows Vista: C:\Windows\system32\config\systemprofile\AppData\Local\Temp

In most cases, the Temp folder is missing and should be created. See SONAR-2660.

Cannot connect to MySQL database

By default, remote access to MySQL database server is disabled for security reasons. If you want to remotely access the database server from the Sonar Maven plugin, you need to follow this quick guide.

Failed to start on Windows Vista

SonarQube seems unable to start when installed under the Program Files directory on Windows Vista. It should therefore not be installed there.

Failed to start SonarQube with Oracle due to bad USERS table structure

When another(s) USERS table exists in the Oracle DB, if the sonarqube user has read access on this other USERS table, the SonarQube web server can't start and an exception like the following one is thrown:

Code Block
ActiveRecord::ActiveRecordError: ORA-00904: "TOTO": invalid identifier
: INSERT INTO users (login, name, email, crypted_password, salt, 
created_at, updated_at, remember_token, remember_token_expires_at, toto, id)
VALUES('admin', 'Administrator', '', 'bba4c8a0f808f9798cf8b1c153a4bb4f9178cf59', '2519754f77ea67e5d7211cd1414698f465aacebb',
TIMESTAMP'2011-06-24 22:09:14', TIMESTAMP'2011-06-24 22:09:14', null, null, null, ?)
ActiveRecord::ActiveRecordError: ORA-00904: "TOTO": invalid identifier

: INSERT INTO users (login, name, email, crypted_password, salt, 
created_at, updated_at, remember_token, remember_token_expires_at, toto, id)
VALUES('admin', 'Administrator', '', 'bba4c8a0f808f9798cf8b1c153a4bb4f9178cf59', 
'2519754f77ea67e5d7211cd1414698f465aacebb', TIMESTAMP'2011-06-24 22:09:14', TIMESTAMP'2011-06-24 22:09:14', null, null, null, ?)

See SONAR-2549.
To fix this issue, the rights of the sonarqube Oracle user must be decreased to remove read access on the other(s) USERS table(s).

Failed to connect to the Update Center via proxy

Double check that settings for proxy in file SONARQUBE_HOME/conf/sonar.properties are correctly set.
Note that if your username contains "\" (backslash), then it should be escaped - for example username "domain\user" in file should look like:

Code Block
http.proxyUser=domain\\user

For some proxies, exception "java.net.ProtocolException: Server redirected too many times" might mean incorrect username or password.