Nginx配置中的log_format用法梳理(設置詳細的日志格式)


 

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


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM