AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

使用Zipkin 和 Brave 实现http(springmvc)服务调用跟踪(一)

2018-03-06 4348
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介：

使用Zipkin 和 Brave 实现http(springmvc)服务调用跟踪(一)

Zipkin 是一款开源的分布式实时数据追踪系统（Distributed Tracking System），基于 Google Dapper 的论文设计而来，由 Twitter 公司开发贡献。其主要功能是聚集来自各个异构系统的实时监控数据，用来追踪微服务架构下的系统延时问题。

Brave 是用来装备 Java 程序的类库，提供了面向 Standard Servlet、Spring MVC、Http Client、JAX RS、Jersey、Resteasy 和 MySQL 等接口的装备能力，可以通过编写简单的配置和代码，让基于这些框架构建的应用可以向 Zipkin 报告数据。同时 Brave 也提供了非常简单且标准化的接口，在以上封装无法满足要求的时候可以方便扩展与定制（下篇会讲）。

有关zipkin与Brave的详细介绍：http://www.tuicool.com/articles/f2qAZnZ

 

客户端发起请求到接收到服务端回应，先后经过四个阶段：客户端/消费者发起请求（cs）、服务端/生产者接收到请求（sr）、服务端/生产者发送应答（ss）和客户端/消费者接收到应答（cr）。Brave为Spring提供的Servlet拦截器（ServletHandlerInterceptor）及Rest（BraveClientHttpRequestInterceptor）模板的拦截器，向zipkin报告监控数据，其中，BraveClientHttpRequestInterceptor负责cs与cr的处理，ServletHandlerInterceptor负责sr与ss的处理。

好，开始实验这两个拦截器的使用，目标是发布两个服务a和b,在a中调用b服务,记录调用的跟踪信息。

git项目地址：https://github.com/blacklau/brave-webmvc-example   （forked from openzipkin/brave-webmvc-example ，请忽略README.md说明）

1、pom.xml

[html] view plain copy

  1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  2.   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  3.   <modelVersion>4.0.0</modelVersion>
  5.   <groupId>io.zipkin.brave</groupId>
  6.   <artifactId>brave-webmvc-example</artifactId>
  7.   <version>1.0-SNAPSHOT</version>
  8.   <packaging>war</packaging>
  10.   <name>brave-webmvc-examplea</name>
  11.   <description>Example using Brave to trace RPCs from Spring Web MVC</description>
  12.   <url>https://github.com/openzipkin/brave-webmvc-example</url>
  14.   <properties>
  15.     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  16.     <spring.version>4.3.3.RELEASE</spring.version>
  17.     <jetty.version>8.1.20.v20160902</jetty.version>
  18.     <brave.version>3.16.0</brave.version>
  19.     <zipkin-reporter.version>0.6.9</zipkin-reporter.version>
  20.   </properties>
  22.   <dependencies>
  23.   <dependency>
  24.       <groupId>junit</groupId>
  25.       <artifactId>junit</artifactId>
  26.       <version>4.10</version>
  27.       <scope>test</scope>
  28.     </dependency>
  29.     <dependency>
  30.         <groupId>io.zipkin.brave</groupId>
  31.         <artifactId>brave-core-spring</artifactId>
  32.         <version>${brave.version}</version>
  33.     </dependency>
  34.     <dependency>
  35.       <groupId>io.zipkin.reporter</groupId>
  36.       <artifactId>zipkin-sender-okhttp3</artifactId>
  37.       <version>${zipkin-reporter.version}</version>
  38.     </dependency>
  39.     <dependency>
  40.       <groupId>io.zipkin.reporter</groupId>
  41.       <artifactId>zipkin-sender-libthrift</artifactId>
  42.       <version>${zipkin-reporter.version}</version>
  43.     </dependency>
  44.     <dependency>
  45.       <groupId>io.zipkin.reporter</groupId>
  46.       <artifactId>zipkin-sender-kafka08</artifactId>
  47.       <version>${zipkin-reporter.version}</version>
  48.     </dependency>
  49.     <dependency>
  50.         <groupId>io.zipkin.brave</groupId>
  51.         <artifactId>brave-spring-web-servlet-interceptor</artifactId>
  52.         <version>${brave.version}</version>
  53.     </dependency>
  54.     <dependency>
  55.       <groupId>io.zipkin.brave</groupId>
  56.       <artifactId>brave-spring-resttemplate-interceptors</artifactId>
  57.       <version>${brave.version}</version>
  58.     </dependency>
  59.     <dependency>
  60.         <groupId>org.springframework</groupId>
  61.         <artifactId>spring-core</artifactId>
  62.         <version>${spring.version}</version>
  63.     </dependency>
  64.     <dependency>
  65.         <groupId>org.springframework</groupId>
  66.         <artifactId>spring-context</artifactId>
  67.         <version>${spring.version}</version>
  68.     </dependency>
  69.     <dependency>
  70.         <groupId>org.springframework</groupId>
  71.         <artifactId>spring-beans</artifactId>
  72.         <version>${spring.version}</version>
  73.     </dependency>
  74.     <dependency>
  75.         <groupId>org.springframework</groupId>
  76.         <artifactId>spring-web</artifactId>
  77.         <version>${spring.version}</version>
  78.     </dependency>
  79.     <dependency>
  80.         <groupId>org.springframework</groupId>
  81.         <artifactId>spring-webmvc</artifactId>
  82.         <version>${spring.version}</version>
  83.     </dependency>
  84.     <dependency>
  85.        <groupId>org.eclipse.jetty</groupId>
  86.        <artifactId>jetty-server</artifactId>
  87.        <version>${jetty.version}</version>
  88.        <scope>test</scope>
  89.     </dependency>
  90.     <dependency>
  91.        <groupId>org.eclipse.jetty</groupId>
  92.        <artifactId>jetty-webapp</artifactId>
  93.        <version>${jetty.version}</version>
  94.        <scope>test</scope>
  95.     </dependency>
  96.         <dependency>
  97.         <groupId>log4j</groupId>
  98.         <artifactId>log4j</artifactId>
  99.         <version>1.2.17</version>
  100.     </dependency>
  101.     <dependency>
  102.         <groupId>org.slf4j</groupId>
  103.         <artifactId>slf4j-log4j12</artifactId>
  104.         <version>1.7.21</version>
  105.     </dependency>
  106.     <dependency>
  107.         <groupId>org.slf4j</groupId>
  108.         <artifactId>jcl-over-slf4j</artifactId>
  109.         <version>1.7.21</version>
  110.     </dependency>
  111.   </dependencies>
  112.   <build>
  113.      <plugins>
  114.             <plugin>
  115.                 <inherited>true</inherited>
  116.                 <groupId>org.apache.maven.plugins</groupId>
  117.                 <artifactId>maven-compiler-plugin</artifactId>
  118.                 <version>2.5.1</version>
  119.                 <configuration>
  120.                     <source>1.6</source>
  121.                     <target>1.6</target>
  122.                     <optimize>true</optimize>
  123.                     <debug>true</debug>
  124.                 </configuration>
  125.             </plugin>
  126.             <plugin>
  127.                 <groupId>org.apache.maven.plugins</groupId>
  128.                 <artifactId>maven-failsafe-plugin</artifactId>
  129.                 <version>2.19.1</version>
  130.                 <executions>
  131.                      <execution>
  132.                         <id>integration-test</id>
  133.                         <goals>
  134.                            <goal>integration-test</goal>
  135.                         </goals>
  136.                      </execution>
  137.                      <execution>
  138.                          <id>verify</id>
  139.                          <goals>
  140.                            <goal>verify</goal>
  141.                          </goals>
  142.                      </execution>
  143.                 </executions>
  144.            </plugin>
  145.            <plugin>
  146.                 <groupId>org.apache.maven.plugins</groupId>
  147.                 <artifactId>maven-war-plugin</artifactId>
  148.                 <version>3.0.0</version>
  149.                 <configuration>
  150.                      <webResources>
  151.                         <resource>
  152.                            <directory>${basedir}/src/main/webapp</directory>
  153.                            <filtering>true</filtering>
  154.                            <includes>
  155.                               <include>**/index.html</include>
  156.                            </includes>
  157.                         </resource>
  158.                         <resource>
  159.                            <directory>${basedir}/src/main/webapp/WEB-INF</directory>
  160.                            <filtering>true</filtering>
  161.                            <targetPath>WEB-INF</targetPath>
  162.                            <includes>
  163.                               <include>**/web.xml</include>
  164.                            </includes>
  165.                         </resource>
  166.                      </webResources>
  167.                      <packagingExcludes>WEB-INF/lib/servlet-api-*.jar</packagingExcludes>
  168.                   </configuration>
  169.            </plugin>
  170.     </plugins>
  171.   </build>
  172. </project>

 

2、Brave的初始化及添加拦截器

[java] view plain copy

  1. <span style="font-size:18px;">package brave.webmvc;
  3. import com.github.kristofa.brave.Brave;
  4. import com.github.kristofa.brave.LoggingReporter;
  5. import com.github.kristofa.brave.http.DefaultSpanNameProvider;
  6. import com.github.kristofa.brave.http.SpanNameProvider;
  7. import com.github.kristofa.brave.spring.BraveClientHttpRequestInterceptor;
  8. import com.github.kristofa.brave.spring.ServletHandlerInterceptor;
  9. import java.util.ArrayList;
  10. import java.util.List;
  11. import javax.annotation.PostConstruct;
  12. import org.springframework.beans.factory.annotation.Autowired;
  13. import org.springframework.context.annotation.Bean;
  14. import org.springframework.context.annotation.Configuration;
  15. import org.springframework.context.annotation.Import;
  16. import org.springframework.http.client.ClientHttpRequestInterceptor;
  17. import org.springframework.web.client.RestTemplate;
  18. import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
  19. import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
  20. import zipkin.Span;
  21. import zipkin.reporter.Reporter;
  22. import zipkin.reporter.Sender;
  23. import zipkin.reporter.okhttp3.OkHttpSender;
  26. /**
  27.  * This adds tracing configuration to any web mvc controllers or rest template clients. This should
  28.  * be configured last.
  29.  */
  30. @Configuration
  31. // import as the interceptors are annotation with javax.inject and not automatically wired
  32. @Import({BraveClientHttpRequestInterceptor.class, ServletHandlerInterceptor.class})
  33. public class WebTracingConfiguration extends WebMvcConfigurerAdapter {
  36.   /** 发送器配置 */
  37.   @Bean Sender sender() {
  38.     return OkHttpSender.create("http://127.0.0.1:9411/api/v1/spans");
  39.     //return LibthriftSender.create("127.0.0.1");
  40.     // return KafkaSender.create("127.0.0.1:9092");
  41.   }
  44.   /** 用什么方式显示span信息 */
  45.   @Bean Reporter<Span> reporter() {
  46. //取消注释,日志打印span信息
  47. //return new LoggingReporter(); 
  49.     return AsyncReporter.builder(sender()).build();
  50.   }
  53.   @Bean Brave brave() {
  54.     return new Brave.Builder("brave-webmvc-example").reporter(reporter()).build();
  55.   }
  58.   // span命名提供者，默认为http方法.
  59.   @Bean SpanNameProvider spanNameProvider() {
  60.     return new DefaultSpanNameProvider();
  61.   }
  64.   @Autowired
  65.   private ServletHandlerInterceptor serverInterceptor;
  68.   @Autowired
  69.   private BraveClientHttpRequestInterceptor clientInterceptor;
  72.   @Autowired
  73.   private RestTemplate restTemplate;
  76.   // 添加rest template拦截器
  77.   @PostConstruct
  78.   public void init() {
  79.     List<ClientHttpRequestInterceptor> interceptors =
  80.         new ArrayList<ClientHttpRequestInterceptor>(restTemplate.getInterceptors());
  81.     interceptors.add(clientInterceptor);
  82.     restTemplate.setInterceptors(interceptors);
  83.   }
  86.   // 添加Severlet拦截器
  87.   @Override
  88.   public void addInterceptors(InterceptorRegistry registry) {
  89.     registry.addInterceptor(serverInterceptor);
  90.   }
  91. }</span>

 

3、springmvc的controller，发布a和b两个服务

[java] view plain copy

  1. <span style="font-size:18px;">package brave.webmvc;
  4. import java.util.Random;
  5. import org.springframework.beans.factory.annotation.Autowired;
  6. import org.springframework.context.annotation.Bean;
  7. import org.springframework.context.annotation.Configuration;
  8. import org.springframework.web.bind.annotation.RequestMapping;
  9. import org.springframework.web.bind.annotation.RestController;
  10. import org.springframework.web.client.RestTemplate;
  11. import org.springframework.web.servlet.config.annotation.EnableWebMvc;
  14. @RestController
  15. @EnableWebMvc
  16. @Configuration
  17. public class ExampleController {
  20.   @Bean RestTemplate template() {
  21.     return new RestTemplate();
  22.   }
  25.   @Autowired RestTemplate template;
  28.   @RequestMapping("/a")
  29.   public String a() throws InterruptedException {
  30.     Random random = new Random();
  31.     Thread.sleep(random.nextInt(1000));
  34.     return template.getForObject("http://localhost:8080/brave-webmvc-example/b", String.class);
  35.   }
  38.   @RequestMapping("/b")
  39.   public String b() throws InterruptedException {
  42.     Random random = new Random();
  43.     Thread.sleep(random.nextInt(1000));
  46.     return "b";
  47.   }
  48. }</span>

 

4、web.xml配置

[html] view plain copy

  1. <span style="font-size:18px;"><?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd">
  3. <web-app>
  4. <display-name>brave webmvc example</display-name>
  6. <servlet>
  7.  <servlet-name>dispatcher</servlet-name>
  8.  <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
  10.  <init-param>
  11.  <param-name>contextClass</param-name>
  12.  <param-value>
  13.  org.springframework.web.context.support.AnnotationConfigWebApplicationContext
  14.  </param-value>
  15.  </init-param>
  16.  <init-param>
  17.  <param-name>contextConfigLocation</param-name>
  18.  <!--  Loads the application configuration and resource. Tracing configuration is optional and goes last. -->
  19.  <param-value>
  20. brave.webmvc.ExampleController
  21. brave.webmvc.WebTracingConfiguration
  22. </param-value>
  23.  </init-param>
  24.  <load-on-startup>1</load-on-startup>
  25. </servlet>
  26. <servlet-mapping>
  27.  <servlet-name>dispatcher</servlet-name>
  28.  <url-pattern>/*</url-pattern>
  29. </servlet-mapping>
  30. </web-app>
  31. </span>

 

5、下载zipkin并运行

下载地址： https://search.maven.org/remote_content?g=io.zipkin.java&a=zipkin-server&v=LATEST&c=exec

运行： java -jar zipkin.jar

6、git上下载项目，maven打war包（打包时，请跳过测试，否则报错）部署到tomcat或在开发环境中运行

访问a服务： http://localhost:8080/brave-webmvc-example/a

打开：http://localhost:9411，查看调用链跟踪信息及耗时

发现Brave提供的拦截器使用的Span的名称是默认的http的请求方法，好像没多大意义，且没有记录请求参数，若调用链中出现bug，不方便bug重现与问题排查，下一篇讲使用Brave的扩展与定制，重写span名称的获取与添加请求参数到跟踪信息中

原文地址http://www.bieryun.com/1919.html

文章标签：
Java
Spring
Apache
Web App开发
关键词：
Spring MVC服务调用
zipkin HTTP
优惠码发放
目录
相关文章
优惠券发放
|
Java
使用Zipkin 和 Brave 实现http(springmvc)服务调用跟踪(二)
优惠券发放
2953 0
@dailidong@
|
Web App开发 监控 前端开发
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html><head><meta http-equiv="Cont
目前实现的监控概览               
@dailidong@
797 0
@dailidong@
|
Web App开发 前端开发
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html><head><meta http-equiv="Cont
总结和计划总是让人喜悦或镇痛，一方面以前一段时间没有荒废，能给现在的行动以信心，另一方面看到一年的时间并不能完成很多事情，需要抓紧时间。
@dailidong@
617 0
@dailidong@
|
Web App开发 监控 前端开发
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html><head><meta http-equiv="Cont
系统的升级涉及各个架构组件，细节很多。常年累月的修修补补使老系统积累了很多问题。 系统升级则意味着需要repair之前埋下的雷，那为何还要升级，可以考虑以下几个方面 成熟老系统常见问题： 1. 缺乏文档（这应该是大小公司都存在的问题。
@dailidong@
624 0
@dailidong@
|
Web App开发 监控 前端开发
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html><head><meta http-equiv="Cont
已发现2个内存错误，应用名称（kernel:）,日志内容(hangzhou-jishuan-DDS0248 kernel: sbridge: HANDLING MCE MEMORY ERROR hangzhou-jis...
@dailidong@
851 0
@dailidong@
|
Web App开发 前端开发 Java
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html><head><meta http-equiv="Cont
Changing Hive Dynamic Partition Limits Symptoms: Hive enforces limits on the number of dynamic partitions that it creates.
@dailidong@
1026 0
@dailidong@
|
Web App开发 前端开发
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html><head><meta http-equiv="Cont
一个典型的星型模式包括一个大型的事实表和一组逻辑上围绕这个事实表的维度表。　　事实表是星型模型的核心，事实表由主键和度量数据两部分组成。
@dailidong@
542 0
@dailidong@
|
机器学习/深度学习 Web App开发 前端开发
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html><head><meta http-equiv="Cont
输入python，进入python命令行 import tensorflow as tf tf.__version__ 查询tensorflow安装路径为: tf.
@dailidong@
721 0
@dailidong@
|
Web App开发 前端开发 Linux
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html><head><meta http-equiv="Cont
一般来说，Linux的虚拟内存会根据系统负载自动调整。内存页（page）swap到磁盘会显著的影响Kafka的性能，并且Kafka重度使用page cache，如果VM系统swap到磁盘，那说明没有足够的内存来分配page cache。
@dailidong@
666 0
王坤23
|
Web App开发 JavaScript 前端开发
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html><head><meta http-equiv="Cont
Clean jPlayer skin: Example $(document).
王坤23
2781 0

热门文章

最新文章

  • 1
    Java发送Http请求（HttpClient）
  • 2
    阿里云虚拟主机HTTPS（HTTP+SSL）加密开通了
  • 3
    android-async-http框架的学习和使用
  • 4
    <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html><head><meta http-equiv="Cont
  • 5
    关于使用HTTP代理IP爬虫采集的认知误区
  • 6
    HTTP连接客户端，选 HttpClient 还是 OkHttp ？
  • 7
    <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html><head><meta http-equiv="Cont
  • 8
    统计http连接数
  • 9
    Tomcat 无法及时响应，http请求一直pending状态
  • 10
    nginx HTTP Upstream模块
  • 1
    SpringMVC04 实现简单的留言墙功能
    41
  • 2
    SpringMVC03 基础操作续与几个简单的交互
    35
  • 3
    Spring MVC框架概述
    84
  • 4
    SpringBoot与SpringMVC有哪些区别？
    422
  • 5
    SpringBoot：SpringMVC（下）
    42
  • 6
    SpringBoot：SpringMVC（上）
    49
  • 7
    生活小事件(SpringMVC主要的组件及作用和执行流程)
    95
  • 8
    数据塑造：Spring MVC中@ModelAttribute的高级数据预处理技巧
    68
  • 9
    数据之桥：深入Spring MVC中传递数据给视图的实用指南
    92
  • 10
    头头是道：揭示Spring MVC如何获取和处理请求头数据
    109

    • 相关课程

    更多
  • Java Web开发-Web应用、Tomcat、HTTP请求与响应
  • 云安全基础课- HTTP协议基础

    • 相关电子书

    更多
  • 阿里巴巴HTTP 2.0实践及无线通信协议的演进之路
  • Apache Dubbo3 源码深入解读
  • 低代码开发师（初级）实战教程

    • 相关实验场景

    更多
  • 通过轻量消息队列（原MNS）主题HTTP订阅+ARMS实现自定义数据多渠道告警
  • 快速上手使用Dubbo进行远程调用
    • 下一篇
    无影云桌面