# nginx内置变量、自定义变量与查看方法

nginx内置变量、自定义变量与查看方法

1 nginx内置变量

内置变量存放在 ngx_http_core_module 模块中，变量的命名方式和apache 服务器变量是一致的。总而言之，这些变量代表着客户端请求头的内容。下面是nginx支持的所有内置变量：

# scheme
$scheme               # 请求使用的Web协议, “http” 或 “https”
$https                # 如果开启了SSL安全模式，值为“on”，否则为空字符串。


# host
$host                 # 优先级如下：HTTP请求行的主机名>”HOST”请求头字段>符合请求的服务器名
$hostname             # 主机名
$server_name          # 服务器名，www.cnphp.info
$server_addr          # 服务器端地址，需要注意的是：为了避免访问linux系统内核，应将ip地址提前设置在配置文件中。


# uri
$uri                  # 请求中的当前URI(不带请求参数，参数位于$args)，可以不同于浏览器传递的$request_uri的值，它可以通过内部重定向，或者使用index指令进行修改，$uri不包含主机名，如”/foo/bar.html”。
$document_uri         # 同 $uri
$request_uri          # 这个变量等于包含一些客户端请求参数的原始URI，它无法修改，请查看$uri更改或重写URI，不包含主机名，例如：”/cnphp/test.php?arg=freemouse”。
$request              # 代表客户端的请求地址


# arg
$arg_name             # 请求中的的参数名，即“?”后面的arg_name=arg_value形式的arg_name
$args                 # 请求中的参数值
$query_string         # 同 $args
$is_args              # 如果请求中有参数，值为“?”，否则为空字符串。


# root
$document_root        # 当前请求的文档根目录或别名
$realpath_root        # 当前请求的文档根目录或别名的真实路径，会将所有符号连接转换为真实路径。


# header
$http_NAME            # 匹配任意请求头字段； 变量名中的后半部分“name”可以替换成任意请求头字段，如在配置文件中需要获取http请求头：“Accept-Language”，那么将“－”替换为下划线，大写字母替换为小写，形如：$http_accept_language即可。

$sent_http_NAME       # 可以设置任意http响应头字段； 变量名中的后半部分“name”可以替换成任意响应头字段，如需要设置响应头Content-length，那么将“－”替换为下划线，大写字母替换为小写，形如：$sent_http_content_length 4096即可。
$sent_http_cache_control
$sent_http_connection
$sent_http_content_type
$sent_http_keep_alive
$sent_http_last_modified
$sent_http_location
$sent_http_transfer_encoding

$content_length       # “Content-Length” 请求头字段
$content_type         # “Content-Type” 请求头字段

$http_referer         # referer
$http_user_agent      # 浏览器
$cookie_NAME          # 客户端请求Header头中的cookie变量，前缀"$cookie_"加上cookie名称的变量，该变量的值即为cookie名称的值
$http_cookie          # cookie信息


# request
$request_filename     # 当前连接请求的文件路径，由root或alias指令与URI请求生成。
$request_method       # HTTP请求方法，通常为“GET”或“POST”
$request_length       # 请求的长度 (包括请求的地址, http请求头和请求主体) (1.3.12, 1.2.7)
$request_time         # 处理客户端请求使用的时间 (1.3.9, 1.2.6); 从读取客户端的第一个字节开始计时。
$request_completion   # 如果请求成功，值为”OK”，如果请求未完成或者请求不是一个范围请求的最后一部分，则为空。
$request_body         # 客户端的请求主体。变量可在location中使用，将请求主体通过proxy_pass, fastcgi_pass, uwsgi_pass, 和 scgi_pass传递给下一级的代理服务器。
$request_body_file    # 将客户端请求主体保存在临时文件中。文件处理结束后，此文件需删除。如果需要之一开启此功能，需要设置client_body_in_file_only。如果将次文件传递给后端的代理服务器，需要禁用request body，即设置proxy_pass_request_body off，fastcgi_pass_request_body off, uwsgi_pass_request_body off, or scgi_pass_request_body off 。


# server
$msec                 # 当前的Unix时间戳 (1.3.9, 1.2.6)
$time_iso8601         # 服务器时间的ISO 8610格式 (1.3.12, 1.2.7)
$time_local           # 服务器时间（LOG Format 格式） (1.3.12, 1.2.7)

$connection           # TCP连接的序列号 (1.3.8, 1.2.5)
$connection_requests  # TCP连接当前的请求数量 (1.3.8, 1.2.5)
$limit_rate           # 用于设置响应的速度限制，详见 limit_rate。
$bytes_sent           # 传输给客户端的字节数 (1.3.8, 1.2.5)
$body_bytes_sent      # 传输给客户端的字节数，响应头不计算在内；这个变量和Apache的mod_log_config模块中的“%B”参数保持兼容

$server_port         # 服务器端口
$server_protocol     # 服务器的HTTP版本, 通常为 “HTTP/1.0” 或 “HTTP/1.1”
$status              # HTTP响应代码 (1.3.2, 1.2.2)

$remote_port          # 客户端端口
$remote_user          # 用于HTTP基础认证服务的用户名
$remote_addr          # 客户端地址
$binary_remote_addr   # 客户端地址的二进制形式, 固定长度为4个字节
$proxy_protocol_addr  # 获取代理访问服务器的客户端地址，如果是直接访问，该值为空字符串。(1.5.12)
$http_x_forwarded_for       # 客户端真实ip 
$proxy_add_x_forwarded_for  # 代理ip 和真实ip都显示出来。 真实ip在前面

$tcpinfo_rtt, $tcpinfo_rttvar, $tcpinfo_snd_cwnd, $tcpinfo_rcv_space   # 客户端TCP连接的具体信息


# os
$nginx_version        # nginx版本
$pid                  # 工作进程的PID
$pipe                 # 如果请求来自管道通信，值为“p”，否则为“.” (1.3.12, 1.2.7)

2 自定义变量

假如需要自定义变量名称和值，使用指令set $variable value;，则方法如下：

Syntax: 
set $variable value; 
Default: — Context: server, location, if

3 查看变量值

参考：NGINX 变量打印（输出） https://www.jianshu.com/p/183d4408c5d7
这个文章说的详细

4 最后

爱你！