SONAR-8340 document log format in sonar.properties

1 files changed, 34 insertions, 3 deletions

diff --git a/sonar-application/src/main/assembly/conf/sonar.properties b/sonar-application/src/main/assembly/conf/sonar.properties
index 06e5de1f9b0..f73564e85f0 100644
--- a/sonar-application/src/main/assembly/conf/sonar.properties
+++ b/sonar-application/src/main/assembly/conf/sonar.properties
@@ -217,6 +217,37 @@
 #--------------------------------------------------------------------------------------------------
 # LOGGING
 
+# SonarQube produces logs in 4 logs files located in the same directory (see property sonar.path.logs below),
+# one per process:
+#   Main process (aka. App) logs in sonar.log
+#   Web Server (aka. Web) logs in web.log
+#   Compute Engine (aka. CE) logs in ce.log
+#   Elasticsearch (aka. ES) logs in es.log
+#
+# All 4 files have logs in the same format:
+#           1           2    3           4                       5                                                   6
+# |-----------------| |---| |-|--------------------||------------------------------| |------------------------------------------------------------------------------------------------------------------------------|
+# 2016.11.16 16:47:00 INFO  ce[AVht0dNXFcyiYejytc3m][o.s.s.c.t.CeWorkerCallableImpl] Executed task | project=org.sonarqube:example-java-maven | type=REPORT | id=AVht0dNXFcyiYejytc3m | submitter=admin | time=1699ms
+#
+# 1: timestamp. Format is YYYY.MM.DD HH:MM:SS
+#    YYYY: year on 4 digits
+#    MM: month on 2 digits
+#    DD: day on 2 digits
+#    HH: hour of day on 2 digits in 24 hours format
+#    MM: minutes on 2 digits
+#    SS: seconds on 2 digits
+# 2: log level.
+#    Possible values (in order of descending criticality): ERROR, WARN, INFO, DEBUG and TRACE
+# 3: process identifier. Possible values: app (main), web (Web Server), ce (Compute Engine) and es (Elasticsearch)
+# 4: SQ thread identifier. Can be empty.
+#    In the Web Server, if present, it will be the HTTP request ID.
+#    In the Compute Engine, if present, it will be the task ID.
+# 5: logger name. Usually a class canonical name.
+#    Package names are truncated to keep the whole field to 20 characters max
+# 6: log payload. Content of this field does not follow any specific format, can vary in length and include line returns.
+#    Some logs, however, will follow the convention to provide data in payload in the format " | key=value"
+#    Especially, log of profiled pieces of code will end with " | time=XXXXms".
+
 # Global level of logs (applies to App, Web and CE processes).
 # Supported values are INFO (default), DEBUG and TRACE
 #sonar.log.level=INFO
@@ -231,13 +262,13 @@
 
 # Sql logs in the Web and CE processes can be individually controlled with their respective properties
 # Supported values are INFO, DEBUG and TRACE
-# Currently, there is Sql logs only at TRACE level
+# Currently, there are Sql logs only at TRACE level
 #sonar.log.level.web.sql=TRACE
 #sonar.log.level.ce.sql=TRACE
 
-# Es client logs in the Web and CE processes can be individually controlled with their respective properties
+# Elasticsearch client logs in the Web and CE processes can be individually controlled with their respective properties
 # Supported values are INFO, DEBUG and TRACE
-# Currently, there is Es client logs only at TRACE level
+# Currently, there are Es client logs only at TRACE level
 #sonar.log.level.web.es=TRACE
 #sonar.log.level.ce.es=TRACE