使用 DTrace pid 提供程序调试 nginx -- nginx中文文档|nginx中文教程

使用 DTrace pid 提供程序调试 nginx

本文假设读者对 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 功能仅提供有限的数量不过，有用的信息。函数参数的实时检查通常更有趣，但也要复杂一些。以下示例旨在帮助读者更加熟悉 DTrace 以及使用 DTrace 分析 nginx 行为的过程。

将 DTrace 与 nginx 一起使用的常见场景之一如下：附加到 nginx 工作进程以记录请求行和请求开始时间。与 attach 对应的函数是，而有问题的参数是指向结构的指针。用于此类请求日志记录的 DTrace 脚本可以像以下作一样简单：ngx_http_process_request()ngx_http_request_t

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 需要一些知识关于结构。遗憾的是，虽然可以在 DTrace 脚本中使用特定指令，然后将其传递给 C 预处理器（带国旗），这真的不起作用。由于交叉依赖很多，几乎所有的 nginx 头文件必须包括在内。反过来，根据脚本设置， nginx 标头将包括 PCRE、 OpenSSL 和各种系统头文件。虽然理论上所有这些头文件都与特定的 nginx 构建相关实际上，可能包含在 DTrace 脚本预处理和编译中 DTrace 脚本很可能会因为中的未知语法而无法编译一些头文件。ngx_http_request_t#include-Cconfigure

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

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

首先，由 configure 应该包括在内，因为它定义了许多常量影响各种的。之后，一些基本类型和定义 like 、、等应放在 DTrace 脚本。这些定义很紧凑，很常用，不太可能经常更改。objs/ngx_auto_config.h#ifdefngx_str_tngx_table_elt_tngx_uint_t

然后是结构包含许多指向其他结构的指针。因为这些指针实际上与此脚本无关，并且因为它们具有相同的大小，则可以只用 void 指针替换它们。与其更改定义，不如添加适当的 typedefs，虽然：ngx_http_request_t

typedef ngx_http_upstream_t     void;
typedef ngx_http_request_body_t void;

最后但并非最不重要的一点是，有必要添加两个杆件结构的定义 (, ), 回调函数的声明和常量的定义。ngx_http_headers_in_tngx_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

另请参阅