在本文中将介绍Nginx的日志格式配置——log_format。Nginx的日志类型分为:error.log和access_log。前者记录Nginx运行过程中产生的错误信息,后者记录Nginx运行过程中http请求访问状态。

error_log

配置格式:

语法: error_log file [level];
默认: error_log logs/error.log error;
上下文: main, http, mail, stream, server, location

      配置日志记录。可以在同一级别指定多个日志。如果在main配置级别上没有显式定义文件写入日志,将使用默认文件。
      第一个参数定义一个存储日志的文件。特殊值stderr选择标准错误文件。可以通过指定"syslog:"前缀来配置对syslog的日志记录。循环内存缓冲区的日志记录可以通过指定"memory:"前缀和缓冲区大小来配置,通常用于调试。
      第二个参数决定日志记录的级别,可以是下列之一:debug、info、notice、warn、error、crit、alert或emerg。以上日志级别是按照严重性递增的顺序列出的。设置某个日志级别将导致记录指定的和更严重的日志级别的所有消息。例如,默认的级别error将导致记录error、crit、alert和emerg。如果省略该参数,则使用error

如果要使用debug级别记录日志,nginx需要使用--with-debug来构建
在同一上下文中只能有一个error_log配置
关闭error_log记录:error_log /dev/null;

access_log

配置格式:

语法: access_log path [format [buffer=size] [gzip[=level]] [flush=time] [if=condition]];
      access_log off;
默认: access_log logs/access.log combined;
上下文: http, server, location, if in location, limit_except

      设置日志写入的路径、格式和配置。可以在同一级别指定多个日志。可以通过在第一个参数中指定"syslog:"前缀来配置对syslog的日志记录。特殊值off取消当前级别上的所有access_log指令。如果没有指定格式,则使用预定义的"combined"格式(即log_format配置的格式)。
      如果使用buffer或gzip参数,日志写入将被缓冲。

缓冲区大小不能超过对磁盘文件的原子写入的大小。对于FreeBSD,这个大小是无限的。

      当缓冲被启用时,下列情况下数据将被写入文件:

  • 如果下一个日志行不能放入缓冲区;
  • 如果缓冲的数据比flush参数指定的时间长;
  • 当工作进程重新打开日志文件或关闭时。

      如果使用gzip参数,那么在写入文件之前,缓冲的数据将被压缩。压缩级别可以设置在1(最快的,较少的压缩)和9(最慢的,最好的压缩)之间。默认情况下,缓冲区大小等于64K字节,压缩级别设置为1。由于数据是在原子块中压缩的,所以日志文件可以在任何时候由“zcat”解压或读取。

log_format

      log_format用于指定access_log输出格式。
配置格式

语法: log_format name [escape=default|json|none] string ...;
默认: log_format combined "...";
上下文: http

      escape参数允许在变量中设置转义的json或默认字符,默认情况下使用默认转义。none值禁止转义。
      日志格式可以包含常见的变量,并且只有在写日志时才存在的变量。下面通过默认的配置了解一些变量。

log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
                  '$status $body_bytes_sent "$http_referer" '
                  '"$http_user_agent" "$http_x_forwarded_for"';
$remote_addr:客户端地址
$remote_user:用于HTTP基础认证服务的用户名。开启了认证才有效
$time_local:服务器时间
$request:完整的原始请求行
$status:HTTP响应代码
$body_bytes_sent:传输给客户端的字节数,响应头不计算在内
$http_referer:来源地址
$http_user_agent:请求头中的user-agent
$http_x_forwarded_for:请求中的X-Forwarded-For信息

#access.log记录日志结果如下:
106.14.141.92 - - [25/Mar/2020:15:39:29 +0800] "GET / HTTP/1.1" 200 612 "-" "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:36.0) Gecko/20100101 Firefox/36.0" "-"

      Nginx中的变量远不止这些,同时我们也可以设置定义变量。

Nginx内置变量

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

名称 含义
$arg_name 请求中的的参数名,即“?”后面的arg_name=arg_value形式的arg_name
$args 请求中的参数值
$binary_remote_addr 客户端地址的二进制形式, 固定长度为4个字节
$body_bytes_sent 传输给客户端的字节数,响应头不计算在内
$bytes_sent 传输给客户端的字节数
$connection TCP连接的序列号
$connection_requests TCP连接当前的请求数量
$content_length "Content-Length"请求头字段
$content_type "Content-Type"请求头字段
$cookie_name cookie名称
$document_root 当前请求的文档根目录或别名
$document_uri 同 $uri
$host 优先级如下:HTTP请求行的主机名>”HOST”请求头字段>符合请求的服务器名
$hostname 主机名
$http_name 匹配任意请求头字段; 变量名中的后半部分"name"可以替换成任意请求头字段,如在配置文件中需要获取http请求头:"Accept-Language",那么将“-”替换为下划线,大写字母替换为小写,形如:$http_accept_language即可。
$https 如果开启了SSL安全模式,值为"on",否则为空字符串。
$is_args 如果请求中有参数,值为“?”,否则为空字符串。
$limit_rate 用于设置响应的速度限制
$msec 当前的Unix时间戳
$nginx_version nginx版本
$pid 工作进程的PID
$pipe 如果请求来自管道通信,值为"p",否则为"."
$proxy_protocol_addr 获取代理访问服务器的客户端地址,如果是直接访问,该值为空字符串。
$query_string 同 $args
$realpath_root 当前请求的文档根目录或别名的真实路径,会将所有符号连接转换为真实路径。
$remote_addr 客户端地址
$remote_port 客户端端口
$remote_user 用于HTTP基础认证服务的用户名
$request 代表客户端的完整请求地址
$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
$request_completion 如果请求成功,值为”OK”,如果请求未完成或者请求不是一个范围请求的最后一部分,则为空。
$request_filename 当前连接请求的文件路径,由root或alias指令与URI请求生成。
$request_length 请求的长度 (包括请求的地址, http请求头和请求主体)
$request_method HTTP请求方法,通常为“GET”或“POST”
$request_time 处理客户端请求使用的时间; 从读取客户端的第一个字节开始计时。
$request_uri 这个变量等于包含一些客户端请求参数的原始URI,它无法修改,请查看$uri更改或重写URI,不包含主机名,例如:”/cnphp/test.php?arg=freemouse”。
$scheme 请求使用的Web协议, “http” 或 “https”
$sent_http_name 可以设置任意http响应头字段; 变量名中的后半部分“name”可以替换成任意响应头字段,如需要设置响应头Content-length,那么将“-”替换为下划线,大写字母替换为小写,形如:$sent_http_content_length 4096即可。
$server_addr 服务器端地址,需要注意的是:为了避免访问linux系统内核,应将ip地址提前设置在配置文件中。
$server_name 服务器名
$server_port 服务器端口
$server_protocol 服务器的HTTP版本, 通常为 “HTTP/1.0” 或 “HTTP/1.1”
$status HTTP响应代码
$tcpinfo_rtt, $tcpinfo_rttvar, $tcpinfo_snd_cwnd, $tcpinfo_rcv_space 客户端TCP连接的具体信息
$time_iso8601 服务器时间的ISO 8610格式
$time_local 服务器时间
$uri 请求中的当前URI(不带请求参数,参数位于$args),可以不同于浏览器传递的$request_uri的值,它可以通过内部重定向,或者使用index指令进行修改,$uri不包含主机名,如”/foo/bar.html”。
Last modification:March 27th, 2020 at 09:48 pm
如果觉得我的文章对你有用,请随意赞赏