概述
一個(gè)完整的微服務(wù)系統(tǒng)包含多個(gè)微服務(wù)單元,各個(gè)微服務(wù)子系統(tǒng)存在互相調(diào)用的情況限匣,形成一個(gè) 調(diào)用鏈。一個(gè)客戶端請(qǐng)求從發(fā)出到被響應(yīng) 經(jīng)歷了哪些組件哮奇、哪些微服務(wù)膛腐、請(qǐng)求總時(shí)長(zhǎng)、每個(gè)組件所花時(shí)長(zhǎng) 等信息我們有必要了解和收集鼎俘,以幫助我們定位性能瓶頸哲身、進(jìn)行性能調(diào)優(yōu),因此監(jiān)控整個(gè)微服務(wù)架構(gòu)的調(diào)用鏈?zhǔn)钟斜匾撤ィ疚膶㈥U述如何使用 Zipkin 搭建微服務(wù)調(diào)用鏈追蹤中心勘天。
注: 本文原載于 My Personal Blog:, CodeSheep · 程序羊 捉邢!
Zipkin初摸
正如 Ziplin官網(wǎng) 所描述脯丝,Zipkin是一款分布式的追蹤系統(tǒng),其可以幫助我們收集微服務(wù)架構(gòu)中用于解決延時(shí)問題的時(shí)序數(shù)據(jù)伏伐,更直白地講就是可以幫我們追蹤調(diào)用的軌跡宠进。
Zipkin的設(shè)計(jì)架構(gòu)如下圖所示:
要理解這張圖,需要了解一下Zipkin的幾個(gè)核心概念:
- Reporter
在某個(gè)應(yīng)用中安插的用于發(fā)送數(shù)據(jù)給Zipkin的組件稱為Report藐翎,目的就是用于追蹤數(shù)據(jù)收集
- Span
微服務(wù)中調(diào)用一個(gè)組件時(shí)材蹬,從發(fā)出請(qǐng)求開始到被響應(yīng)的過(guò)程會(huì)持續(xù)一段時(shí)間,將這段跨度稱為Span
- Trace
從Client發(fā)出請(qǐng)求到完成請(qǐng)求處理吝镣,中間會(huì)經(jīng)歷一個(gè)調(diào)用鏈堤器,將這一個(gè)整個(gè)過(guò)程稱為一個(gè)追蹤(Trace)。一個(gè)Trace可能包含多個(gè)Span末贾,反之每個(gè)Span都有一個(gè)上級(jí)的Trace闸溃。
- Transport
一種數(shù)據(jù)傳輸?shù)姆绞剑热缱詈?jiǎn)單的HTTP方式拱撵,當(dāng)然在高并發(fā)時(shí)可以換成Kafka等消息隊(duì)列
看了一下基本概念后辉川,再結(jié)合上面的架構(gòu)圖,可以試著理解一下拴测,只有裝配有Report組件的Client才能通過(guò)Transport來(lái)向Zipkin發(fā)送追蹤數(shù)據(jù)员串。追蹤數(shù)據(jù)由Collector收集器進(jìn)行手機(jī)然后持久化到Storage之中。最后需要數(shù)據(jù)的一方昼扛,可以通過(guò)UI界面調(diào)用API接口,從而最終取到Storage中的數(shù)據(jù)〕常可見整體流程不復(fù)雜渺鹦。
Zipkin官網(wǎng)給出了各種常見語(yǔ)言支持的OpenZipkin libraries:
本文接下來(lái)將 構(gòu)造微服務(wù)追蹤的實(shí)驗(yàn)場(chǎng)景 并使用 Brave 來(lái)輔助完成微服務(wù)調(diào)用鏈追蹤中心搭建!
部署Zipkin服務(wù)
利用Docker來(lái)部署Zipkin服務(wù)再簡(jiǎn)單不過(guò)了:
docker run -d -p 9411:9411 \
--name zipkin \
docker.io/openzipkin/zipkin
完成之后瀏覽器打開:localhost:9411
可以看到Zipkin的可視化界面:
模擬微服務(wù)調(diào)用鏈
我們來(lái)構(gòu)造一個(gè)如下圖所示的調(diào)用鏈:
圖中包含 一個(gè)客戶端 + 三個(gè)微服務(wù):
Client:使用/servicea接口消費(fèi)ServiceA提供的服務(wù)
ServiceA:使用/serviceb接口消費(fèi)ServiceB提供的服務(wù)蛹含,端口8881
ServiceB:使用/servicec接口消費(fèi)ServiceC提供的服務(wù)毅厚,端口8882
ServiceC:提供終極服務(wù),端口8883
為了模擬明顯的延時(shí)效果浦箱,準(zhǔn)備在每個(gè)接口的響應(yīng)中用代碼加入3s的延時(shí)吸耿。
簡(jiǎn)單起見,我們用SpringBt來(lái)實(shí)現(xiàn)三個(gè)微服務(wù)酷窥。
ServiceA的控制器代碼如下:
@RestController
public class ServiceAContorller {
@Autowired
private RestTemplate restTemplate;
@GetMapping("/servicea”)
public String servicea() {
try {
Thread.sleep( 3000 );
} catch (InterruptedException e) {
e.printStackTrace();
}
return restTemplate.getForObject("http://localhost:8882/serviceb", String.class);
}
}
ServiceB的代碼如下:
@RestController
public class ServiceBContorller {
@Autowired
private RestTemplate restTemplate;
@GetMapping("/serviceb”)
public String serviceb() {
try {
Thread.sleep( 3000 );
} catch (InterruptedException e) {
e.printStackTrace();
}
return restTemplate.getForObject("http://localhost:8883/servicec", String.class);
}
}
ServiceC的代碼如下:
@RestController
public class ServiceCContorller {
@Autowired
private RestTemplate restTemplate;
@GetMapping("/servicec”)
public String servicec() {
try {
Thread.sleep( 3000 );
} catch (InterruptedException e) {
e.printStackTrace();
}
return "Now, we reach the terminal call: servicec !”;
}
}
我們將三個(gè)微服務(wù)都啟動(dòng)起來(lái)咽安,然后瀏覽器中輸入localhost:8881/servicea
來(lái)發(fā)出請(qǐng)求,過(guò)了9s之后蓬推,將取到ServiceC中提供的微服務(wù)接口所返回的內(nèi)容妆棒,如下圖所示:
很明顯,調(diào)用鏈可以正常work了沸伏!
那么接下來(lái)我們就要引入Zipkin來(lái)追蹤這個(gè)調(diào)用鏈的信息糕珊!
編寫與Zipkin通信的工具組件
從Zipkin官網(wǎng)我們可以知道,借助OpenZipkin庫(kù)Brave毅糟,我們可以開發(fā)一個(gè)封裝Brave的公共組件红选,讓其能十分方便地嵌入到ServiceA,ServiceB姆另,ServiceC服務(wù)之中喇肋,完成與Zipkin的通信。
為此我們需要建立一個(gè)新的基于Maven的Java項(xiàng)目:ZipkinTool
- pom.xml中加入如下依賴:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.hansonwang99</groupId>
<artifactId>ZipkinTool</artifactId>
<version>1.0-SNAPSHOT</version>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<source>6</source>
<target>6</target>
</configuration>
</plugin>
</plugins>
</build>
<packaging>jar</packaging>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot</artifactId>
<version>2.0.1.RELEASE</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>4.3.7.RELEASE</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-spring-web-servlet-interceptor</artifactId>
<version>4.0.6</version>
</dependency>
<dependency>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-spring-resttemplate-interceptors</artifactId>
<version>4.0.6</version>
</dependency>
<dependency>
<groupId>io.zipkin.reporter</groupId>
<artifactId>zipkin-sender-okhttp3</artifactId>
<version>0.6.12</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>RELEASE</version>
<scope>compile</scope>
</dependency>
</dependencies>
</project>
- 編寫ZipkinProperties類
其包含endpoint和service兩個(gè)屬性蜕青,我們最后是需要將該兩個(gè)參數(shù)提供給ServiceA苟蹈、ServiceB、ServiceC微服務(wù)作為其application.properties中的Zipkin配置
@Data
@Component
@ConfigurationProperties("zipkin")
public class ZipkinProperties {
private String endpoint;
private String service;
}
用了lombok之后右核,這個(gè)類異常簡(jiǎn)單慧脱!
【注意:關(guān)于lombok的用法,可以看這里】
- 編寫ZipkinConfiguration類
這個(gè)類很重要贺喝,在里面我們將Brave的BraveClientHttpRequestInterceptor攔截器注冊(cè)到RestTemplate的攔截器調(diào)用鏈中來(lái)收集請(qǐng)求數(shù)據(jù)到Zipkin中菱鸥;同時(shí)還將Brave的ServletHandlerInterceptor攔截器注冊(cè)到調(diào)用鏈中來(lái)收集響應(yīng)數(shù)據(jù)到Zipkin中
上代碼吧:
@Configuration
@Import({RestTemplate.class, BraveClientHttpRequestInterceptor.class, ServletHandlerInterceptor.class})
public class ZipkinConfiguration extends WebMvcConfigurerAdapter {
@Autowired
private ZipkinProperties zipkinProperties;
@Autowired
private RestTemplate restTemplate;
@Autowired
private BraveClientHttpRequestInterceptor clientInterceptor;
@Autowired
private ServletHandlerInterceptor serverInterceptor;
@Bean
public Sender sender() {
return OkHttpSender.create( zipkinProperties.getEndpoint() );
}
@Bean
public Reporter<Span> reporter() {
return AsyncReporter.builder(sender()).build();
}
@Bean
public Brave brave() {
return new Brave.Builder(zipkinProperties.getService()).reporter(reporter()).build();
}
@Bean
public SpanNameProvider spanNameProvider() {
return new SpanNameProvider() {
@Override
public String spanName(HttpRequest httpRequest) {
return String.format(
"%s %s",
httpRequest.getHttpMethod(),
httpRequest.getUri().getPath()
);
}
};
}
@PostConstruct
public void init() {
List<ClientHttpRequestInterceptor> interceptors = restTemplate.getInterceptors();
interceptors.add(clientInterceptor);
restTemplate.setInterceptors(interceptors);
}
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(serverInterceptor);
}
}
ZipkinTool完成以后,我們需要在ServiceA躏鱼、ServiceB氮采、ServiceC三個(gè)SpringBt項(xiàng)目的application.properties中加入Zipkin的配置:
以ServiceA為例:
server.port=8881
zipkin.endpoint=http://你Zipkin服務(wù)所在機(jī)器的IP:9411/api/v1/spans
zipkin.service=servicea
我們最后依次啟動(dòng)ServiceA、ServiceB染苛、和ServiceC三個(gè)微服務(wù)鹊漠,并開始實(shí)驗(yàn)來(lái)收集鏈路追蹤數(shù)據(jù) 主到!
實(shí)際實(shí)驗(yàn)
1. 依賴分析
瀏覽器打開Zipkin的UI界面,可以查看 依賴分析:
圖中十分清晰地展示了ServiceA躯概、ServiceB和ServiceC三個(gè)服務(wù)之間的調(diào)用關(guān)系登钥!
注意,該圖可縮放娶靡,并且每一個(gè)元素均可以點(diǎn)擊牧牢,例如點(diǎn)擊 ServiceB這個(gè)微服務(wù),可以看到其調(diào)用鏈的上下游姿锭!
2. 查找調(diào)用鏈
接下來(lái)我們看一下調(diào)用鏈相關(guān)塔鳍,點(diǎn)擊 服務(wù)名,可以看到Zipkin監(jiān)控到個(gè)所有服務(wù):
同時(shí)可以查看Span呻此,如以ServiceA為例轮纫,其所有REST接口都再下拉列表中:
以ServiceA為例,點(diǎn)擊 Find Traces趾诗,可以看到其所有追蹤信息:
點(diǎn)擊某個(gè)具體Trace蜡感,還能看到詳細(xì)的每個(gè)Span的信息,如下圖中恃泪,可以看到 A → B → C 調(diào)用過(guò)程中每個(gè)REST接口的詳細(xì)時(shí)間戳:
點(diǎn)擊某一個(gè)REST接口進(jìn)去還能看到更詳細(xì)的信息郑兴,如查看/servicec這個(gè)REST接口,可以看到從發(fā)送請(qǐng)求到收到響應(yīng)信息的所有詳細(xì)步驟:
后記
由于能力有限贝乎,若有錯(cuò)誤或者不當(dāng)之處情连,還請(qǐng)大家批評(píng)指正,一起學(xué)習(xí)交流览效!