全部产品
云市场
云游戏

OkHttp 埋点接入

更新时间:2020-03-30 11:21:41

本文将基于 示例工程 介绍如何使用 SOFATracer 对 OkHttp 进行埋点。

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

  1. 引入依赖
  2. 工程配置
  3. 添加 Controller
  4. 构造 OkHttp Client 调用实例
  5. 启动应用
  6. 查看日志

引入依赖

  1. <!-- SOFATracer 依赖 -->
  2. <dependency>
  3. <groupId>com.alipay.sofa</groupId>
  4. <artifactId>tracer-enterprise-sofa-boot-starter</artifactId>
  5. </dependency>
  6. <!-- okhttp 依赖 -->
  7. <dependency>
  8. <groupId>com.squareup.okhttp3</groupId>
  9. <artifactId>okhttp</artifactId>
  10. <version>3.12.1</version>
  11. </dependency>

工程配置

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

  1. # Application Name
  2. spring.application.name=OkHttpClientDemo
  3. # logging path
  4. logging.path=./logs
  5. # port
  6. server.port=8081

添加一个提供 RESTful 服务的 Controller

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

  1. @RestController
  2. public class SampleRestController {
  3. private final AtomicLong counter = new AtomicLong(0);
  4. /**
  5. * Request http://localhost:8081/okhttp?name=sofa
  6. * @param name name
  7. * @return Map of Result
  8. */
  9. @RequestMapping("/okhttp")
  10. public Map<String, Object> greeting(@RequestParam(value = "name", defaultValue = "okhttp") String name) {
  11. Map<String, Object> map = new HashMap<>();
  12. map.put("count", counter.incrementAndGet());
  13. map.put("name", name);
  14. return map;
  15. }
  16. }

构造 OkHttp 发起一次对上文的 RESTful 服务的调用

构造 OkHttp Client 调用实例的代码示例如下:

  1. OkHttpClientInstance httpClient = new OkHttpClientInstance();
  2. String httpGetUrl = "http://localhost:8081/okhttp?name=sofa";
  3. String responseStr = httpClient.executeGet(httpGetUrl);

启动应用

启动 SOFABoot 应用,在控制台中看到启动打印的日志如下:

  1. 2019-04-12 13:38:09.896 INFO 51193 --- [ main] o.s.j.e.a.AnnotationMBeanExporter : Registering beans for JMX exposure on startup
  2. 2019-04-12 13:38:09.947 INFO 51193 --- [ main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s): 8081 (http)
  3. 2019-04-12 13:38:09.952 INFO 51193 --- [ main] c.a.s.t.e.okhttp.OkHttpDemoApplication : Started OkHttpDemoApplication in 3.314 seconds (JVM running for 4.157)

当有类似如下的日志时,说明 OkHttp 的调用成功:

  1. 2019-04-12 13:38:10.205 INFO 51193 --- [ main] c.a.s.t.e.okhttp.OkHttpDemoApplication : Response is {"count":1,"name":"sofa"}

查看日志

在上面的 application.properties 里面,配置的日志打印目录是 ./logs,即当前应用的根目录(您可以根据自己的实践需要进行配置),在当前工程的根目录下可以看到类似如下结构的日志文件:

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

示例中通过构造 OkHttp 对象发起 RESTful 服务的调用,调用完成后可以在 okhttp-digest.log 中看到类似如下的日志:

  1. {"time":"2019-09-03 11:35:28.429","local.app":"OkHttpDemo","traceId":"0a0fe9271567481728265100112783","spanId":"0","span.kind":"client","result.code":"200","current.thread.name":"main","time.cost.milliseconds":"164ms","request.url":"http://localhost:8081/okhttp?name=sofa","method":"GET","result.code":"200","req.size.bytes":0,"resp.size.bytes":0,"remote.app":"","sys.baggage":"","biz.baggage":""}