调试 Nginx 的配置

调试 Nginx 的配置

标签(空格分隔): Nginx 调试 Debuging 配置


注:该文原文是 Debugging Nginx Configuration

默认,Nginx 仅仅记录标准错误日志到 Nginx 默认的 error 文件中,或是被 error_log 指令指定的文件中。

我们可以控制许多方面的错误日志,这将帮助我们调试我们 Nginx 配置文件。

重要:对于 Nginx 配置文件的任何改变,你都必须测试和重载 Nginx 的配置文件来让变更生效。在 Ubuntu 系统,你可以简单的运行 nginx -t && service nginx reload 命令。

在我们继续进行之前

在你复制粘贴任何 Nginx 配置之前,确保你移除了你不想要的代码。并且,每次你升级 Nginx,也请使用最新版 Nginx 提供的更新你的配置文件。

在我们开始之前,请详细阅读这些官方文章:通常的 Nginx 陷阱if 是恶魔location 指令Nginx 请求过程。你可能会单独使用它们来解决你的问题。

注:5 星推荐上面的几篇官方文章。

好吧,看起来你需要一些严谨的调试,让我们开始!

仅仅调试 rewrite 规则

大部分时间,你仅仅需要这个,特别是当你看见 404 或是不是期望的页面的时候。

server {
        #other config
        error_log    /var/logs/nginx/example.com.error.log;
        rewrite_log on;
        #other config
}

rewrite_log 仅仅是一个标志。当打开它,它将发送所有的 rewrite 相关的日志信息到 error_log 文件中,使用 [notice] 级别。

因此,一旦你打开了它,在 error_log 中查看日志信息。

设置 Nginx 日志的调试级别

下面的示例增加了 debug 级别,记录在指定的路径。

server {
        #other config
        error_log    /var/logs/nginx/example.com.error.log debug;
        #other config
}

debug 将记录最大的消息。你可以在这里看到其他值

注意:在一个高流量的网站,不要忘记恢复 error_log 日志的调试级别,error_log 可能会吃光你所有的可用磁盘空间,并引起服务器 crash。

设置 Nginx 仅仅记录来自于你的 IP 的错误

当你设置日志级别成 debug,如果你在调试一个在线的高流量网站的话,你的错误日志可能会记录每个请求的很多消息,这样会变得毫无意义。

为了促使 Nginx 记录仅仅来自于你的 IP 的错误日志,添加以下行到配置文件 /etc/nginx/nginx.confevents{..}

确保使用你自己的公网 IP 替换 1.2.3.4,你可以在这里找到你的公网 IP

events {
        debug_connection 1.2.3.4;
}

你可以在这里查看更多的细节

Nginx 的 Location 指定错误日志

在 Nginx 中,我们使用 location{..}

为了调试一个应用的部分,你可以在一个或多个 location{..} 中指定 error_log 指令。

server {
        #other config
        error_log    /var/logs/nginx/example.com.error.log;
        location /admin/ { 
        error_log /var/logs/nginx/admin-error.log debug; 
    }         
    #other config
}

以上将仅仅调试你应用的 /admin/ 部分,错误日志将被记录到一个不同的文件中。

你可以组合使用 debug_connectionerror_log 来获取更多的控制调试日志。

使用 Nginx 的 HttpEchoModule 模块调试

HttpEchoModule 是一个独立的 Nginx 模块,它可以帮助你完全以不同的方式调试。这个模块默认没有被 Nginx 绑定。

你需要重新编译 Nginx 来使用这个模块。对于 Ubuntu 用户,这是一个快速启动仓库

我最近在使用它,我还用它来调试项目。当我做完的时候,我将写一篇文章详细讲述。

为 Nginx 的配置使用 Perl/Lua 语言

如果你仍然有困难的时间,并且你定期配置你的 Nginx,应该考虑使用其他语言来处理你的 Nginx 配置。

这里有关于 Perl 语言Lua 语言的 Nginx 模块。

我非常不善于学习新的语言,不会有太多的机会写更多关于这方面的东西,但是如果你知道或是可以非常容易学习 Perl/Lua,这会非常有趣。

扩展阅读

  • How Nginx’s location-if works!
  • Maintaining, Optimizing & Debugging WordPress-Nginx Setup
阅读 15.8k

推荐阅读
yexiaoxiaobai
用户专栏

刀锋上的跳舞的 SRE,喜爱 Perl, Python, Go,常被正则婊戏耍,热衷于鼓捣一些小玩具。

128 人关注
151 篇文章
专栏主页