• log_format
  • 1 语法格式
  • 2 默认日志格式
  • 3 常见内置变量
  • 4 应用
  • access_log
  • 1 语法格式
  • 2 示例
  • 3 open_log_file_cache
  • error_log


本篇文章将介绍nginx的日志配置相关的内容。

说到日志配置，无非以下几项了：

  • 日志级别
  • debug
  • ……
  • 日志记录方式
  • 文件
  • 其他
  • 日志格式

1 log_format

1.1 语法格式

该指令用来设置日志记录的格式。

log_format name format [format ...]
    name : 给定义的格式起的名称，应该是全局唯一的

1.2 默认日志格式

默认情况下，nginx的默认日志格式如下(不同版本可能略有不同)：

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

可能的日志格式大致如下:

192.168.161.1 - - [25/Oct/2016:05:39:45 +0800] "GET /favicon.ico HTTP/1.1" 404 571 "http://192.168.161.126/" "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/53.0.2785.143 Safari/537.36"

1.3 常见内置变量

name

DESC

$http_x_forwarded_for

客户端IP地址

$remote_addr

客户端IP地址

$remote_user

用户名称(和实际所采用的认证方式有关)

$time_local

访问时间以及用户所在时区

$request

URL以及HTTP协议版本

$status

回送给客户端的HTTP状态码,如200,302,304,404,500等

$body_bytes_sent

回送给客户端的数据的大小

$http_referer

用户是从哪个URL到达当前URL的。比如在一般的盗链技术中就使用的是该项请求头，当然这个是很容易就能模拟冒充的。

$http_user_agent

用户所使用的浏览的相关信息

1.4 应用

作为反向代理的nginx在将请求转发至后端服务器时，在后端服务器获得的客户端地址都将是nginx的地址，此处可以利用自定义日志格式来解决。也可以在反向代理的设置处(proxy_set)进行设置，将在后续章节介绍。

log_format reverseRealIpFormat1 '$http_x_forwarded_for - $remote_user [$time_local]  '
                    '"$request" $status $body_bytes_sent '
                    '"$http_referer" "$http_user_agent"';

2 access_log

该指令用来指定访问日志的路径及格式等信息。

2.1 语法格式

access_log path [log_format_name [buffer=buffer_size | off]]

2.2 示例

关闭访问日志

access_log off;

默认的配置

# combined是默认的日志格式,可以省略
access_log logs/access.log combined;

自定义日志格式

log_format reverseRealIpFormat1 '$remote_addr - $remote_user [$time_local]  '
                    '"$request" $status $body_bytes_sent '
                    '"$http_referer" "$http_user_agent"';
access_log /var/log/nginx/my-access.log reverseRealIpFormat1 buffer=8k;

2.3 open_log_file_cache

在access_log中可以使用变量比如:

# 通过检测
access_log /var/log/nginx/$server_name.log reverseRealIpFormat1;
# 不能和buffer同时启用
access_log /var/log/nginx/$server_name.log reverseRealIpFormat1 buffer=8k;

但是在此处使用变量的时候，会有以下限制：

  • buffer将不能启用
  • 每次记录日志都是将日志文件打开->写入->关闭,太消耗IO. 不过可以看看下面的open_log_file_cache指令。

open_log_file_cache 可以设置路径中含有变量的日志配置中日志文件的文件描述符缓存。

open_log_file_cache max=N [inactive=time] [min_uses=N] [valid=time] | off;
    max:文件描述符最大数量，也就意味着超过这个数之后会采用一定的算法来淘汰某些文件描述符了。
    inactive:可以简单理解为"发呆时间",多久不用它就被淘汰。
    min_uses:在发呆时间内,被访问min_uses次就被记录到缓存。
    valid:检测时间间隔。

例如:

open_log_file_cache max=655350 inactive=20s;

3 error_log

和access_log类似，error_log也是设置记录日志的指令。不过它记录的是错误日志。

该指令在 http, stream, server 和 location 段都可以被指定，可以覆盖更外面的段的设置。

error_log /var/log/nginx/error.log warn;