日誌對於統計排錯來說非常有利的。本文總結了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設定記憶體快取區大小。

flush儲存在快取區中的最長時間。

不記錄日誌：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" ";

log_formatcombined"$remote_addr - $remote_user [$time_local] "

" "$request" $status $body_bytes_sent "

" "$http_referer" "$http_user_agent" ";

如果nginx位於負載均衡器，squid，nginx反向代理之後，web伺服器無法直接獲取到客戶端真實的IP地址了。 $remote_addr獲取反向代理的IP地址。反向代理伺服器在轉發請求的http頭資訊中，可以增加X-Forwarded-For資訊，用來記錄 客戶端IP地址和客戶端請求的伺服器地址。PS: 獲取使用者真實IP 參見http://www.ttlsa.com/html/2235.html如下所示：

log_format porxy "$http_x_forwarded_for - $remote_user [$time_local] "

" "$request" $status $body_bytes_sent "

" "$http_referer" "$http_user_agent" ";

log_formatporxy"$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協議

$status 記錄請求狀態

$body_bytes_sent 傳送給客戶端的位元組數，不包括響應頭的大小； 該變數與Apache模組mod_log_config裡的“%B”引數相容。

$bytes_sent 傳送給客戶端的總位元組數。

$connection 連線的序列號。

$connection_requests 當前透過一個連接獲得的請求數量。

$msec 日誌寫入時間。單位為秒，精度是毫秒。

$pipe 如果請求是透過HTTP流水線(pipelined)傳送，pipe值為“p”，否則為“.”。

$http_referer 記錄從哪個頁面連結訪問過來的

$http_user_agent 記錄客戶端瀏覽器相關資訊

$request_length 請求的長度(包括請求行，請求頭和請求正文)。

$request_time 請求處理時間，單位為秒，精度毫秒； 從讀入客戶端的第一個位元組開始，直到把最後一個字元傳送給客戶端後進行日誌寫入為止。

$time_iso8601 ISO8601標準格式下的本地時間。

$time_local 通用日誌格式下的本地時間。

$remote_addr,$http_x_forwarded_for記錄客戶端IP地址

$remote_user記錄客戶端使用者名稱稱

$request記錄請求的URL和HTTP協議

$status記錄請求狀態

$body_bytes_sent傳送給客戶端的位元組數，不包括響應頭的大小；該變數與Apache模組mod_log_config裡的“%B”引數相容。

$bytes_sent傳送給客戶端的總位元組數。

$connection連線的序列號。

$connection_requests當前透過一個連接獲得的請求數量。

$msec日誌寫入時間。單位為秒，精度是毫秒。

$pipe如果請求是透過HTTP流水線(pipelined)傳送，pipe值為“p”，否則為“.”。

$http_referer記錄從哪個頁面連結訪問過來的

$http_user_agent記錄客戶端瀏覽器相關資訊

$request_length請求的長度(包括請求行，請求頭和請求正文)。

$request_time請求處理時間，單位為秒，精度毫秒；從讀入客戶端的第一個位元組開始，直到把最後一個字元傳送給客戶端後進行日誌寫入為止。

$time_iso8601ISO8601標準格式下的本地時間。

$time_local通用日誌格式下的本地時間。

[warning]傳送給客戶端的響應頭擁有“sent_http_”字首。 比如$sent_http_content_range。[/warning]

例項如下：

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;

}

}

}

http{

log_formatmain"$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_formatsrcache_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_cachemax=1000inactive=60s;

server{

server_name~^(www\.)?(.+)$;

access_loglogs/$2-access.logmain;

error_loglogs/$2-error.log;

location/srcache{

access_loglogs/access-srcache.logsrcache_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

對於每一條日誌記錄，都將是先開啟檔案，再寫入日誌，然後關閉。可以使用open_log_file_cache來設定日誌檔案快取(預設是off)，格式如下：

引數註釋如下：

max:設定快取中的最大檔案描述符數量，如果快取被佔滿，採用LRU演算法將描述符關閉。

inactive:設定存活時間，預設是10s

min_uses:設定在inactive時間段內，日誌檔案最少使用多少次後，該日誌檔案描述符記入快取中，預設是1次

valid:設定檢查頻率，預設60s

off：禁用快取

例項如下：

open_log_file_cache max=1000 inactive=20s valid=1m min_uses=2;

1

open_log_file_cachemax=1000inactive=20svalid=1mmin_uses=2;

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模組提供的。用來記錄重寫日誌的。對於除錯重寫規則建議開啟。 Nginx重寫規則指南

語法: 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

配置錯誤日誌。