Nginx 中 log_format 变量如何从 Header 中提取自定义字段

浅杰大大_1557

浅杰大大_1557

2026-07-13

402人浏览

原创

nginx 通过 $http_ 和 $senthttp 变量间接访问请求与响应 header 字段,字段名自动转为小写加下划线;空值需用 map 指令设默认值;不支持解析嵌套 json 或含非法字符的 header。

nginx 中 log_format 变量如何从 header 中提取自定义字段

Nginx 的 log_format 本身不支持直接从请求或响应 Header 中“提取”任意自定义字段(比如 X-Request-ID 或 User-ID),但它可以通过内置变量 $http_* 和 $sent_http_* 间接访问 Header 内容 —— 前提是字段名符合命名规范且已存在。

使用 $http_XXX 获取请求 Header 字段

Nginx 会自动将请求头(Request Headers)中带连字符(-)的字段,转换为下划线(_)并加前缀 $http_,形成可引用的变量:

  • X-Request-ID → $http_x_request_id
  • User-Agent → $http_user_agent
  • Content-Type → $http_content_type
  • My-Custom-Header → $http_my_custom_header

注意:字段名不区分大小写,Nginx 统一转为小写 + 下划线。若 Header 不存在,该变量值为空字符串(不是 -),可在日志中体现为留空。

Nginx Hosting
Nginx Hosting

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

下载

使用 $sent_http_XXX 获取响应 Header 字段

同理,Nginx 提供 $sent_http_* 变量用于记录响应头(Response Headers)—— 但仅限于已被 Nginx 设置或透传的响应头(如后端返回的 X-App-Version):

  • 确保后端服务确实返回了该 Header(如 X-Trace-ID)
  • Nginx 默认不修改或过滤响应头,只要未被 proxy_hide_header 等指令屏蔽,就能通过 $sent_http_x_trace_id 访问
  • 该变量在日志中记录的是响应发出时的值,适用于调试后端行为

处理缺失/空值与默认值

直接使用 $http_x_request_id 在日志中可能留空,影响分析。可通过 map 指令提供默认值或做条件映射:

map $http_x_request_id $log_request_id {
    ""      "-";           # 空值转为 "-"
    default $http_x_request_id;
}

然后在 log_format 中引用 $log_request_id:

log_format main '$remote_addr - $remote_user [$time_local] '
                 '"$request" $status $body_bytes_sent '
                 '"$http_referer" "$http_user_agent" '
                 '$log_request_id;'

限制与注意事项

  • Header 名必须由字母、数字、连字符组成;含非法字符(如点号 .、冒号 :)无法映射
  • $http_* 仅读取请求头,不支持解析嵌套结构(如 JSON 字符串中的字段)
  • 若需从 Header 解析子字段(例如从 X-User-Data: {"id":123} 提取 id),Nginx 原生不支持,需借助 Lua(OpenResty)或前置服务预处理
  • 变量名区分大小写:写成 $http_X_Request_ID 无效,必须全小写下划线形式

相关文章

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

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

下载

相关标签:

nginx nginx log_format

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

相关专题

更多
nginx 重启
nginx 重启

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

2023.07.27

403

5

nginx 配置详解
nginx 配置详解

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

2023.08.04

3467

6

nginx配置详解
nginx配置详解

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

2023.08.04

6185

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

3958

3

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

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

2026.01.13

122

12

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

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

2026.01.13

477

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万人学习