From cb7f2bc1a3c302e7b9490678cfd1b5eae4513c25 Mon Sep 17 00:00:00 2001 From: buildmaster Date: Thu, 9 Apr 2020 13:31:01 +0000 Subject: [PATCH] Sync docs from master to gh-pages --- reference/html/README.html | 17 +++--- reference/html/features.html | 17 +++--- reference/html/index.html | 17 +++--- reference/html/logback-spring.xml | 72 +++++++++++++++++++++++++ reference/html/spring-cloud-sleuth.html | 17 +++--- reference/htmlsingle/logback-spring.xml | 72 +++++++++++++++++++++++++ 6 files changed, 168 insertions(+), 44 deletions(-) create mode 100644 reference/html/logback-spring.xml create mode 100644 reference/htmlsingle/logback-spring.xml diff --git a/reference/html/README.html b/reference/html/README.html index 4d2af2f77..f4989c733 100644 --- a/reference/html/README.html +++ b/reference/html/README.html @@ -429,17 +429,16 @@ To do so, you have to do the following (for readability, we pass the dependencie

Logback Setup

-

Consider the following example of a Logback configuration file (named logback-spring.xml).

+

Consider the following example of a Logback configuration file (named logback-spring.xml).

<?xml version="1.0" encoding="UTF-8"?>
 <configuration>
     <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
-    ​
     <springProperty scope="context" name="springAppName" source="spring.application.name"/>
     <!-- Example for logging into the build folder of your project -->
-    <property name="LOG_FILE" value="${BUILD_FOLDER:-build}/${springAppName}"/>​
+    <property name="LOG_FILE" value="${BUILD_FOLDER:-build}/${springAppName}"/>
 
     <!-- You can override this to have a custom pattern -->
     <property name="CONSOLE_LOG_PATTERN"
@@ -457,7 +456,7 @@ To do so, you have to do the following (for readability, we pass the dependencie
         </encoder>
     </appender>
 
-    <!-- Appender to log to file -->​
+    <!-- Appender to log to file -->
     <appender name="flatfile" class="ch.qos.logback.core.rolling.RollingFileAppender">
         <file>${LOG_FILE}</file>
         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
@@ -469,7 +468,6 @@ To do so, you have to do the following (for readability, we pass the dependencie
             <charset>utf8</charset>
         </encoder>
     </appender>
-    ​
     <!-- Appender to log to file in a JSON format -->
     <appender name="logstash" class="ch.qos.logback.core.rolling.RollingFileAppender">
         <file>${LOG_FILE}.json</file>
@@ -485,13 +483,11 @@ To do so, you have to do the following (for readability, we pass the dependencie
                 <pattern>
                     <pattern>
                         {
+                        "timestamp": "@timestamp",
                         "severity": "%level",
                         "service": "${springAppName:-}",
-                        "trace": "%X{X-B3-TraceId:-}",
-                        "span": "%X{X-B3-SpanId:-}",
-                        "parent": "%X{X-B3-ParentSpanId:-}",
-                        "exportable": "%X{X-Span-Export:-}",
-                        "baggage": "%X{key:-}",
+                        "trace": "%X{traceId:-}",
+                        "span": "%X{spanId:-}",
                         "pid": "${PID:-}",
                         "thread": "%thread",
                         "class": "%logger{40}",
@@ -502,7 +498,6 @@ To do so, you have to do the following (for readability, we pass the dependencie
             </providers>
         </encoder>
     </appender>
-    ​
     <root level="INFO">
         <appender-ref ref="console"/>
         <!-- uncomment this to have also JSON logs -->
diff --git a/reference/html/features.html b/reference/html/features.html
index 935789523..226d9d63b 100644
--- a/reference/html/features.html
+++ b/reference/html/features.html
@@ -283,17 +283,16 @@ To do so, you have to do the following (for readability, we pass the dependencie
 
Logback Setup
-

Consider the following example of a Logback configuration file (named logback-spring.xml).

+

Consider the following example of a Logback configuration file (named logback-spring.xml).

<?xml version="1.0" encoding="UTF-8"?>
 <configuration>
     <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
-    ​
     <springProperty scope="context" name="springAppName" source="spring.application.name"/>
     <!-- Example for logging into the build folder of your project -->
-    <property name="LOG_FILE" value="${BUILD_FOLDER:-build}/${springAppName}"/>​
+    <property name="LOG_FILE" value="${BUILD_FOLDER:-build}/${springAppName}"/>
 
     <!-- You can override this to have a custom pattern -->
     <property name="CONSOLE_LOG_PATTERN"
@@ -311,7 +310,7 @@ To do so, you have to do the following (for readability, we pass the dependencie
         </encoder>
     </appender>
 
-    <!-- Appender to log to file -->​
+    <!-- Appender to log to file -->
     <appender name="flatfile" class="ch.qos.logback.core.rolling.RollingFileAppender">
         <file>${LOG_FILE}</file>
         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
@@ -323,7 +322,6 @@ To do so, you have to do the following (for readability, we pass the dependencie
             <charset>utf8</charset>
         </encoder>
     </appender>
-    ​
     <!-- Appender to log to file in a JSON format -->
     <appender name="logstash" class="ch.qos.logback.core.rolling.RollingFileAppender">
         <file>${LOG_FILE}.json</file>
@@ -339,13 +337,11 @@ To do so, you have to do the following (for readability, we pass the dependencie
                 <pattern>
                     <pattern>
                         {
+                        "timestamp": "@timestamp",
                         "severity": "%level",
                         "service": "${springAppName:-}",
-                        "trace": "%X{X-B3-TraceId:-}",
-                        "span": "%X{X-B3-SpanId:-}",
-                        "parent": "%X{X-B3-ParentSpanId:-}",
-                        "exportable": "%X{X-Span-Export:-}",
-                        "baggage": "%X{key:-}",
+                        "trace": "%X{traceId:-}",
+                        "span": "%X{spanId:-}",
                         "pid": "${PID:-}",
                         "thread": "%thread",
                         "class": "%logger{40}",
@@ -356,7 +352,6 @@ To do so, you have to do the following (for readability, we pass the dependencie
             </providers>
         </encoder>
     </appender>
-    ​
     <root level="INFO">
         <appender-ref ref="console"/>
         <!-- uncomment this to have also JSON logs -->
diff --git a/reference/html/index.html b/reference/html/index.html
index 7733a48c5..f7eb370d9 100644
--- a/reference/html/index.html
+++ b/reference/html/index.html
@@ -395,17 +395,16 @@ To do so, you have to do the following (for readability, we pass the dependencie
 
Logback Setup
-

Consider the following example of a Logback configuration file (named logback-spring.xml).

+

Consider the following example of a Logback configuration file (named logback-spring.xml).

<?xml version="1.0" encoding="UTF-8"?>
 <configuration>
     <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
-    ​
     <springProperty scope="context" name="springAppName" source="spring.application.name"/>
     <!-- Example for logging into the build folder of your project -->
-    <property name="LOG_FILE" value="${BUILD_FOLDER:-build}/${springAppName}"/>​
+    <property name="LOG_FILE" value="${BUILD_FOLDER:-build}/${springAppName}"/>
 
     <!-- You can override this to have a custom pattern -->
     <property name="CONSOLE_LOG_PATTERN"
@@ -423,7 +422,7 @@ To do so, you have to do the following (for readability, we pass the dependencie
         </encoder>
     </appender>
 
-    <!-- Appender to log to file -->​
+    <!-- Appender to log to file -->
     <appender name="flatfile" class="ch.qos.logback.core.rolling.RollingFileAppender">
         <file>${LOG_FILE}</file>
         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
@@ -435,7 +434,6 @@ To do so, you have to do the following (for readability, we pass the dependencie
             <charset>utf8</charset>
         </encoder>
     </appender>
-    ​
     <!-- Appender to log to file in a JSON format -->
     <appender name="logstash" class="ch.qos.logback.core.rolling.RollingFileAppender">
         <file>${LOG_FILE}.json</file>
@@ -451,13 +449,11 @@ To do so, you have to do the following (for readability, we pass the dependencie
                 <pattern>
                     <pattern>
                         {
+                        "timestamp": "@timestamp",
                         "severity": "%level",
                         "service": "${springAppName:-}",
-                        "trace": "%X{X-B3-TraceId:-}",
-                        "span": "%X{X-B3-SpanId:-}",
-                        "parent": "%X{X-B3-ParentSpanId:-}",
-                        "exportable": "%X{X-Span-Export:-}",
-                        "baggage": "%X{key:-}",
+                        "trace": "%X{traceId:-}",
+                        "span": "%X{spanId:-}",
                         "pid": "${PID:-}",
                         "thread": "%thread",
                         "class": "%logger{40}",
@@ -468,7 +464,6 @@ To do so, you have to do the following (for readability, we pass the dependencie
             </providers>
         </encoder>
     </appender>
-    ​
     <root level="INFO">
         <appender-ref ref="console"/>
         <!-- uncomment this to have also JSON logs -->
diff --git a/reference/html/logback-spring.xml b/reference/html/logback-spring.xml
new file mode 100644
index 000000000..fb02a5e8b
--- /dev/null
+++ b/reference/html/logback-spring.xml
@@ -0,0 +1,72 @@
+
+
+	
+	
+	
+	
+
+	
+	
+
+	
+	
+		
+			
+			DEBUG
+		
+		
+			${CONSOLE_LOG_PATTERN}
+			utf8
+		
+	
+
+	
+	
+		${LOG_FILE}
+		
+			${LOG_FILE}.%d{yyyy-MM-dd}.gz
+			7
+		
+		
+			${CONSOLE_LOG_PATTERN}
+			utf8
+		
+	
+	
+	
+		${LOG_FILE}.json
+		
+			${LOG_FILE}.json.%d{yyyy-MM-dd}.gz
+			7
+		
+		
+			
+				
+					UTC
+				
+				
+					
+						{
+						"timestamp": "@timestamp",
+						"severity": "%level",
+						"service": "${springAppName:-}",
+						"trace": "%X{traceId:-}",
+						"span": "%X{spanId:-}",
+						"pid": "${PID:-}",
+						"thread": "%thread",
+						"class": "%logger{40}",
+						"rest": "%message"
+						}
+					
+				
+			
+		
+	
+	
+		
+		
+		
+		
+	
+
diff --git a/reference/html/spring-cloud-sleuth.html b/reference/html/spring-cloud-sleuth.html
index 7733a48c5..f7eb370d9 100644
--- a/reference/html/spring-cloud-sleuth.html
+++ b/reference/html/spring-cloud-sleuth.html
@@ -395,17 +395,16 @@ To do so, you have to do the following (for readability, we pass the dependencie
 
Logback Setup
-

Consider the following example of a Logback configuration file (named logback-spring.xml).

+

Consider the following example of a Logback configuration file (named logback-spring.xml).

<?xml version="1.0" encoding="UTF-8"?>
 <configuration>
     <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
-    ​
     <springProperty scope="context" name="springAppName" source="spring.application.name"/>
     <!-- Example for logging into the build folder of your project -->
-    <property name="LOG_FILE" value="${BUILD_FOLDER:-build}/${springAppName}"/>​
+    <property name="LOG_FILE" value="${BUILD_FOLDER:-build}/${springAppName}"/>
 
     <!-- You can override this to have a custom pattern -->
     <property name="CONSOLE_LOG_PATTERN"
@@ -423,7 +422,7 @@ To do so, you have to do the following (for readability, we pass the dependencie
         </encoder>
     </appender>
 
-    <!-- Appender to log to file -->​
+    <!-- Appender to log to file -->
     <appender name="flatfile" class="ch.qos.logback.core.rolling.RollingFileAppender">
         <file>${LOG_FILE}</file>
         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
@@ -435,7 +434,6 @@ To do so, you have to do the following (for readability, we pass the dependencie
             <charset>utf8</charset>
         </encoder>
     </appender>
-    ​
     <!-- Appender to log to file in a JSON format -->
     <appender name="logstash" class="ch.qos.logback.core.rolling.RollingFileAppender">
         <file>${LOG_FILE}.json</file>
@@ -451,13 +449,11 @@ To do so, you have to do the following (for readability, we pass the dependencie
                 <pattern>
                     <pattern>
                         {
+                        "timestamp": "@timestamp",
                         "severity": "%level",
                         "service": "${springAppName:-}",
-                        "trace": "%X{X-B3-TraceId:-}",
-                        "span": "%X{X-B3-SpanId:-}",
-                        "parent": "%X{X-B3-ParentSpanId:-}",
-                        "exportable": "%X{X-Span-Export:-}",
-                        "baggage": "%X{key:-}",
+                        "trace": "%X{traceId:-}",
+                        "span": "%X{spanId:-}",
                         "pid": "${PID:-}",
                         "thread": "%thread",
                         "class": "%logger{40}",
@@ -468,7 +464,6 @@ To do so, you have to do the following (for readability, we pass the dependencie
             </providers>
         </encoder>
     </appender>
-    ​
     <root level="INFO">
         <appender-ref ref="console"/>
         <!-- uncomment this to have also JSON logs -->
diff --git a/reference/htmlsingle/logback-spring.xml b/reference/htmlsingle/logback-spring.xml
new file mode 100644
index 000000000..fb02a5e8b
--- /dev/null
+++ b/reference/htmlsingle/logback-spring.xml
@@ -0,0 +1,72 @@
+
+
+	
+	
+	
+	
+
+	
+	
+
+	
+	
+		
+			
+			DEBUG
+		
+		
+			${CONSOLE_LOG_PATTERN}
+			utf8
+		
+	
+
+	
+	
+		${LOG_FILE}
+		
+			${LOG_FILE}.%d{yyyy-MM-dd}.gz
+			7
+		
+		
+			${CONSOLE_LOG_PATTERN}
+			utf8
+		
+	
+	
+	
+		${LOG_FILE}.json
+		
+			${LOG_FILE}.json.%d{yyyy-MM-dd}.gz
+			7
+		
+		
+			
+				
+					UTC
+				
+				
+					
+						{
+						"timestamp": "@timestamp",
+						"severity": "%level",
+						"service": "${springAppName:-}",
+						"trace": "%X{traceId:-}",
+						"span": "%X{spanId:-}",
+						"pid": "${PID:-}",
+						"thread": "%thread",
+						"class": "%logger{40}",
+						"rest": "%message"
+						}
+					
+				
+			
+		
+	
+	
+		
+		
+		
+		
+	
+