Nginx配置中的log_format用法梳理（設定詳細的日誌格式）

散盡浮華發表於2016-09-21
NginxORM

 

nginx伺服器日誌相關指令主要有兩條：一條是log_format，用來設定日誌格式；另外一條是access_log，用來指定日誌檔案的存放路徑、格式和快取大小，可以參加ngx_http_log_module。一般在nginx的配置檔案中日記配置(/usr/local/nginx/conf/nginx.conf)。

log_format指令用來設定日誌的記錄格式，它的語法如下：
log_format name format {format ...}
其中name表示定義的格式名稱，format表示定義的格式樣式。

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_format指令設定的名稱在配置檔案中是不能重複的。

假設將Nginx伺服器作為Web伺服器，位於負載均衡裝置、Squid、Nginx反向代理之後，不能獲取到客戶端的真實IP地址了。
原因是經過反向代理後，由於在客戶端和Web伺服器之間增加了中間層，因此Web伺服器無法直接拿到客戶端的IP。
通過$remote_addr變數拿到的將是反向代理伺服器的IP地址。

但是，反向代理伺服器在轉發請求的HTTP頭資訊中，可以增加X-Forwarded-For資訊，用以記錄原有的客戶端IP地址和原來客戶端請求的伺服器地址。
這時候，要用log_format指令設定日誌格式，讓日誌記錄X-Forearded-For資訊中的IP地址，即客戶的真實IP。

例如，建立一個名為mylogformat的日誌格式，再$http_x_forwarded_forlog_for變數記錄使用者的X_Forwarded-For IP 地址：
log_format mylogformat '$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用於記錄遠端客戶端使用者名稱稱；
$time_local用於記錄訪問時間與時區；
$request用於記錄請求URL與HTTP協議；
$status用於記錄請求狀態，例如成功時狀態為200，頁面找不到時狀態為404；
$body_bytes_sent用於記錄傳送客戶端的檔案主體內容大小；
$http_referer用於記錄是從哪個頁面連結訪問過來的；
$http_user_agent用於記錄客戶瀏覽器的相關資訊。

一般來說：nginx的log_format有很多可選的引數用於指示伺服器的活動狀態，預設的是：

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

想要記錄更詳細的資訊需要自定義設定log_format，具體可設定的引數格式及說明如下：

引數                      說明                                         示例
$remote_addr             客戶端地址                                    211.28.65.253
$remote_user             客戶端使用者名稱稱                                --
$time_local              訪問時間和時區                                18/Jul/2012:17:00:01 +0800
$request                 請求的URI和HTTP協議                           "GET /article-10000.html HTTP/1.1"
$http_host               請求地址，即瀏覽器中你輸入的地址（IP或域名）     www.wang.com 192.168.100.100
$status                  HTTP請求狀態                                  200
$upstream_status         upstream狀態                                  200
$body_bytes_sent         傳送給客戶端檔案內容大小                        1547
$http_referer            url跳轉來源                                   https://www.baidu.com/
$http_user_agent         使用者終端瀏覽器等資訊                           "Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 5.1; Trident/4.0; SV1; GTB7.0; .NET4.0C;
$ssl_protocol            SSL協議版本                                   TLSv1
$ssl_cipher              交換資料中的演算法                               RC4-SHA
$upstream_addr           後臺upstream的地址，即真正提供服務的主機地址     10.10.10.100:80
$request_time            整個請求的總時間                               0.205
$upstream_response_time  請求過程中，upstream響應時間                    0.002

如下是在nginx的LB代理層使用過的一個配置（nginx.conf中配置）：

    log_format  main  '$remote_addr $remote_user [$time_local] "$request" '
                      '$status $body_bytes_sent "$http_referer" '
                      '$http_user_agent $http_x_forwarded_for $request_time $upstream_response_time $upstream_addr $upstream_status';

然後在nginx.conf檔案或vhosts/*.conf檔案中的access_log日誌中指定級別為main。如下：

    access_log  logs/wiki_access.log main;
    error_log   logs/wiki_error.log;

重啟nginx服務後生效。日誌擷取如下（可以從日誌中看到代理到後端哪臺機器上的哪個埠上，負載訪問的狀態值等都能看到）：

[root@lb-ng01 logs]# tail -f /data/nginx/logs/wiki_access.log
........
110.156.114.121 - [11/Aug/2017:09:57:19 +0800] "GET /rest/mywork/latest/status/notification/count?_=1502416641768 HTTP/1.1" 200 67 "http://wiki.wang-inc.com/pages/viewpage.action?pageId=11174759" Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/60.0.3112.78 Safari/537.36 - 0.006 0.006 12.129.120.121:8090 200
112.116.25.18 - [11/Aug/2017:09:57:24 +0800] "POST /json/startheartbeatactivity.action HTTP/1.1" 200 234 "http://wiki.wang-inc.com/pages/resumedraft.action?draftId=12058756&draftShareId=014b0741-df00-4fdc-90ca-4bf934f914d1" Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/59.0.3071.115 Safari/537.36 - 0.023 0.023 12.129.120.121:8090 200

相關文章