全部产品

OkHttp 埋点接入

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

您可以单击 此处来下载本文中的示例工程。

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

  1. 引入依赖

  2. 工程配置

  3. 添加 Controller

  4. 构造 OkHttp Client 调用实例

  5. 启动应用

  6. 查看日志

引入依赖

  • 在 SOFABoot 的 Web 项目中引入如下 Tracer 依赖:

<!-- SOFATracer 依赖 -->
<dependency>
    <groupId>com.alipay.sofa</groupId>
    <artifactId>tracer-enterprise-sofa-boot-starter</artifactId>
</dependency>

添加 Tracer starter 依赖后,可在 SOFABoot 的全局配置文件中添加配置项目以定制 Tracer 的行为。详情见 Tracer 配置项说明

  • 引入okhttp 依赖:

<!-- okhttp 依赖 -->
<dependency>
    <groupId>com.squareup.okhttp3</groupId>
    <artifactId>okhttp</artifactId>
    <version>3.12.1</version>
</dependency>

工程配置

在工程的 application.properties 文件下添加 SOFATracer 要使用的参数,包括spring.application.namelogging.path

  • spring.application.name用于标示当前应用的名称。

  • logging.path 用于指定日志的输出目录。

# Application Name
spring.application.name=OkHttpClientDemo
# logging path
logging.path=./logs
# port
server.port=8081

添加一个提供 RESTful 服务的 Controller

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

 @RestController
    public class SampleRestController{

        private final AtomicLong counter =new AtomicLong(0);

        /**
         * Request http://localhost:8081/okhttp?name=sofa
         * @param name name
         * @return Map of Result
         */
        @RequestMapping("/okhttp")
        public Map<String,Object> greeting(@RequestParam(value ="name", defaultValue ="okhttp")String name){
            Map<String,Object> map =new HashMap<>();
            map.put("count", counter.incrementAndGet());
            map.put("name", name);
            return map;
        }
    }

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

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

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

启动应用

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

2019-04-1213:38:09.896  INFO 51193---[           main] o.s.j.e.a.AnnotationMBeanExporter:Registering beans for JMX exposure on startup
2019-04-1213:38:09.947  INFO 51193---[           main] s.b.c.e.t.TomcatEmbeddedServletContainer:Tomcat started on port(s):8081(http)
2019-04-1213:38:09.952  INFO 51193---[           main] c.a.s.t.e.okhttp.OkHttpDemoApplication:StartedOkHttpDemoApplicationin3.314 seconds (JVM running for4.157)

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

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

查看日志

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

./logs
├── spring.log
└── tracelog
├── okhttp-digest.log
├── okhttp-stat.log
├── spring-mvc-digest.log
├── spring-mvc-stat.log
├──static-info.log
└── tracer-self.log

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

{"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":""}