Spring Cloud构建微服务架构：分布式服务跟踪（整合logstash）【Dalston版】

通过之前的《入门示例》，我们已经为两个由SpringCloud构建的微服务项目 trace-1和 trace-2引入了Spring Cloud Sleuth的基础模块 spring-cloud-starter-sleuth，实现了为各微服务的日志信息中添加跟踪信息的功能。但是，由于日志文件都离散的存储在各个服务实例的文件系统之上，仅仅通过查看日志文件来分析我们的请求链路依然是一件相当麻烦的差事，所以我们还需要一些工具来帮助我们集中的收集、存储和搜索这些跟踪信息。引入基于日志的分析系统是一个不错的选择，比如：ELK平台，它可以轻松的帮助我们来收集和存储这些跟踪日志，同时在需要的时候我们也可以根据Trace ID来轻松地搜索出对应请求链路相关的明细日志。

ELK平台主要有由ElasticSearch、Logstash和Kiabana三个开源免费工具组成：

• Elasticsearch是个开源分布式搜索引擎，它的特点有：分布式，零配置，自动发现，索引自动分片，索引副本机制，restful风格接口，多数据源，自动搜索负载等。

• Logstash是一个完全开源的工具，他可以对你的日志进行收集、过滤，并将其存储供以后使用。

• Kibana 也是一个开源和免费的工具，它Kibana可以为 Logstash 和 ElasticSearch 提供的日志分析友好的 Web 界面，可以帮助您汇总、分析和搜索重要数据日志。

Spring Cloud Sleuth在与ELK平台整合使用时，实际上我们只要实现与负责日志收集的Logstash完成数据对接即可，所以我们需要为Logstash准备json格式的日志输出。由于Spring Boot应用默认使用了logback来记录日志，而Logstash自身也有对logback日志工具的支持工具，所以我们可以直接通过在logback的配置中增加对logstash的appender，就能非常方便的将日志转换成以json的格式存储和输出了。

下面我们来详细介绍一下在快速入门示例的基础上，如何实现面向Logstash的日志输出配置：

• 在 pom.xml依赖中引入 logstash-logback-encoder依赖，具体如下：

1. <dependency>

2.  <groupId>net.logstash.logback</groupId>

3.  <artifactId>logstash-logback-encoder</artifactId>

4.  <version>4.6</version>

5. </dependency>

• 在工程 /resource目录下创建 bootstrap.properties配置文件，将 spring.application.name=trace-1配置移动到该文件中去。由于 logback-spring.xml的加载在 application.properties之前，所以之前的配置 logback-spring.xml无法获取到 spring.application.name属性，因此这里将该属性移动到最先加载的 bootstrap.properties配置文件中。

• 在工程 /resource目录下创建logback配置文件 logback-spring.xml，具体内容如下：

1. <?xml version="1.0" encoding="UTF-8"?>

2. <configuration>

3.    <include resource="org/springframework/boot/logging/logback/defaults.xml"/>

4.    <springProperty scope="context" name="springAppName" source="spring.application.name"/>

5.    <!-- 日志在工程中的输出位置 -->

6.    <property name="LOG_FILE" value="${BUILD_FOLDER:-build}/${springAppName}"/>

7.    <!-- 控制台的日志输出样式 -->

8.    <property name="CONSOLE_LOG_PATTERN"

9.              value="%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr([${springAppName:-},%X{X-B3-TraceId:-},%X{X-B3-SpanId:-},%X{X-Span-Export:-}]){yellow} %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}"/>

10.    <!-- 控制台Appender -->

11.    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">

12.        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">          

13.            <level>INFO</level>

14.        </filter>

15.         <encoder>

16.            <pattern>${CONSOLE_LOG_PATTERN}</pattern>

17.            <charset>utf8</charset>

18.       </encoder>

19.    </appender>

20.    <!-- 为logstash输出的json格式的Appender -->

21.    <appender name="logstash" class="ch.qos.logback.core.rolling.RollingFileAppender">

22.        <file>${LOG_FILE}.json</file>

23.        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

24.            <fileNamePattern>${LOG_FILE}.json.%d{yyyy-MM-dd}.gz</fileNamePattern>

25.            <maxHistory>7</maxHistory>

26.        </rollingPolicy>

27.        <encoder class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">

28.            <providers>

29.                <timestamp>

30.                    <timeZone>UTC</timeZone>

31.                </timestamp>

32.                <pattern>

33.                    <pattern>

34.                        {

35.                          "severity": "%level",

36.                          "service": "${springAppName:-}",

37.                          "trace": "%X{X-B3-TraceId:-}",

38.                          "span": "%X{X-B3-SpanId:-}",

39.                          "exportable": "%X{X-Span-Export:-}",

40.                          "pid": "${PID:-}",

41.                          "thread": "%thread",

42.                          "class": "%logger{40}",

43.                          "rest": "%message"

44.                        }

45.                    </pattern>

46.                </pattern>

47.            </providers>

48.        </encoder>

49.    </appender>

50.    <root level="INFO">

51.        <appender-ref ref="console"/>

52.        <appender-ref ref="logstash"/>

53.    </root>

54. </configuration>

对logstash支持主要通过名为 logstash的appender实现，内容并不复杂，主要是对日志信息的格式化处理，上面为了方便调试查看我们先将json日志输出到文件中。

完成上面的改造之后，我们再将快速入门的示例运行起来，并发起对 trace-1的接口访问。此时我们可以在 trace-1和 trace-2的工程目录下发现有一个 build目录，下面分别创建了以各自应用名称命名的json文件，该文件就是在 logback-spring.xml中配置的名为 logstash的appender输出的日志文件，其中记录了类似下面格式的json日志：

1. {"@timestamp":"2016-12-04T06:57:58.970+00:00","severity":"INFO","service":"trace-1","trace":"589ee5f7b860132f","span":"a9e891273affb7fc","exportable":"false","pid":"19756","thread":"http-nio-9101-exec-1","class":"c.d.TraceApplication$$EnhancerBySpringCGLIB$$a9604da6","rest":"===<call trace-1>==="}

2. {"@timestamp":"2016-12-04T06:57:59.061+00:00","severity":"INFO","service":"trace-1","trace":"589ee5f7b860132f","span":"2df8511ddf3d79a2","exportable":"false","pid":"19756","thread":"http-nio-9101-exec-1","class":"o.s.c.a.AnnotationConfigApplicationContext","rest":"Refreshing org.springframework.context.annotation.AnnotationConfigApplicationContext@64951f38: startup date [Sun Dec 04 14:57:59 CST 2016]; parent: org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext@4b8c8f15"}

我们除了可以通过上面的方式生成json文件之外，也可以使用 LogstashTcpSocketAppender将日志内容直接通过Tcp Socket输出到logstash服务端，比如：

1. <appender name="logstash" class="net.logstash.logback.appender.LogstashTcpSocketAppender">

2.  <destination>127.0.0.1:9250</destination>

3.  ...

4. </appender>

完整示例：

读者可以根据喜好选择下面的两个仓库中查看 trace-1和 trace-2两个项目：

• Github：https://github.com/dyc87112/SpringCloud-Learning/

• Gitee：https://gitee.com/didispace/SpringCloud-Learning/

如果您对这些感兴趣，欢迎star、follow、收藏、转发给予支持！

本文内容部分节选自我的《Spring Cloud微服务实战》，但对依赖的Spring Boot和Spring Cloud版本做了升级。

更多内容，请点击《Spring Cloud微服务架构汇总》

推荐阅读

长按指纹

一键关注

点击 “阅读原文” 看看本号其他精彩内容