如何让你的Nginx支持分布式追踪详解

目录

Background源码构建nginx-opentracing

准备nginx-opentracing准备jaeger-client-cpp编译gcc编译cmake编译jaeger-client-cpp编译nginx



配置nginx


准备jaeger-client的配置在nginx中开启opentracing



总结

Background

NGINX 是一个通用且流行的应用程序。也是最流行的 Web 服务器，它可用于提供静态文件内容，但也通常与其他服务一起用作分布式系统中的组件，在其中它用作反向X、负载均衡 或 API 网关。

分布式追踪 distributed tracing 是一种可用于分析与监控应用程序的机制，将追踪在从源到目的的整个过程中的单个请求，这与仅通过单个应用程序域来追踪请求的形式不同。

换句话说，我们可以说分布式追踪是对跨多个系统的多个请求的拼接。拼接通常由一个或多个相关 ID 完成，并且跟踪通常是一组记录的、跨所有系统的结构化日志事件，存储在一个中心位置。

在这种背景的情况下， OpenTracing 应运而生。OpenTracing  是一个与应用供应商无关的 API，它可帮助开发人员轻松地跟踪单一请求的域。目前有多种开源产品都支持 OpenTracing（例如，Jaeger, skywalking 等），并将其作为一种检测分布式追踪的标准化方法。

本文将围绕，从0到1实现在nginx配置分布式追踪的架构的简单实例说明。本文实例使用的组件为

nginx-1.22jaeger-all-in-on v1.38nginx-opentracing v1.22jaeger-client-cpp v0.9

源码构建nginx-opentracing

准备nginx-opentracing

nginx-opentracing 仓库中可以看到，官方为每个nginx版本都提供了一个编译好的动态库（Nginx1.19.13+），我们可以直接拿来使用这个动态库，如果你想将这个利用Nginx 提供的编译参数 –add-module=/path/to/module 构建为nginx的内置功能的话，可能会出现一些问题，例如下面的一些错误：

1. ngx_http_opentracing_module.so/config was found

复制代码

1.         /root/nginx-opentracing-0.25.0/opentracing//src/ngx_http_opentracing_module.cpp
2. In file included from /root/nginx-opentracing-0.25.0/opentracing//src/ngx_http_opentracing_module.cpp:1:0:
3. /root/nginx-opentracing-0.25.0/opentracing//src/load_tracer.h:3:38: fatal error: opentracing/dynamic_load.h: No such file or directory

复制代码 根据 issue 中查询得知 nginx-opentracing 需要嵌入到nginx中，是需要一些 opentracing-cpp 因为对c++不熟，尝试调试很久还是上面的错误，故直接使用了官方提供的动态库。

准备jaeger-client-cpp

根据 nginx-opentracing 中提到的，还需要一个 jaeger-client-cpp 的 tracer 才可以正常运行（这也是作为jaeger架构中的角色）

来到 jaeger-client-cpp 看到Release提供的编译好的动态库已经很久了，而最新版都没有提供相应编译的版本，需要我们自己编译

说明： 编译依赖CMake 3.3+，gcc 4.9.2+

我们的编译环境使用CentOS 7 默认gcc与CMake都符合要求需要自行编译两个的版本。

编译gcc

gcc下载地址：https://ftp.gnu.org/gnu/gcc/

1. cd gcc-5.4.0
2. ./contrib/download_prerequisites
4. mkdir gcc-build-5.4.0
5. cd gcc-build-5.4.0
7. /usr/local/src/gcc-5.4.0/configure \
8.         –enable-checking=release \
9.         –enable-languages=c,c++ \
10.         –disable-multilib
12. make && make install

复制代码 引用处理 refer 1

1. cd /usr/bin/
2. mv gcc gcc_back
3. mv g++ g++_back
4. ln -s /usr/local/bin/gcc gcc
5. ln -s /usr/local/bin/g++ g++

复制代码 编译时遇到几个问题

/lib64/libstdc++.so.6: version GLIBCXX_3.4.20′ not found

gcc 编译，libgcc动态库有改动，恢复原状即可

1. configure: error: C++ compiler missing or inoperational
3. make[2]: \*** [configure-stage1-libcpp] Error 1   
4. make[2]: Leaving directory `/home/clay/programming/C++/gcc-4.8.1′   
5. make[1]: \*** [stage1-bubble] Error 2   
6. make[1]: Leaving directory `/home/clay/programming/C++/gcc-4.8.1′   
7. make: \*** [all] Error 2

复制代码
编译cmake

1. ./configure –prefix=/path/to/APP
3. make
4. make install

复制代码 这里遇到一个小问题 编译过程中遇到 [libstdc++.so.6: version GLIBCXX_3.4.20 not found

因为这里使用了自己编译的gcc版本，需要指定下动态库的路径 refer 2

1. LD_LIBRARY_PATH=/usr/local/lib64 ./configure –prefix=/usr/local/cmake

复制代码
编译jaeger-client-cpp

这里根据官方提供的步骤操作即可

1. cd jaeger-client-cpp-0.9.0/
2. mkdir build
3. cd build
4. # 这里建议使用下强国特色上网，编译过程中会使用Hunter自动下载所需的依赖项
5. ALL_PROXY=http://x.0.0.x:10811 /usr/local/cmake/bin/cmake ..
6. make

复制代码 注：依赖项挺大的，下载时间可能很长，会hang主，只需等待结束即可

​编译完成后 libjaegertracing.so.0.9.0 则是我们需要的

编译nginx

1. ./configure \
2.         –user=web_www \
3.         –group=web_www \
4.         –with-pcre \
5.         –with-compat \
6.         –with-http_ssl_module  \
7.         –with-http_gzip_static_module \
8.         –prefix=/root/nginx  \
9.         –with-http_stub_status_module

复制代码 –with-compat 必须加上，表面允许使用动态库，否则编译完在启动时会报下面的错误

1. nginx: [emerg] module “/root/nginx/conf/ngx_http_opentracing_module.so” is not binary compatible in /root/nginx/conf/nginx.conf:1

复制代码 遇到的问题，cc nou found，这里只需将 gcc 软连接一份为 cc 即可

配置nginx

准备jaeger-client的配置

jaeger.json

1. {
2.   “service_name”: “nginx”, // 服务名
3.   “sampler”: {
4.     “type”: “const”,
5.     “param”: 1
6.   },
7.   “reporter”: {
8.     “localAgentHostPort”: “jaeger:6831” // jaeger agent的地址
9.   },
10.   “headers”: { // jaeger的默认的jaeger Baggage头设置
11.     “jaegerDebugHeader”: “jaeger-debug-id”,
12.     “jaegerBaggageHeader”: “jaeger-baggage”,
13.     “traceBaggageHeaderPrefix”: “uberctx-“
14.   },
15.   “baggage_restrictions”: {
16.     “denyBaggageOnInitializationFailure”: false,
17.     “hostPort”: “”
18.   }
19. }

复制代码
在nginx中开启opentracing

1. # 加载 OpenTracing 动态模块。
2. load_module conf/ngx_http_opentracing_module.so;
3. worker_processes  1;
4. user root root;
6. events {
7.     worker_connections  1024;
8. }
9. http {
10.     log_format opentracing ‘{“timestamp”:”$time_iso8601″,’
11.                        ‘”source”:”$server_addr”,’
12.                        ‘”hostname”:”$hostname”,’
13.                        ‘”ip”:”$http_x_forwarded_for”,’
14.                        ‘”traceID”:”$opentracing_context_uber_trace_id”,’
15.                        ‘”client”:”$remote_addr”,’
16.                        ‘”request_method”:”$request_method”,’
17.                        ‘”scheme”:”$scheme”,’
18.                        ‘”domain”:”$server_name”,’
19.                        ‘”referer”:”$http_referer”,’
20.                        ‘”request”:”$request_uri”,’
21.                        ‘”args”:”$args”,’
22.                        ‘”size”:$body_bytes_sent,’
23.                        ‘”status”: $status,’
24.                        ‘”responsetime”:$request_time,’
25.                        ‘”upstreamtime”:”$upstream_response_time”,’
26.                        ‘”upstreamaddr”:”$upstream_addr”,’
27.                        ‘”http_user_agent”:”$http_user_agent”,’
28.                        ‘”https”:”$https”‘
29.                        ‘}’;
30.         # 加载 tracer，这里使用的jaeger，需要传递配置文件
31.     opentracing_load_tracer conf/libjaegertracing.so conf/jaeger.json;
32.     # 启用 tracing
33.     opentracing on;
34.     # 设置tag，可选参数
35.     opentracing_tag http_user_agent $http_user_agent;
36.     include       mime.types;
37.     default_type  application/octet-stream;
38.     sendfile        on;
39.     keepalive_timeout  65;
40.     server {
41.         listen       80;
42.         server_name  localhost;
43.         location / {
44.             opentracing_operation_name $uri;
45.             opentracing_propagate_context;
46.             root   html;
47.             index  index.html index.htm;
48.         }
49.         access_log logs/access.log opentracing;
50.         error_page   500 502 503 504  /50x.html;
51.         location = /50x.html {
52.             root   html;
53.         }
54.     }
55. }

复制代码

注：这里使用的 opentracing-nginx 的动态库为 ot16 ，linux-amd64-nginx-1.22.0-ot16-ngx_http_module.so.tgz ，另外一个版本不兼容，-t 检查语法时会提示

此时我们可以在jaeger上查看，可以看到 NGINX 的 span（因为这里只配置了NGINX，没有配置更多的后端）。

Reference

1 CentOS7 升级 GCC 到 5.4.0 版本

2 libstdc++.so.6: version GLIBCXX_3.4.20 not found

3 nginx load_module

总结

到此这篇关于如何让你的Nginx支持分布式追踪的文章就介绍到这了,更多相关Nginx支持分布式追踪内容请搜索软件技术网以前的文章或继续浏览下面的相关文章希望大家以后多多支持软件技术网！