使用 DTrace pid 提供程序调试 nginx
本文假定 Reader 具有 nginx 内部知识和DTrace的一般知识。
尽管使用--with-debug选项构建的 nginx 已经提供了大量有关请求处理的信息，但有时还是希望更彻底地跟踪代码路径的特定部分，同时省略其余的调试输出。 DTrace pid 提供程序(可在 Solaris 和 macOS 上使用)是一种有用的工具，可用于探索 Userland 程序的内部，因为它不需要任何代码更改，并且可以帮助完成任务。一个简单的 DTrace 脚本可以跟踪和打印 nginx 函数调用，如下所示：
#pragma D option flowindent
pid$target:nginx::entry {
}
pid$target:nginx::return {
}
但是，用于函数调用跟踪的 DTrace 功能仅提供有限的有用信息。函数参数的实时检查通常更有趣，但也有些复杂。以下示例旨在帮助 Reader 更加熟悉 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_process_request结构的知识。不幸的是，虽然可以在 DTrace 脚本中使用特定的#include指令，然后将其传递给 C 预处理程序(带有-C标志)，但这实际上是行不通的。由于存在很多交叉依赖性，因此几乎必须包含所有的 Nginx 头文件。反过来，基于configure脚本设置，nginxHeaders 将包括 PCRE，OpenSSL 和各种系统 Headers 文件。理论上，所有与特定 nginx 构建相关的头文件都可能包含在 DTrace 脚本的预处理和编译中，但实际上，由于某些头文件中的语法未知，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_process_request_t结构，其中包含许多指向其他结构的指针。因为这些指针确实与该脚本无关，并且它们的大小相同，所以可以将它们替换为空指针。不过，最好是添加适当的 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 脚本可以从here下载。
以下示例显示了运行此脚本的输出：
# 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
使用类似的技术，Reader 应该能够跟踪其他 nginx 函数调用。
