Nginx 自定义日志格式怎么使用 log_format 定义变量组合

风浩君_3221

风浩君_3221

2026-10-01

934人浏览

原创

nginx通过log_format在http块中定义日志格式别名,用access_log启用;支持内置变量拼接、转义符和双引号,需重载生效,$upstream_*变量仅在反向代理时有效。

nginx 自定义日志格式怎么使用 log_format 定义变量组合

Nginx 使用 log_format 指令定义日志格式,核心是把内置变量按需组合成字符串,再通过 access_log 指令启用。关键不是“自定义变量”,而是灵活选用和拼接已有变量。

log_format 基本语法与作用域

log_format 必须放在 http 块中(不能在 server 或 location 内直接定义),它只是声明一种格式别名,不生效;真正写日志靠 access_log 引用该别名。

  • 格式名不能含空格或特殊符号,如 main、json_log、with_upstream
  • 日志内容是纯字符串,变量用 $ 开头,如 $remote_addr、$request_time
  • 支持普通文本、转义符(如 \t、\n)、双引号包裹的字符串(便于含空格)

常用内置变量组合示例

以下是一些高频、实用的组合方式,可直接复制调整:

Nginx Config Linter
Nginx Config Linter

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

下载
  • 带响应时间与上游信息的标准扩展格式:
    log_format extended '$remote_addr - $remote_user [$time_local] "$request" $status $body_bytes_sent "$http_referer" "$http_user_agent" $request_time $upstream_response_time $upstream_addr';
  • 类 JSON 格式(便于日志采集):
    log_format json '{"@timestamp":"$time_iso8601","remote_addr":"$remote_addr","request":"$request","status":$status,"bytes_sent":$body_bytes_sent,"request_time":$request_time,"upstream_time":"$upstream_response_time"}';
    注意:JSON 中字符串值需加引号,数字不用;$upstream_response_time 可能为空,输出为“-”,若需统一可配合 map 过滤
  • 仅记录 API 接口耗时与状态(精简调试用):
    log_format api '$time_iso8601 | $request_method $uri | $status | $request_time s | $upstream_response_time s';

如何让自定义格式生效

定义完 log_format 后,必须在 http、server 或 location 块中用 access_log 启用:

  • 全局启用:access_log /var/log/nginx/access.log extended;
  • 某虚拟主机单独启用:server { ... access_log /var/log/nginx/app.log json; }
  • 关闭某个 location 的日志:access_log off;
  • 多个日志文件可同时启用:access_log /var/log/nginx/access.log main; access_log /var/log/nginx/json.log json;

注意事项与常见问题

实际使用中容易踩坑的地方:

  • $upstream_* 类变量(如 $upstream_response_time)只在配置了 proxy_pass 等反向代理指令的上下文中才有值,静态文件服务时为“-”
  • 变量值含空格或特殊字符(如 $http_user_agent)时,建议用双引号包裹,避免日志解析错位
  • 修改 log_format 后,需重载 Nginx(nginx -s reload)才生效,无需重启
  • 不支持在 log_format 中调用函数或做条件判断;如需逻辑处理(例如隐藏敏感 IP),应使用 map 指令预生成新变量

相关文章

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

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

下载

相关标签:

nginx

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

相关专题

更多
nginx 重启
nginx 重启

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

2023.07.27

383

5

nginx 配置详解
nginx 配置详解

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

2023.08.04

3167

6

nginx配置详解
nginx配置详解

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

2023.08.04

5805

6

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

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

2024.02.23

561

5

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

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

2024.07.09

1476

5

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

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

2024.08.07

3918

3

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

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

2026.01.13

122

12

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

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

2026.01.13

417

23

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

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

2026.03.16

159

12

热门下载

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

精品课程

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

共0课时 | 0人学习

nginx手册
nginx手册

共0课时 | 0人学习

进程与SOCKET
进程与SOCKET

共6课时 | 0.5万人学习