Jaeger的客户端采样配置(Java版)

短命女 2022-09-12 04:40 146阅读 0赞

### 欢迎访问我的GitHub ###

> 这里分类和汇总了欣宸的全部原创(含配套源码)：[https://github.com/zq2599/blog\_demos][https_github.com_zq2599_blog_demos]

### 关于采样（Sampling） ###

*  采样很好理解：使用Jaeger时，未必需要将所有请求都上报到Jaeger，有时候只要抽取其中一部分观察即可，这就是按照一定策略进行采样；
 *  Jaeger SDK是支持多种采样配置的，在分布式系统中，他们遵循的原则是前置判定（consistent upfront 或者head-based），简单来说，假如consumer服务调用provider服务，那么某一次请求只要consumer决定不采样，那么provider在处理这个请求的时候也不会采样，也就是说对于一次完整的trace，只要最前面的服务不上报到jaeger，那么整个trace后面涉及的服务都不会上报到jaeger
 *  Jaeger采样配置分为客户端和服务端两种配置，默认用的是服务端配置
 *  本文咱们来了解如何在客户端（也就是接入Jaeger的应用）配置采样，并且动手验证效果，常用的客户端采样策略有以下三种：

1.  固定：要么全部采样，要门全部不采样
2.  比例：按照指定比例采样
3.  限速：固定时间周期内采样固定数量，例如每秒一个

*  接下来，逐个配置和体验这三种采样的效果

### 关于实战用的工程 ###

*  采样配置实战不涉及编码，只需要改一些配置，所以没必要大张旗鼓的新建工程写代码，用[《Jaeger开发入门(java版)》][Jaeger_java]一文中的两个maven子工程即可：服务提供方jaeger-service-provider和服务调用方jaeger-service-consumer，都做成docker镜像，用docker-compose启动，网络架构如下图：  
    ![在这里插入图片描述][18e1bc50c9be4d20a08ce1ed4f520657.png_pic_center]
 *  请确保项目的日志模板中已添加了traceId、spanId、sampled等变量，如下图红框所示，有了这些配置，咱们在日志中就能看到对应的trace是否被采样（这一步**非常重要**）：  
    ![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16]
 *  为了方便修改代码后重新部署启动，我写了个名为full.sh的shell脚本文件，运行即可将修改后的代码制作成最新的镜像并用docker-compose运行起来：

#!/bin/bash
    echo "停止docker-compose"
    cd jaeger-service-provider && docker-compose down && cd ..
    
    echo "编译构建"
    mvn clean package -U -DskipTests
    
    echo “创建provider镜像”
    cd jaeger-service-provider && docker build -t bolingcavalry/jaeger-service-provider:0.0.1 . && cd ..
    
    echo “创建consumer镜像”
    cd jaeger-service-consumer && docker build -t bolingcavalry/jaeger-service-consumer:0.0.1 . && cd ..
    
    echo "清理无效资源"
    docker system prune --volumes -f
    
    echo "启动docker-compose"
    cd jaeger-service-provider && docker-compose up -d && cd ..

*  如果您用的是IDEA，在下图红框位置添加一个自定义命令，选中上述shell文件，就可以在IDEA中用run命令来编译构建部署了：  
    ![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_18_color_FFFFFF_t_70_g_se_x_16]
 *  现在准备工作已经完成，开始实战吧，从最简单的固定采样开始；

### 固定采样 ###

*  固定采样的逻辑很简单：要么全部上报，要么一个也不报
 *  固定采样的配置方式如下图红框所示：  
    ![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 1]
 *  要注意的是：根据前置判定（consistent upfront 或者head-based）原则，只要将上述配置写入jaeger-service-consumer项目的配置文件即可，至于jaeger-service-provider维持原状不做任何改动
 *  执行前面写的full.sh脚本，编译构建部署
 *  浏览器访问http://localhost:18080/hello，产生一些web请求，多访问几次
 *  看jaeger-service-consumer容器的日志，如下图，红框中的sampled=false表示未采样，三此请求的日志都是如此：  
    ![在这里插入图片描述][78ff933cc3bd4b10b24235bd6739c266.png]
 *  再看jaeger-service-provider容器的日志，如下图红框，也全部都没有采样，这证明Jaeger的前置判定原则（consistent upfront 或者head-based）是准确的，jaeger-service-consumer是一次trace的源头，被它关闭了采样的trace，在后续的服务中也会自动关闭采样：  
    ![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 2]
 *  去Jaeger的web页面看看，空空如也，连服务列表中都没有jaeger-service-consumer和jaeger-service-provider：  
    ![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 3]
 *  试过了全部不采样，再来试试全部采样的配置，如下图红框：  
    ![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 4]
 *  重新部署，再产生几次请求，去看jaeger-service-consumer容器的日志，如下图红框，全部都被采样了：  
    ![在这里插入图片描述][ca494e03abc241f285406e7ac3822662.png]
 *  去看jaeger-service-provider容器的日志，也是如此，所有trace都被采样：  
    ![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 5]
 *  打开Jaeger的web页面，可见jaeger-service-consumer的三次请求对应的trace全部上报：  
    ![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 6]
 *  至此，最简单的固定采样已完成，来看看更实用的比例采样

### 比例采样 ###

*  顾名思义，就是按照一定的百分比采样，配置如下图所示：  
    ![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 7]
 *  执行前面写的full.sh脚本，编译构建部署
 *  测试比例采样的方法就是发多个请求，检查采样的trace是否是总数的十分之一，我这里用jmeter来执行多次请求，您可以选择自己擅长的工具，或者写代码写脚本，甚至手动访问多次
 *  使用jmeter可以控制请求次数，用的是Loop Controller，如下图红框所示：  
    ![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 8]
 *  向jaeger-service-consumer的/hello接口发送完一百次请求后，可以从docker容器日志中检查采样情况，这里使用grep和wc命令的组合来统计日志中出现sampled=true和sampled=false的行数，完整的命令如下：

docker logs jaeger-service-consumer| grep 'sampled=true'|wc -l

*  100个请求，采样率百分之十，但是用上述命令得到的结果并不是精确值10，而是8，再统计未采样的日志行数(把true改成false)，得到的结果是92，总数对得上，但是采样数并非精确的百分之十，如下图：  
    ![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 9]
 *  然后将请求总数增加到一千条，得到的采样比例接近百分之十，如下：  
    ![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 10]
 *  打开Jaeger的web页面，可见果然只有106个trace：  
    ![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 11]
 *  比例采样完成了，接下来是限速采样

### 限速采样 ###

*  关于限速，似乎不够具体不便于理解，但是看看官方文档上的关键字leaky bucket，如下图红框，聪明的您一定想到了其中的关键，漏桶限流算法（注意，是漏桶，不是令牌桶，漏桶算法的峰值和桶大小有关）：  
    ![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 12]
 *  配置如下图红框所示：  
    ![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 13]
 *  执行前面写的full.sh脚本，编译构建部署
 *  咱们的配置是每秒钟一次采样，所以验证的时候要控制好发送请求的时长，我这里还是用jmeter来发请求的，如下图红框所示，jmeter有种Runtime Controller类型的控制器，可以控制持续请求的时长，我这里设置为10秒：  
    ![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 14]
 *  用jmeter持续发送10秒的请求，从jmeter的汇总报告中可见一共发了70个请求：  
    ![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 15]
 *  用命令docker logs jaeger-service-consumer| grep ‘sampled=true’|wc -l查看采样总数，10秒的预期是10个，结果如下，并不精确，只是接近而已:  
    ![在这里插入图片描述][7c7cf4ede9f942cd94b7af6bcdb34dc0.png]
 *  清掉所有数据，将时长改成100秒试试，一共发出次852请求：  
    ![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 16]
 *  采样总数为96，接近预期：  
    ![在这里插入图片描述][2e56954d351f493097cc407e5dfdbba7.png]
 *  打开Jaeger的web页面也是96次trace：  
    ![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 17]

### 服务端配置一瞥 ###

*  还记得[《分布式调用链跟踪工具Jaeger？两分钟极速体验》][Jaeger]、[《Jaeger开发入门(java版)》][Jaeger_java 1]等文章中的操作吗？那时咱们并没有添加任何与采样有关的配置，但是每次请求都能在Jaeger的web页面上查到对应的trace，也就是说所有请求全部被采样了，这是为啥？
 *  如果配置文件中没有采样相关的内容，那么默认使用的就是远程配置，具体的信息就在jaeger的all-in-one容器中，执行下面这个命令，就能看到远程采样配置：

docker exec jaeger cat /etc/jaeger/sampling_strategies.json

*  上述命令可以看到sampling\_strategies.json的内容如下，原来服务端的配置是比例采样，不过比例是百分之百，这就能解释为何所有请求都能在Jaeger的web页面查到trace信息了：

{ 
      "default_strategy": { 
        "type": "probabilistic",
        "param": 1
      }
    }

*  至此，采样配置实战已经完成，希望能给您提供一些参考，辅助您针对实际情况定制更加合适的采样策略

### 你不孤单，欣宸原创一路相伴 ###

1.  [Java系列][Java]
2.  [Spring系列][Spring]
3.  [Docker系列][Docker]
4.  [kubernetes系列][kubernetes]
5.  [数据库+中间件系列][Link 1]
6.  [DevOps系列][DevOps]

[https_github.com_zq2599_blog_demos]: https://github.com/zq2599/blog_demos
[Jaeger_java]: https://blog.csdn.net/boling_cavalry/article/details/120360141
[18e1bc50c9be4d20a08ce1ed4f520657.png_pic_center]: /images/20220828/12c9caa140b74d81a0d4a00e60d8ded1.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16]: /images/20220828/bac1bb6d84244caa856dedf6816ad133.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_18_color_FFFFFF_t_70_g_se_x_16]: /images/20220828/ed59efd221ed42a09d78ea7fd5babb57.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 1]: /images/20220828/bc2b225002414a0aac0cc354b06c742d.png
[78ff933cc3bd4b10b24235bd6739c266.png]: /images/20220828/cbeecd8dbfc34526aaea524dc91c2cc6.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 2]: /images/20220828/0666dc9a26a34e7aa1289e9c2c7eea94.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 3]: /images/20220828/6600562590f34ef2a4e1d2ddac31295e.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 4]: /images/20220828/a80c50429d834fe8b1cb51c6bcf5a94c.png
[ca494e03abc241f285406e7ac3822662.png]: /images/20220828/9f775597dfb440fdb250e643b6672ec8.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 5]: /images/20220828/cce933c20aa042108ce99b538a899e76.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 6]: /images/20220828/a2affbf09ef8440bbf9e43340327aee5.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 7]: /images/20220828/a61f6821623a477298817277c80ca4c3.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 8]: /images/20220828/da829f2e07154969ae2db80b58e821ee.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 9]: /images/20220828/b59af4295d39425aa266cb0fe3df72ba.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 10]: /images/20220828/20cdb6ace57b4aaba6d8ba5c229505f8.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 11]: /images/20220828/2f250e56e362408fa92b251bc20e5256.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 12]: /images/20220828/e3c4c2788755407889e8e2663665df10.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 13]: /images/20220828/a1dc5f8d47c94e8fa3d1e4570cc31aa3.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 14]: /images/20220828/c4c1807ec53e4f7f8965cd94f6c38e13.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 15]: /images/20220828/3adac0e525b445e3b8fb6f8f5b53a9a8.png
[7c7cf4ede9f942cd94b7af6bcdb34dc0.png]: /images/20220828/43fb1442e2964aaaa4697032fff76361.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 16]: /images/20220828/9b82d27501c94c93b9e1117aa90f856a.png
[2e56954d351f493097cc407e5dfdbba7.png]: /images/20220828/4edefcd28ebc455bbc3fd74a3174a0bb.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA56iL5bqP5ZGY5qyj5a64_size_20_color_FFFFFF_t_70_g_se_x_16 17]: /images/20220828/c3a66d158a95405e87440e362b45e586.png
[Jaeger]: https://xinchen.blog.csdn.net/article/details/120243299
[Jaeger_java 1]: https://xinchen.blog.csdn.net/article/details/120360141
[Java]: https://xinchen.blog.csdn.net/article/details/105068742
[Spring]: https://xinchen.blog.csdn.net/article/details/105086498
[Docker]: https://xinchen.blog.csdn.net/article/details/105086732
[kubernetes]: https://xinchen.blog.csdn.net/article/details/105086794
[Link 1]: https://xinchen.blog.csdn.net/article/details/105086850
[DevOps]: https://xinchen.blog.csdn.net/article/details/105086920