轉(zhuǎn)載:為了以后使用
隨著微服務(wù)數(shù)量不斷增長啡省,需要跟蹤一個(gè)請求從一個(gè)微服務(wù)到下一個(gè)微服務(wù)的傳播過程搬味,Spring Cloud Sleuth 正是解決這個(gè)問題方妖,它在日志中引入唯一ID,以保證微服務(wù)調(diào)用之間的一致性伴挚,這樣你就能跟蹤某個(gè)請求是如何從一個(gè)微服務(wù)傳遞到下一個(gè)。
Spring Cloud Sleuth在日志中增加兩種ID 類型调俘, 一個(gè)是trace ID辜窑,另外一個(gè)是span ID,span ID代表工作基本單元吊趾,比如發(fā)送一個(gè)HTTP 請求宛裕;treace ID包含一系列span ID,形成一個(gè)樹狀結(jié)構(gòu)论泛。
首先揩尸,從 start.spring.io創(chuàng)建一個(gè)新的Spring Boot應(yīng)用,依賴于Sleuth(spring-cloud-starter-slueth)屁奏,產(chǎn)生項(xiàng)目并下載代碼岩榆,給你的應(yīng)用取名也有助于Sleuth的跟蹤。
在src/main/resources創(chuàng)建一個(gè)文件稱為bootstrap.yml,在這個(gè)文件里加入屬性spring.application.name為你取的名稱朗恳,名稱將作為SLeuth跟蹤部分的一部分湿颅。
現(xiàn)在加入一些日志到應(yīng)用中,打開你的應(yīng)用文件粥诫,main方法所在的那個(gè)類油航,創(chuàng)建一個(gè)方法為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";
}
}
如果你啟動(dòng)這個(gè)應(yīng)用,瀏覽器訪問http://localhost:8080执赡,你會看到hello world镰踏,現(xiàn)在有了這個(gè)案例,讓我們使用Sleuth加入日志到這個(gè)應(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)你再訪問這個(gè)應(yīng)用時(shí),在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]首懈,這是什么意思绊率?第一個(gè)部分是應(yīng)用名稱,也就是前面你在bootstrap.yml中設(shè)置spring.application.name的值究履,第二個(gè)值是trace ID滤否,第三個(gè)是span ID,最后值顯示span是否應(yīng)該導(dǎo)出到Zipkin最仑。
除了向日志語句添加額外的跟蹤信息外藐俺,Spring Cloud Sleuth在調(diào)用其他微服務(wù)時(shí)還提供了一些重要的好處。 記住泥彤,這里的真正的問題不是在單個(gè)微服務(wù)中識別日志欲芹,而是在多個(gè)微服務(wù)之間跟蹤一個(gè)請求鏈。 微服務(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這個(gè)bean,這對于Sleuth在請求頭部加入trace ID和span ID有作用炕贵,這個(gè)頭部能夠被Sleuth用來跟蹤微服務(wù)之間請求鏈梆奈,通過這個(gè)bean,Sleuth能夠使用依賴注入獲得這個(gè)對象并加入頭部信息称开。
我們也加入新的方法和端點(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是讓你跟蹤一個(gè)跨服務(wù)調(diào)用傳遞的請求,而span ID是不同焰轻,因?yàn)橛袃蓚€(gè)工作單元發(fā)生臭觉,每個(gè)請求各一個(gè)。
如果你打開瀏覽器調(diào)試工具辱志,會看到/callhome的請求頭部蝠筑,在響應(yīng)中看到兩個(gè)頭部有:
X-B3-SpanId: fbf39ca6e571f294 X-B3-TraceId: fbf39ca6e571f294
可見,頭部能夠讓Sleuth跟蹤微服務(wù)之間的請求揩懒。