From a3f48112ca4a456899696d0a56ab92f4c9e87afd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Johnny=20Miller=20=28=E9=94=BA=E4=BF=8A=29?=
 <johnnysviva@outlook.com>
Date: Sun, 27 Feb 2022 11:22:58 +0800
Subject: [PATCH] feat($Sleuth): record trance ID and span ID in logs

Log pattern be like: [${APPLICATION},%X{traceId},%X{spanId}]

BREAKING CHANGE: support trace ID and span ID in logs
---
 .../logback-configuration/logback-base.xml         | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/spring-cloud-starter/src/main/resources/logback-configuration/logback-base.xml b/spring-cloud-starter/src/main/resources/logback-configuration/logback-base.xml
index 1f80779c..95a3be2c 100644
--- a/spring-cloud-starter/src/main/resources/logback-configuration/logback-base.xml
+++ b/spring-cloud-starter/src/main/resources/logback-configuration/logback-base.xml
@@ -1,7 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- The complete logback manual documents the latest version of logback framework at https://logback.qos.ch/manual/ -->
+<!-- https://docs.spring.io/spring-cloud-sleuth/docs/current/reference/html/project-features.html#features-log-integration-json-logback -->
 <included>
     <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
+    <springProperty scope="context" name="APPLICATION" source="spring.application.name"/>
     <jmxConfigurator/>
 
     <!-- Converter Class Configuration -->
@@ -10,11 +12,17 @@
                     converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/>
 
     <!-- Log Render Configuration -->
-    <springProperty scope="context" name="APPLICATION" source="spring.application.name"/>
+    <!--
+    Spring Cloud Sleuth adds two types of IDs to your logging, one called a trace ID and the other called a span ID.
+    The span ID represents a basic unit of work, for example sending an HTTP request. The trace ID contains a set of span IDs,
+    forming a tree-like structure. The trace ID will remain the same as one microservice calls the next.
+
+    https://dzone.com/articles/tracing-in-microservices-with-spring-cloud-sleuth#:~:text=Spring%20Cloud%20Sleuth%20adds%20two,forming%20a%20tree%2Dlike%20structure.
+    -->
     <property name="CONSOLE_LOG_PATTERN"
-              value="%d{yyyy-MM-dd HH:mm:ss.SSS} %clr(%5p) %clr(${PID:- }){magenta} - [%15.15t] %-48.48logger{48} : %msg%n%wEx"/>
+              value="%d{yyyy-MM-dd HH:mm:ss.SSS} %clr(%5p) %clr([${APPLICATION},%X{traceId},%X{spanId}]){yellow} %clr(${PID:- }){magenta} - [%15.15t] %-48.48logger{48} : %msg%n%wEx"/>
     <property name="FILE_LOG_PATTERN"
-              value="%d{yyyy-MM-dd HH:mm:ss.SSS} %5p ${PID:- } - [%t] %-48.48logger{48} : %msg%n%wEx"/>
+              value="%d{yyyy-MM-dd HH:mm:ss.SSS} %5p [${APPLICATION},%X{traceId},%X{spanId}] ${PID:- } - [%t] %-48.48logger{48} : %msg%n%wEx"/>
     <!-- Log home is nothing related with Spring profiles or environments -->
     <property name="LOG_HOME" value="logs"/>