日志對于統(tǒng)計排錯來說非常有利的。本文總結了nginx日志相關的配置如access_log、log_format、open_log_file_cache、log_not_found、log_subrequest、rewrite_log、error_log。
nginx有一個非常靈活的日志記錄模式。每個級別的配置可以有各自獨立的訪問日志。日志格式通過log_format命令來定義。ngx_http_log_module是用來定義請求日志格式的。
1. access_log指令
語法: access_log path [format [buffer=size [flush=time]]];
access_log path format gzip[=level] [buffer=size] [flush=time];
access_log syslog:server=address[,parameter=value] [format];
access_log off;
默認值: access_log logs/access.log combined;
配置段: http, server, location, if in location, limit_except
gzip壓縮等級。
buffer設置內(nèi)存緩存區(qū)大小。
flush保存在緩存區(qū)中的最長時間。
不記錄日志:access_log off;
使用默認combined格式記錄日志:access_log logs/access.log 或 access_log logs/access.log combined;
2. log_format指令
語法: log_format name string …;
默認值: log_format combined “…”;
配置段: http
name表示格式名稱,string表示等義的格式。log_format有一個默認的無需設置的combined日志格式,相當于apache的combined日志格式,如下所示:
log_format combined '$remote_addr - $remote_user [$time_local] '
' "$request" $status $body_bytes_sent '
' "$http_referer" "$http_user_agent" ';
如果nginx位于負載均衡器,squid,nginx反向代理之后,web服務器無法直接獲取到客戶端真實的IP地址了。 $remote_addr獲取反向代理的IP地址。反向代理服務器在轉發(fā)請求的http頭信息中,可以增加X-Forwarded-For信息,用來記錄 客戶端IP地址和客戶端請求的服務器地址。如下所示:
log_format porxy '$http_x_forwarded_for - $remote_user [$time_local] '
' "$request" $status $body_bytes_sent '
' "$http_referer" "$http_user_agent" ';
日志格式允許包含的變量注釋如下:
$remote_addr, $http_x_forwarded_for 記錄客戶端IP地址
$remote_user 記錄客戶端用戶名稱
$request 記錄請求的URL和HTTP協(xié)議
$status 記錄請求狀態(tài)
$body_bytes_sent 發(fā)送給客戶端的字節(jié)數(shù),不包括響應頭的大??; 該變量與Apache模塊mod_log_config里的“%B”參數(shù)兼容。
$bytes_sent 發(fā)送給客戶端的總字節(jié)數(shù)。
$connection 連接的序列號。
$connection_requests 當前通過一個連接獲得的請求數(shù)量。
$msec 日志寫入時間。單位為秒,精度是毫秒。
$pipe 如果請求是通過HTTP流水線(pipelined)發(fā)送,pipe值為“p”,否則為“.”。
$http_referer 記錄從哪個頁面鏈接訪問過來的
$http_user_agent 記錄客戶端瀏覽器相關信息
$request_length 請求的長度(包括請求行,請求頭和請求正文)。
$request_time 請求處理時間,單位為秒,精度毫秒; 從讀入客戶端的第一個字節(jié)開始,直到把最后一個字符發(fā)送給客戶端后進行日志寫入為止。
$time_iso8601 ISO8601標準格式下的本地時間。
$time_local 通用日志格式下的本地時間。
發(fā)送給客戶端的響應頭擁有“sent_http_”前綴。 比如$sent_http_content_range。
實例如下:
http {
log_format main '$remote_addr - $remote_user [$time_local] "$request" '
'"$status" $body_bytes_sent "$http_referer" '
'"$http_user_agent" "$http_x_forwarded_for" '
'"$gzip_ratio" $request_time $bytes_sent $request_length';
log_format srcache_log '$remote_addr - $remote_user [$time_local] "$request" '
'"$status" $body_bytes_sent $request_time $bytes_sent $request_length '
'[$upstream_response_time] [$srcache_fetch_status] [$srcache_store_status] [$srcache_expire]';
open_log_file_cache max=1000 inactive=60s;
server {
server_name ~^(www\.)?(.+)$;
access_log logs/$2-access.log main;
error_log logs/$2-error.log;
location /srcache {
access_log logs/access-srcache.log srcache_log;
}
}
}
3. open_log_file_cache指令
語法: open_log_file_cache max=N [inactive=time] [min_uses=N] [valid=time];
open_log_file_cache off;
默認值: open_log_file_cache off;
配置段: http, server, location
對于每一條日志記錄,都將是先打開文件,再寫入日志,然后關閉??梢允褂胦pen_log_file_cache來設置日志文件緩存(默認是off),格式如下:
參數(shù)注釋如下:
max:設置緩存中的最大文件描述符數(shù)量,如果緩存被占滿,采用LRU算法將描述符關閉。
inactive:設置存活時間,默認是10s
min_uses:設置在inactive時間段內(nèi),日志文件最少使用多少次后,該日志文件描述符記入緩存中,默認是1次
valid:設置檢查頻率,默認60s
off:禁用緩存
實例如下:
4. log_not_found指令
語法: log_not_found on | off;
默認值: log_not_found on;
配置段: http, server, location
是否在error_log中記錄不存在的錯誤。默認是。
5. log_subrequest指令
語法: log_subrequest on | off;
默認值: log_subrequest off;
配置段: http, server, location
是否在access_log中記錄子請求的訪問日志。默認不記錄。
6. rewrite_log指令
由ngx_http_rewrite_module模塊提供的。用來記錄重寫日志的。對于調(diào)試重寫規(guī)則建議開啟。 Nginx重寫規(guī)則指南
語法: rewrite_log on | off;
默認值: rewrite_log off;
配置段: http, server, location, if
啟用時將在error log中記錄notice級別的重寫日志。
7. error_log指令
語法: error_log file | stderr | syslog:server=address[,parameter=value] [debug | info | notice | warn | error | crit | alert | emerg];
默認值: error_log logs/error.log error;
配置段: main, http, server, location
配置錯誤日志。