後端實踐:Nginx日誌配置(超詳細)

作者 | antwang

鏈接 | juejin.im/post/5aa09bb3f265da238f121b6c

前言

Nginx日誌對於統計、系統服務排錯很有用。

Nginx日誌主要分爲兩種:access_log(訪問日誌)和error_log(錯誤日誌)。通過訪問日誌我們可以得到用戶的IP地址、瀏覽器的信息,請求的處理時間等信息。錯誤日誌記錄了訪問出錯的信息,可以幫助我們定位錯誤的原因。

本文將詳細描述一下如何配置Nginx日誌。

設置access_log

訪問日誌主要記錄客戶端的請求。客戶端向Nginx服務器發起的每一次請求都記錄在這裏。客戶端IP,瀏覽器信息,referer,請求處理時間,請求URL等都可以在訪問日誌中得到。當然具體要記錄哪些信息,你可以通過log_format指令定義。

語法

access_log path [format [buffer=size] [gzip[=level]] [flush=time] [if=condition]]; # 設置訪問日誌
access_log off; # 關閉訪問日誌
  • path 指定日誌的存放位置。

  • format 指定日誌的格式。默認使用預定義的combined。

  • buffer 用來指定日誌寫入時的緩存大小。默認是64k。

  • gzip 日誌寫入前先進行壓縮。壓縮率可以指定,從1到9數值越大壓縮比越高,同時壓縮的速度也越慢。默認是1。

  • flush 設置緩存的有效時間。如果超過flush指定的時間,緩存中的內容將被清空。

  • if 條件判斷。如果指定的條件計算爲0或空字符串,那麼該請求不會寫入日誌。

另外,還有一個特殊的值off。如果指定了該值,當前作用域下的所有的請求日誌都被關閉。

作用域

可以應用access_log指令的作用域分別有http,server,location,limit_except。也就是說,在這幾個作用域外使用該指令,Nginx會報錯。

以上是access_log指令的基本語法和參數的含義。下面我們看一幾個例子加深一下理解。

基本用法

access_log /var/logs/nginx-access.log

該例子指定日誌的寫入路徑爲/var/logs/nginx-access.log,日誌格式使用默認的combined。

access_log /var/logs/nginx-access.log buffer=32k gzip flush=1m

該例子指定日誌的寫入路徑爲/var/logs/nginx-access.log,日誌格式使用默認的combined,指定日誌的緩存大小爲32k,日誌寫入前啓用gzip進行壓縮,壓縮比使用默認值1,緩存數據有效時間爲1分鐘。

使用log_format自定義日誌格式

Nginx預定義了名爲combined日誌格式,如果沒有明確指定日誌格式默認使用該格式:

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

如果不想使用Nginx預定義的格式,可以通過log_format指令來自定義。

語法

log_format name [escape=default|json] string ...;
  • name 格式名稱。在access_log指令中引用。

  • escape 設置變量中的字符編碼方式是json還是default,默認是default。

  • string 要定義的日誌格式內容。該參數可以有多個。參數中可以使用Nginx變量。

下面是log_format指令中常用的一些變量:

看不清可以點開放大

下面演示一下自定義日誌格式的使用:

access_log /var/logs/nginx-access.log main
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指令定義了一個main的格式,並在access_log指令中引用了它。假如客戶端有發起請求:https://suyunfe.com/,我們看一下我截取的一個請求的日誌記錄:

112.195.209.90 - - [20/Feb/2018:12:12:14 +0800]
"GET / HTTP/1.1" 200 190 "-" "Mozilla/5.0 (Linux; Android 6.0; Nexus 5 Build/MRA58N)
AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.132 Mobile Safari/537.36" "-"

我們看到最終的日誌記錄中$remote_user$http_referer$http_x_forwarded_for都對應了一個-,這是因爲這幾個變量爲空。

設置error_log

錯誤日誌在Nginx中是通過error_log指令實現的。該指令記錄服務器和請求處理過程中的錯誤信息。

語法

配置錯誤日誌文件的路徑和日誌級別。

error_log file [level];
Default:
error_log logs/error.log error;

第一個參數指定日誌的寫入位置。

第二個參數指定日誌的級別。level可以是debug, info, notice, warn, error, crit, alert,emerg中的任意值。可以看到其取值範圍是按緊急程度從低到高排列的。只有日誌的錯誤級別等於或高於level指定的值纔會寫入錯誤日誌中。默認值是error。

基本用法

error_log /var/logs/nginx/nginx-error.log

它可以配置在:main, http, mail, stream, server, location作用域。

例子中指定了錯誤日誌的路徑爲:/var/logs/nginx/nginx-error.log,日誌級別使用默認的error。

open_log_file_cache

每一條日誌記錄的寫入都是先打開文件再寫入記錄,然後關閉日誌文件。如果你的日誌文件路徑中使用了變量,如access_log /var/logs/$host/nginx-access.log,爲提高性能,可以使用open_log_file_cache指令設置日誌文件描述符的緩存。

語法

open_log_file_cache max=N [inactive=time] [min_uses=N] [valid=time];
  • max 設置緩存中最多容納的文件描述符數量,如果被佔滿,採用LRU算法將描述符關閉。

  • inactive 設置緩存存活時間,默認是10s。

  • min_uses 在inactive時間段內,日誌文件最少使用幾次,該日誌文件描述符記入緩存,默認是1次。

  • valid:設置多久對日誌文件名進行檢查,看是否發生變化,默認是60s。

  • off:不使用緩存。默認爲off。

基本用法

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

它可以配置在http、server、location作用域中。

例子中,設置緩存最多緩存1000個日誌文件描述符,20s內如果緩存中的日誌文件描述符至少被被訪問2次,纔不會被緩存關閉。每隔1分鐘檢查緩存中的文件描述符的文件名是否還存在。

總結

Nginx中通過access_log和error_log指令配置訪問日誌和錯誤日誌,通過log_format我們可以自定義日誌格式。如果日誌文件路徑中使用了變量,我們可以通過open_log_file_cache指令來設置緩存,提升性能。

另外,在access_log和log_format中使用了很多變量,這些變量沒有一一列舉出來,詳細的變量信息可以參考Nginx官方文檔:

http://nginx.org/en/docs/varindex.html


-END-

喜歡本文的朋友們,歡迎長按下圖關注訂閱號成猿之路,收看更多精彩內容!小編微信一起聊技術。

             

推薦閱讀:

在看再走唄!

發佈了28 篇原創文章 · 獲贊 18 · 訪問量 2萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章