使用 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 的结构定义来进一步减少依赖关系。

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

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

然后是ngx_http_request_t结构，它包含许多指向其他结构的指针。由于这些指针与该脚本实际上无关，并且它们具有相同的大小，因此可以仅将它们替换为空指针。不过，最好添加适当的类型定义，而不是更改定义

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

另请参阅