Debugging nginx with DTrace pid provider

使用DTrace pid提供程序调试nginx

本文假设读者对nginx内部有一般了解并了解DTrace。

虽然使用--with-debug选项构建的nginx已经提供了关于请求处理的大量信息，但有时候希望更彻底地跟踪代码路径的特定部分，并且同时省略其余的调试输出。 DTrace pid提供程序（在Solaris，macOS上可用）是探索用户程序内部的有用工具，因为它不需要任何代码更改，并且可以帮助完成任务。一个简单的DTrace脚本用于跟踪和打印nginx函数调用可能是这样的：

#pragma D option flowindent

pid$target:nginx::entry {
}

pid$target:nginx::return {
}

虽然函数调用跟踪的DTrace功能提供了有限的有用信息，但实时检查函数参数通常更有趣，但也稍微复杂一些。下面的示例旨在帮助读者更熟悉DTrace和使用DTrace分析nginx行为的过程。

使用DTrace与nginx一起的常见情景之一是：附加到nginx工作进程以记录请求行和请求开始时间。要附加的相应函数是ngx_http_process_request()，问题中的参数是指向ngx_http_request_t结构的指针。用于此请求日志记录的DTrace脚本可能如下所示：

pid$target::*ngx_http_process_request:entry
{
    this->request = (ngx_http_request_t *)copyin(arg0, sizeof(ngx_http_request_t));
    this->request_line = stringof(copyin((uintptr_t)this->request->request_line.data,
                                         this->request->request_line.len));
    printf("request line = %s\n", this->request_line);
    printf("request start sec = %d\n", this->request->start_sec);
}

应该注意，在上面的示例中，DTrace需要一些关于ngx_http_request_t结构的知识。不幸的是，虽然可以在DTrace脚本中使用特定的#include指令，然后将其传递给C预处理器（使用-C标志），但实际上并不起作用。由于存在许多交叉依赖，几乎所有nginx头文件都必须包含。依据configure脚本设置，nginx头文件将包括PCRE，OpenSSL和各种系统头文件。虽然理论上所有这些与特定nginx构建相关的头文件可能都包含在DTrace脚本的预处理和编译中，但实际上，由于一些头文件中的未知语法，DTrace脚本很可能无法编译。

上述问题可以通过在DTrace脚本中仅包含相关且必要的结构和类型定义来解决。 DTrace必须知道结构、类型和字段偏移的大小。因此，通过手动优化结构定义，可以进一步减少依赖关系。

让我们使用上面的DTrace脚本示例，并查看它需要哪些结构定义才能正常工作。

首先应该包含由configure生成的objs/ngx_auto_config.h文件，因为它定义了影响各种#ifdef的常量。之后，在DTrace脚本的开头应该放置一些基本类型和定义，如ngx_str_t，ngx_table_elt_t，ngx_uint_t等。这些定义是紧凑的，通常使用且不太可能经常更改。

然后是包含许多指向其他结构的指针的ngx_http_request_t结构。因为这些指针对于此脚本真的不相关，并且因为它们具有相同的大小，所以可以将它们替换为void指针。虽然更改定义是可能的，但最好添加适当的typedef：

typedef ngx_http_upstream_t     void;
typedef ngx_http_request_body_t void;

最后但并非最不重要的是需要添加两个成员结构的定义（ngx_http_headers_in_t，ngx_http_headers_out_t），回调函数的声明和常量的定义。

最终的DTrace脚本可以从这里下载。

下面的示例显示了运行此脚本的输出：

# dtrace -C -I ./objs -s trace_process_request.d -p 4848
dtrace: script 'trace_process_request.d' matched 1 probe
CPU     ID                    FUNCTION:NAME
  1      4 .XAbmO.ngx_http_process_request:entry request line = GET / HTTP/1.1
request start sec = 1349162898

  0      4 .XAbmO.ngx_http_process_request:entry request line = GET /en/docs/nginx_dtrace_pid_provider.html HTTP/1.1
request start sec = 1349162899

使用类似的技术，读者应该能够跟踪其他nginx函数调用。

使用DTrace pid提供程序调试nginx

另请参阅