Spring MVC 埋点接入

更新时间: 2019-07-19

在本文档将演示如何使用 SOFATracer 对 SpringMVC 进行埋点，本示例工程地址。

假设你已经基于 SOFABoot 构建了一个简单的 Spring Web 工程，那么可以通过如下步骤进行操作：

依赖引入

  1. <dependency>
  2.     <groupId>com.alipay.sofa</groupId>
  3.     <artifactId>tracer-sofa-boot-starter</artifactId>
  4. </dependency>

工程配置

在工程的 application.properties 文件下添加 SOFATracer 要使用的参数，包括spring.application.name 用于标示当前应用的名称；logging.path 用于指定日志的输出目录。

  1. # Application Name
  2. spring.application.name=SOFATracerSpringMVC
  3. # logging path
  4. logging.path=./logs

添加一个提供 RESTful 服务的 Controller

在工程代码中，添加一个简单的 Controller，例如：

  1. @RestController
  2. public class SampleRestController {
  4.     private static final String TEMPLATE = "Hello, %s!";
  5.     private final AtomicLong    counter  = new AtomicLong();
  6.     /**
  7.      * http://localhost:8080/springmvc
  8.      * @param name name
  9.      * @return map
  10.      */
  11.     @RequestMapping("/springmvc")
  12.     public Map<String, Object> springmvc(@RequestParam(value = "name", defaultValue = "SOFATracer SpringMVC DEMO") String name) {
  13.         Map<String, Object> resultMap = new HashMap<String, Object>();
  14.         resultMap.put("success", true);
  15.         resultMap.put("id", counter.incrementAndGet());
  16.         resultMap.put("content", String.format(TEMPLATE, name));
  17.         return resultMap;
  18.     }
  19. }

运行

启动 SOFABoot 应用，将会在控制台中看到启动打印的日志：

  1. 2018-05-11 11:55:11.932  INFO 66490 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean   : Mapping filter: 'SpringMvcOpenTracingFilter' to urls: [/*]
  2. 2018-05-11 11:55:13.961  INFO 66490 --- [           main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s): 8080 (http)
  3. 2018-05-11 11:55:13.970  INFO 66490 --- [           main] c.a.s.t.e.springmvc.DemoApplication      : Started DemoApplication in 8.361 seconds (JVM running for 9.34)

可以通过在浏览器中输入 http://localhost:8080/springmvc 来访问 REST 服务，结果类似如下：

  1. {
  2.     content: "Hello, SOFATracer SpringMVC DEMO!",
  3.     id: 1,
  4.     success: true
  5. }

查看日志

在上面的 application.properties 里面，我们配置的日志打印目录是 ./logs 即当前应用的根目录（我们可以根据自己的实践需要配置），在当前工程的根目录下可以看到类似如下结构的日志文件：

  1. ./logs
  2. ├── spring.log
  3. └── tracelog
  4.     ├── spring-mvc-digest.log
  5.     ├── spring-mvc-stat.log
  6.     ├── static-info.log
  7.     └── tracer-self.log

通过访问 http://localhost:8080/springmvc SOFATracer 会记录每一次访问的摘要日志，可以打开 spring-mvc-digest.log 看到具体的输出内容。

  1. {"time":"2018-05-17 22:20:34.279","local.app":"SOFATracerSpringMVC","traceId":"0a0fe9391526566833985100139443","spanId":"0","request.url":"http://localhost:8080/springmvc","method":"GET","result.code":"200","req.size.bytes":-1,"resp.size.bytes":69,"time.cost.milliseconds":284,"current.thread.name":"http-nio-8080-exec-1","baggage":""}