轉(zhuǎn)載:為了以后使用
隨著微服務(wù)數(shù)量不斷增長,需要跟蹤一個請求從一個微服務(wù)到下一個微服務(wù)的傳播過程,Spring Cloud Sleuth 正是解決這個問題,它在日志中引入唯一ID,以保證微服務(wù)調(diào)用之間的一致性,這樣你就能跟蹤某個請求是如何從一個微服務(wù)傳遞到下一個。
Spring Cloud Sleuth在日志中增加兩種ID 類型, 一個是trace ID,另外一個是span ID,span ID代表工作基本單元,比如發(fā)送一個HTTP 請求;treace ID包含一系列span ID,形成一個樹狀結(jié)構(gòu)。
首先,從 start.spring.io創(chuàng)建一個新的Spring Boot應(yīng)用,依賴于Sleuth(spring-cloud-starter-slueth),產(chǎn)生項(xiàng)目并下載代碼,給你的應(yīng)用取名也有助于Sleuth的跟蹤。
在src/main/resources創(chuàng)建一個文件稱為bootstrap.yml,在這個文件里加入屬性spring.application.name為你取的名稱,名稱將作為SLeuth跟蹤部分的一部分。
現(xiàn)在加入一些日志到應(yīng)用中,打開你的應(yīng)用文件,main方法所在的那個類,創(chuàng)建一個方法為home,返回String:
public String home() {
return "Hello World";
}
讓我們使用該方法作為你的web應(yīng)用的直接調(diào)用,增加@RestController在類級別,增加@RequestMapping("/")到home方法:
@SpringBootApplication
@RestController
public class SleuthSampleApplication {
public static void main(String[] args) {
SpringApplication.run(SleuthSampleApplication.class, args);
}
@RequestMapping("/")
public String home() {
LOG.log(Level.INFO, "you called home");
return "Hello World";
}
}
如果你啟動這個應(yīng)用,瀏覽器訪問http://localhost:8080,你會看到hello world,現(xiàn)在有了這個案例,讓我們使用Sleuth加入日志到這個應(yīng)用:
在應(yīng)用類增加下面日志變量:
private static final Logger LOG = Logger.getLogger(SleuthSampleApplication.class.getName());
注意這里的類名需要是所在類的名稱,在home方法,增加下面日志語句:
@RequestMapping("/")
public String home() {
LOG.log(Level.INFO, "you called home");
return "Hello World";
}
當(dāng)你再訪問這個應(yīng)用時,在console后臺會看到日志輸出:
2016-06-15 16:55:56.334 INFO [slueth-sample,44462edc42f2ae73,44462edc42f2ae73,false] 13978 --- [nio-8080-exec-1] com.example.SleuthSampleApplication : calling home
Sleuth加入的是[slueth-sample,44462edc42f2ae73,44462edc42f2ae73,false],這是什么意思?第一個部分是應(yīng)用名稱,也就是前面你在bootstrap.yml中設(shè)置spring.application.name的值,第二個值是trace ID,第三個是span ID,最后值顯示span是否應(yīng)該導(dǎo)出到Zipkin。
除了向日志語句添加額外的跟蹤信息外,Spring Cloud Sleuth在調(diào)用其他微服務(wù)時還提供了一些重要的好處。 記住,這里的真正的問題不是在單個微服務(wù)中識別日志,而是在多個微服務(wù)之間跟蹤一個請求鏈。 微服務(wù)通常使用REST API與異步地通過消息中心互相交互。 Sleuth可以在任一情況下提供跟蹤信息,但在本示例中,下面我們將了解REST API調(diào)用的工作原理。
讓我們使用RestTemplate了解應(yīng)用調(diào)用是如何工作的。修改我們的應(yīng)用類:
private static final Logger LOG = Logger.getLogger(SleuthSampleApplication.class.getName());
@Autowired private RestTemplate restTemplate;
public static void main(String[] args) {
SpringApplication.run(SleuthSampleApplication.class, args);
}
@Bean public RestTemplate getRestTemplate() {
return new RestTemplate();
}
@RequestMapping("/") public String home() {
LOG.log(Level.INFO, "you called home");
return "Hello World";
}
@RequestMapping("/callhome") public String callHome() {
LOG.log(Level.INFO, "calling home");
return restTemplate.getForObject("http://localhost:8080", String.class);
}
我們增加了新的RestTemplate這個bean,這對于Sleuth在請求頭部加入trace ID和span ID有作用,這個頭部能夠被Sleuth用來跟蹤微服務(wù)之間請求鏈,通過這個bean,Sleuth能夠使用依賴注入獲得這個對象并加入頭部信息。
我們也加入新的方法和端點(diǎn),稱為callhome,如果你訪問http://localhost:8080/callhome,你會看到日志輸出如下:
2016-06-17 16:12:36.902 INFO [slueth-sample,432943172b958030,432943172b958030,false] 12157 --- [nio-8080-exec-2] com.example.SleuthSampleApplication : calling home 2016-06-17 16:12:36.940 INFO [slueth-sample,432943172b958030,b4d88156bc6a49ec,false] 12157 --- [nio-8080-exec-3] com.example.SleuthSampleApplication : you called home
上面日志trace ID是相同,但是span ID不同,trace ID是讓你跟蹤一個跨服務(wù)調(diào)用傳遞的請求,而span ID是不同,因?yàn)橛袃蓚€工作單元發(fā)生,每個請求各一個。
如果你打開瀏覽器調(diào)試工具,會看到/callhome的請求頭部,在響應(yīng)中看到兩個頭部有:
X-B3-SpanId: fbf39ca6e571f294 X-B3-TraceId: fbf39ca6e571f294
可見,頭部能夠讓Sleuth跟蹤微服務(wù)之間的請求。