각 프로젝트가 고유하게 가지고 있는 key 값으로 다음의 문자열을 사용할 수 있습니다:

• 숫자, 문자, '-' , '_' 및 '.'. 1자리 이상의 숫자가 포함되어야 합니다.

Maven을 사용하는 경우 key값은 자동으로 다음으로 설정됩니다: <groupId>:<artifactId>

콤마(',')로 구분된 디렉토리 명칭을 입력할 수 있습니다.

Maven과 호환되나 그렇지 않은 경우 소스코드는 기본 Maven 코드 저장 위치에서 추출합니다.

SonarQube 웹 인터페이스에 표시되는 프로젝트 이름. Maven 프로젝트인 경우 <name> 속성으로 설정합니다.

• 속성을 명시하지 않은 경우 project key를 사용합니다
• 동일한 이름이 데이터베이스에 존재하는 경우, 덮어쓰지 않습니다

프로젝트 버전. Maven 프로젝트인 경우 <version> 속성으로 설정합니다.

프로젝트 설명
<description> 속성을 사용하는 Maven 프로젝트와 호환되지 않습니다

sonar.links.ci

개발자 컨텍션 링크

<scm><developerConnection> 속성을 사용하는 Maven 프로젝트와 호환되지 않습니다.

콤마(',')로 구분된 테스트 케이스 파일의 경로

Java Maven 프로젝트의 기본 경로 정보를 사용하는 Maven 프로젝트와 호환되지 않습니다.

sonar.language

분석 대상 소스 코드 언어 설정

지원 가능한 프로그래밍 언어 리스트는 Plugin Library 페이지(영문)을 참조합니다. 별도로 설정하지 않을 경우 multi-language 분석을 수행합니다.

sonar.sourceEncoding

소스 코드 파일 인코딩 설정

• 예: UTF-8, MacRoman, Shift_JIS.

이 속성은 Maven 프로젝트의 project.build.sourceEncoding 속성으로 대체할 수 있습니다. 사용 가능한 인코딩은 JVM에 따라 상이합니다. 더 많은 정보는 http://docs.oracle.com/javase/1.5.0/docs/guide/intl/encoding.doc.html (column : Canonical Name for java.nio API)를 참조합니다(영문).

시스템 설정 인코딩

sonar.projectDate

분석 날짜 지정

Note: 이 속성은 특정한 유스케이스에서 활용할 수 있습니다:

• 신규 프로젝트 분석 시, 해당 프로젝트의 코드 품질에 대한 히스토리 정보를 생성하고자 하는 경우
• 데이터베이스 엔진 변경 시, 새로운 데이터베이스 스키마에서 데이터베이스 생성을 권장하나 이로 인해과거 프로젝트들에 대한 모든 정보를 유실할 수 있으며, 필요에 따라 새로운 SonarQube 데이터베이스에 필요한 히스토리 정보를 주입해야 하는 경우

위와 같은 유스 케이스에서 사용하고자 하는 경우 sonar.projectDate 속성을 활용할 수 있습니다. 해당 속성의 형식은 yyyy-mm-dd입니다(예: 2017-01-01).

프로세스는 아래와 같습니다:

• 히스토리 이력을 생성하고자 하는 어플리케이션 소스의 가장 오래된 버전을 체크아웃합니다(특정 플래그 등).
• SonarQube 분석을 해당 프로젝트에서 실행합니다. sonar.projectDate 속성을 설정합니다. 예: sonar-scaner -Dsonar.projectDate=2010-12-01
• 어플리케이션 소스의 다음 버전을 체크아웃 한 뒤 sonar.projectDate 속성을 업데이트하고 분석을 수행합니다. 원하는 모든 버전의 소스 코드에 대해 동일한 작업을 반복합니다.

Note:

현재 날짜

 sonar.branch

SCM 브랜치를 관리합니다.

 SonarQube는 동일한 프로젝트의 두 브랜치를 다른 프로젝트로 취급하지 않기 때문에, Project A의 B1 브랜치에서 발견된 이슈는 Project A의 B2 브랜치의 이슈와 연결되지 않습니다. 현재 B1 브랜치에서 해결된 이슈를 B2 브랜치에서도 자동으로 해결되었다고 판단할 수 없게 됩니다.

Developer Cockpit 플러그인 사용자인 경우, Developer Cockpit Installation and Usage (영문)의 "Limitation" 섹션을 참조합니다.

sonar.profile

해당 언어의 기본 프로파일

sonar.projectBaseDir

분석을 시작한 디렉토리가 아닌 다른 디렉토리에서 분석을 해야할 경우--즉, 분석은 jenkins/jobs/myjob/workplace에서 시작했으니 ftpdrop/cobol/project의 코드를 분석해야 하는 경우 등--에 이 속성을 사용합니다. 경로는 절대 경로 혹은 상대 경로를 모두 사용할 수 있습니다.

소스 디렉토리가 아닌 소스 디렉토리의 부모 디렉토리를 지정합니다. 이 속성에 지정한 디렉토리는 새로운 "분석 디렉토리(analysis directory)"로 간주되며, 모든 다른 경로는 sonar.projectBaseDir를 기준으로 설정됩니다.

분석 프로세스를 진행하기 위해서는 이 디렉토리에 쓰기 권한을 가지고 있어야 하며, 이 디렉토리에는 sonar.working.directory가 생성됩니다.

SonarQube Scanner 혹은 SonarQube Ant Task (버전 2.0 이상) 분석 시 사용할 작업 디렉토리를 지정합니다.

경로는 각 프로젝트 별로 상이하며, 고유해야 합니다.

 해당 폴더는 분석 시작 직전 삭제 됩니다.

sonar.scm.provider

이 속성을 사용해 명시적으로 SonarQube가 어떤 SCM 플러그임을 사용해 프로젝트에서 SCM 데이터를 취득해야 할지를 지정할 수 있습니다(auto-detection이 동작하지 않는 경우). 이 속성 값은 항상 소문자로 기록해야 하며 설치한 플러그인에 의존성을 가집니다(예: "tfvc"는 TFVC 플러그인을 의미함). 더 자세한 정보는 각 플러그인의 문서 페이지를 참조합니다.

기본적으로, 변경된 파일에 한해 블레임 정보(blame information)를 취득합니다. 이 속성을 true로 설정해 모든 파일을 대상으로 블레임 정보를 취득할 수 있습니다. SonarQube에 저장된 블레임 정보가 오래된 정보라고 판단한 경우, SCM 엔진에서 최신 정보를 취득하고자 하는 경우 유용합니다.

분석에 포함할 파일 경로 패턴 목록으로, 콤마(,)로 구분합니다. 이 속성을 설정하면 설정된 경로에 해당하는 파일들만을 분석합니다.

커버리지 계산에서 제외할 파일 경로 패턴 목록으로, 콤마(,)로 구분합니다.

문석에 포함할 테스트 파일 경로 패턴 목록으로, 콤마(,)로 구분합니다. 이 속성을 설정하면 설정된 경로에 해당하는 테스트 파일만을 분석합니다.

입력한 정규식에 매칭되는 파일들을 분석에서 제외합니다.

sonar.import_unknown_files

true로 설정하면 해당 언어 플러그인에서 지원하는 파일의 확장자와 관계 없이 모든 파일을 분석 대상에 포함합니다. 단 inclusion, exclusion 설정은 동일하게 적용됩니다.

false

코드 중복 식별에서 제외할 파일 경로 패턴 목록으로, 콤마(,)로 구분합니다.

최소 10 라인(sonar.cpd.${language}.minimumLines 속성으로 변경 가능)의 코드 상에 연속적으로 100개(sonar.cpd.${language}.minimumTokens 속성으로 변경 가능)의 중복된 토큰이 발생하는 경우, 해당 코드는 중복된 코드로 식별합니다.

Java 프로젝트의 경우, 토큰이나 라인에 관계 없이 최소 10개의 구문이 연속적으로 중복되는 경우, 해당 코드는 중복된 코드로 식별합니다.

sonar.log.level

분석 과정에서 생성하는 로그의 품질 / 레벨을 설정합니다.

DEBUG: 
INFO 레벨 로그 및 DEBUG 레벨을 로그를 표시하며, 다음 속성을 설정한 것과 비슷합니다: sonar.verbose=true

TRACE: 
DEBUG 레벨 로그, 모든 ElasticSearch 쿼리 타이밍 로그 및 SonarQube Scanner 서버가 수행하는 Web API 호출 로그를 표시합니다.

INFO

Add more detail to both client and server-side analysis logs.

• Activates DEBUG mode for the scanner. This is a shortcut of sonar.log.level=DEBUG.
• Adds client-side environment variables and system properties to server-side log of analysis report processing. 
  NOTE There is the potential for this setting to expose sensitive information such as passwords if they are stored as server-side environment variables.

Display logs to see where the analyzer spends time.

This parameter is generating a file containing these timing infos in
<workingDir>/profiling/<moduleKey>-profiler.xml where <workingDir> is:

• .sonar/profiling/ when analysis is run with Sonar Scanner

• target/sonar/profiling/ when Maven is used 

This parameter is set to preview as part of PR analysis.