九爺帶你了解 nginx 日志配置指令詳解

nginx日志配置指令詳解

日志對于統計排錯來說非常有利的。

本文總結了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" ';

如果nginx位于負載均衡器，squid，nginx反向代理之後，web伺服器無法直接擷取到用戶端真實的IP位址了。 $remote_addr擷取反向代理的IP位址。反向代理伺服器在轉發請求的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協定

$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 通用日志格式下的本地時間。

發送給用戶端的響應頭擁有“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

對于每一條日志記錄，都将是先打開檔案，再寫入日志，然後關閉。可以使用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;

4. log_not_found指令

文法: log_not_found on | off;

預設值: log_not_found on;

是否在error_log中記錄不存在的錯誤。預設是。

5. log_subrequest指令

文法: log_subrequest on | off;

預設值: log_subrequest off;

是否在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

配置錯誤日志。