怎么在Nginx中利用Log-Format自定义输出访问日志

夜萱姑娘_2202

夜萱姑娘_2202

2026-04-25

765人浏览

原创

log_format 必须在 http 块中定义,server 或 location 块中使用会报错;定义后通过名称在 access_log 中引用,需注意变量大小写、语义区别、缓冲控制及 JSON 转义问题。

怎么在nginx中利用log-format自定义输出访问日志

log_format 指令必须在 http 块里定义

直接写在 server 或 location 块里会报错:unknown directive "log_format"。Nginx 要求所有 log_format 必须位于 http 上下文中,哪怕你只打算在某个 server 里用它。定义后,才能在 access_log 中通过名称引用。

常见错误是把格式定义和日志启用混在一起写,比如在 server 里先写 log_format myfmt ... 再写 access_log /var/log/nginx/my.log myfmt —— 这会导致启动失败。

  • 正确做法:在 http 块顶部或靠近顶部位置统一定义,例如:
    log_format myfmt '$remote_addr - $remote_user [$time_local] "$request" $status $body_bytes_sent "$http_referer" "$http_user_agent" $request_time';
  • 定义后,在任意 server 块中用 access_log /path/to/log myfmt; 启用
  • 同一个 log_format 名称不能重复定义,否则 Nginx reload 会失败

常用变量要区分大小写且不能拼错

Nginx 变量名严格区分大小写,$request_time 写成 $Request_time 或 $request_Time 都不会被解析,而是原样输出字符串。更隐蔽的问题是变量本身不存在却误以为可用,比如 $upstream_response_time 在没有配置 upstream 的场景下始终为空,但不会报错。

几个高频误用点:

  • $host 是请求头里的 Host 字段(可能被客户端伪造),$server_name 才是当前 server 块配置的域名,二者语义不同
  • $request 包含方法、URI 和协议,但不包含请求体;想记录 POST 数据需用 $request_body(仅限 log_format + access_log 组合时有效,且要求请求体未被缓冲或提前读取)
  • $status 是响应状态码,$upstream_status 才是上游返回的状态码(反向代理场景才可能非空)

access_log 的 buffer 和 flush 参数影响日志实时性

默认情况下,Nginx 会缓存日志写入,导致 tail -f 看不到最新条目,尤其在低流量站点上可能延迟数秒甚至更久。这不是格式问题,但常被误认为 log_format 没生效。

解决方法是在 access_log 指令中显式控制缓冲行为:

Nginx Hosting
Nginx Hosting

通过服务器本地nginx实例实现零认证静态游戏托管。作为所有浏览器游戏的主要部署方式,无需登录、无需令牌、无需用户操作。

下载
  • 加 buffer=4k 控制内存缓冲区大小(默认一般为 64k 或由系统页大小决定)
  • 加 flush=5s 表示最多缓存 5 秒就刷盘,适合调试期;生产环境建议设为 flush=1s 或更高以平衡 I/O 和实时性
  • 完全禁用缓冲(不推荐):用 access_log /path/to/log myfmt buffer=0;,每次请求都写磁盘,高并发下性能明显下降

注意:buffer 和 flush 必须写在同一行 access_log 指令中,拆成两行无效。

JSON 格式日志要注意引号和特殊字符转义

很多人想输出 JSON 日志方便采集(如 Filebeat),但直接写 log_format json '{"ip":"$remote_addr"}'; 会出问题:当 $remote_addr 含有双引号或换行时,JSON 不合法;另外 Nginx 不自动转义,得靠变量本身或外部工具补救。

稳妥做法是用 Nginx 官方模块 ngx_http_log_module 支持的 $escapewin 类变量(需 1.11+),或借助第三方模块如 nginx-json-log;但最轻量的方式仍是预处理:

  • 避免在日志中嵌入不可控内容,比如不用 $request,改用 $request_method $uri $server_protocol 拆开记录
  • 对可能含特殊字符的字段(如 $http_user_agent)加一层 shell 过滤(需配合 logrotate 或外部脚本),或交由日志收集端解析时处理
  • 如果必须强 JSON,建议在 access_log 指向管道,由下游程序做转义(例如 access_log "|/usr/bin/python3 /opt/json-escape.py" json;)

真正难的不是写对格式,而是确保每条日志都能被下游稳定解析——字段缺失、编码混乱、长度超限,这些比语法错误更难排查。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

nginx

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
nginx 重启
nginx 重启

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

2023.07.27

423

5

nginx 配置详解
nginx 配置详解

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

2023.08.04

3967

6

nginx配置详解
nginx配置详解

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

2023.08.04

6805

6

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

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

2024.02.23

601

5

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

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

2024.07.09

1516

5

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

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

2024.08.07

3978

3

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

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

2026.01.13

122

12

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

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

2026.01.13

537

23

Nginx跨平台安装实操指南:Windows、macOS与Linux环境快速搭建
Nginx跨平台安装实操指南:Windows、macOS与Linux环境快速搭建

本指南详解Nginx在Windows、macOS及Linux系统的安装全流程。涵盖官方包解压、Homebrew一键部署、APT/YUM源配置及Docker容器化方案。无论新手或开发者,均可快速搭建运行环境,掌握跨平台核心指令,为后续配置与调优奠定坚实基础。

2026.03.16

179

12

热门下载

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

精品课程

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

共0课时 | 0人学习

nginx手册
nginx手册

共0课时 | 0人学习

进程与SOCKET
进程与SOCKET

共6课时 | 0.5万人学习