讲师中心 微信公众号
AI工具推荐 视频效率加速

Nginx 怎么使用 Lua 脚本在日志阶段记录详细的调试信息

小浩酱_1938

小浩酱_1938

发布时间:2026-09-08 06:41:37

|

788人浏览过

|

来源于php中文网

原创

<p>Nginx 日志阶段不支持直接执行 Lua,需用 log_by_lua* 在日志生成前设置变量,再通过 log_format 引用;变量须合法命名、注意作用域与非阻塞限制,并可结合条件与脱敏提升实用性。</p>

nginx 怎么使用 lua 脚本在日志阶段记录详细的调试信息

Nginx 本身不支持在 log_phase(日志阶段)直接执行 Lua 脚本,ngx_lua 模块的 log_by_lua* 指令**确实运行在日志写入前的最后阶段**,但它属于“日志生成阶段”,而非 Nginx 内置的日志格式化与落盘阶段。因此,想在日志中记录详细调试信息,核心方式是:利用 log_by_lua* 设置变量或构造日志字段,再通过 log_format 引用这些变量。

1. 启用 log_by_lua* 并准备调试数据

确保已编译安装了 ngx_http_lua_module(如 OpenResty),并在配置中启用:

  • 在 http 或 server 块中使用 log_by_lua_block 或 log_by_lua_file
  • 在其中访问请求上下文(ngx.var、ngx.ctx、ngx.req.get_headers() 等)收集调试信息
  • 将关键信息存入自定义变量(如 ngx.var.log_debug_info),供日志格式引用

示例:

log_by_lua_block {
    local headers = ngx.req.get_headers()
    local debug_info = string.format("status=%d, upstream=%s, rt=%.3f, ua=%q",
        ngx.status,
        ngx.var.upstream_addr or "-",
        tonumber(ngx.var.request_time) or 0,
        headers["user-agent"] and headers["user-agent"]:sub(1, 64) or "-"
    )
    ngx.var.log_debug_info = debug_info
}

2. 自定义 log_format 引用 Lua 设置的变量

log_format 必须定义在 http 块,并且变量名需与 ngx.var.xxx 中设置的完全一致:

Nginx Config Linter
Nginx Config Linter

对 Nginx 配置文件进行语法检查、验证和安全、性能审计。

下载
  • 变量必须是合法的 Nginx 变量名(仅含字母、数字、下划线,不能以数字开头)
  • 若变量未被 Lua 设置,Nginx 默认输出空字符串或“-”,不会报错
  • 建议用 $log_debug_info 这类明确语义的名称,避免和内置变量冲突

示例:

log_format detailed '$remote_addr - $remote_user [$time_local] '
                   '"$request" $status $body_bytes_sent '
                   '"$http_referer" "$http_user_agent" '
                   'rt=$request_time uct="$upstream_connect_time" '
                   'uht="$upstream_header_time" urt="$upstream_response_time" '
                   'debug="$log_debug_info"';

3. 注意变量作用域与时机限制

log_by_lua* 是日志阶段唯一可执行 Lua 的入口,但有重要约束:

  • 不能调用阻塞函数(如 ngx.sleep、ngx.socket.tcp()),否则会阻塞日志写入
  • 无法修改响应体或状态码(此时响应已发出,只读上下文)
  • ngx.ctx 在 log 阶段仍可用,适合传递 earlier phase(如 rewrite/access)中收集的数据
  • 若需记录上游响应头或体,需在 header_filter_by_lua* 或 body_filter_by_lua* 中缓存到 ngx.ctx,再在 log_by_lua* 中读取

4. 实用技巧:结构化调试字段 + 条件记录

为避免日志膨胀,可结合 map 或条件逻辑控制调试信息粒度:

  • 用 map 定义开关变量(如 $debug_mode),根据 header、IP 或参数动态启用
  • 在 log_by_lua_block 中判断 ngx.var.debug_mode == "1" 再拼接详细字段
  • 对敏感字段(如 Authorization、Cookie)做脱敏处理,例如 string.gsub(val, "%S+", "xxx")
  • 用 ngx.escape_uri 或 string.format("%q") 避免日志格式被特殊字符破坏

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

相关专题

更多
nginx 重启
nginx 重启

nginx重启对于网站的运维来说是非常重要的,根据不同的需求,可以选择简单重启、平滑重启或定时重启等方式。本专题为大家提供nginx重启的相关的文章、下载、课程内容,供大家免费下载体验。

383

2023.07.27

nginx 配置详解
nginx 配置详解

Nginx的配置是指设置和调整Nginx服务器的行为和功能的过程。通过配置文件,可以定义虚拟主机、HTTP请求处理、反向代理、缓存和负载均衡等功能。Nginx的配置语法简洁而强大,允许管理员根据自己的需要进行灵活的调整。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3267

2023.08.04

nginx配置详解
nginx配置详解

NGINX与其他服务类似,因为它具有以特定格式编写的基于文本的配置文件。本专题为大家提供nginx配置相关的文章,大家可以免费学习。

5925

2023.08.04

tomcat和nginx有哪些区别
tomcat和nginx有哪些区别

tomcat和nginx的区别:1、应用领域;2、性能;3、功能;4、配置;5、安全性;6、扩展性;7、部署复杂性;8、社区支持;9、成本;10、日志管理。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

561

2024.02.23

nginx报404怎么解决
nginx报404怎么解决

当访问 nginx 网页服务器时遇到 404 错误,表明服务器无法找到请求资源,可以通过以下步骤解决:1. 检查文件是否存在且路径正确;2. 检查文件权限并更改为 644 或 755;3. 检查 nginx 配置,确保根目录设置正确、没有冲突配置等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1476

2024.07.09

Nginx报404错误解决方法
Nginx报404错误解决方法

解决方法:只需要加上这段配置:try_files $uri $uri/ /index.html;即可。想了解更多Nginx的相关内容,可以阅读本专题下面的文章。

3938

2024.08.07

nginx部署php项目教程汇总
nginx部署php项目教程汇总

本专题整合了nginx部署php项目教程汇总,阅读专题下面的文章了解更多详细内容。

122

2026.01.13

nginx配置文件详细教程
nginx配置文件详细教程

本专题整合了nginx配置文件相关教程详细汇总,阅读专题下面的文章了解更多详细内容。

437

2026.01.13

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

80

2026.09.30

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
phpEnv手册
phpEnv手册

共0课时 | 0人学习

nginx手册
nginx手册

共0课时 | 0人学习

进程与SOCKET
进程与SOCKET

共6课时 | 0.5万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn