如何自定義Nginx JSON日志格式配置

更新時間：2025年03月27日 09:14:56 作者：Leo-Yide

Nginx作為最流行的Web服務器之一,其靈活的日志配置能力允許我們根據需求定制日志格式,本文將詳細介紹如何配置Nginx以JSON格式記錄訪問日志,這種結構化日志格式特別適合ELK等日志分析系統(tǒng)處理,感興趣的朋友一起看看吧

前言

在現(xiàn)代Web服務架構中，日志記錄是監(jiān)控、調試和安全審計的重要環(huán)節(jié)。Nginx作為最流行的Web服務器之一，其靈活的日志配置能力允許我們根據需求定制日志格式。本文將詳細介紹如何配置Nginx以JSON格式記錄訪問日志，這種結構化日志格式特別適合ELK等日志分析系統(tǒng)處理。

為什么選擇JSON格式日志？

相比傳統(tǒng)的NCSA通用日志格式，JSON格式日志具有以下優(yōu)勢：

結構化數據：便于日志分析系統(tǒng)（如ELK Stack）解析和處理
字段擴展性：可以輕松添加或刪除字段而不影響現(xiàn)有日志解析
數據類型明確：數值、字符串等數據類型可以明確區(qū)分
兼容性好：與大多數現(xiàn)代日志處理工具和數據庫系統(tǒng)兼容

配置步驟詳解

1. 安裝Nginx服務

在基于Debian/Ubuntu的系統(tǒng)上安裝Nginx：

apt -y install nginx

對于RHEL/CentOS系統(tǒng)，請使用：

yum -y install nginx

2. 自定義JSON日志格式

編輯Nginx主配置文件（通常位于/etc/nginx/nginx.conf）：

http {
    ...
    log_format oldboyedu_nginx_json '{"@timestamp":"$time_iso8601",'
                                  '"host":"$server_addr",'
                                  '"clientip":"$remote_addr",'
                                  '"SendBytes":$body_bytes_sent,'
                                  '"responsetime":$request_time,'
                                  '"upstreamtime":"$upstream_response_time",'
                                  '"upstreamhost":"$upstream_addr",'
                                  '"http_host":"$host",'
                                  '"uri":"$uri",'
                                  '"domain":"$host",'
                                  '"xff":"$http_x_forwarded_for",'
                                  '"referer":"$http_referer",'
                                  '"tcp_xff":"$proxy_protocol_addr",'
                                  '"http_user_agent":"$http_user_agent",'
                                  '"status":"$status"}';
    access_log  /var/log/nginx/access.log  oldboyedu_nginx_json;
    # 重要：注釋或移除默認的日志格式
    # access_log /var/log/nginx/access.log;
    ...
}

各字段說明

字段名	變量	描述
@timestamp	$time_iso8601	ISO8601格式的時間戳
host	$server_addr	服務器IP地址
clientip	$remote_addr	客戶端IP地址
SendBytes	$body_bytes_sent	發(fā)送給客戶端的字節(jié)數
responsetime	$request_time	請求處理總時間
upstreamtime	$upstream_response_time	后端服務器響應時間
upstreamhost	$upstream_addr	后端服務器地址
http_host	$host	請求的主機頭
uri	$uri	請求的URI
domain	$host	請求的域名
xff	$http_x_forwarded_for	X-Forwarded-For頭信息
referer	$http_referer	請求來源
tcp_xff	$proxy_protocol_addr	代理協(xié)議地址
http_user_agent	$http_user_agent	用戶代理字符串
status	$status	HTTP響應狀態(tài)碼

3. 配置文件語法檢查

執(zhí)行以下命令檢查Nginx配置是否正確：

nginx -t

如果配置正確，您應該看到類似輸出：

nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
nginx: configuration file /etc/nginx/nginx.conf test is successful

4. 重啟Nginx服務

應用新的配置：

systemctl restart nginx

5. 測試驗證

可以使用簡單的循環(huán)命令測試日志記錄：

while true; do curl 10.0.0.91; sleep 0.5; done

檢查日志文件內容：

tail -f /var/log/nginx/access.log

您應該看到類似以下的JSON格式日志條目：

{"@timestamp":"2023-05-15T14:30:45+08:00","host":"10.0.0.91","clientip":"10.0.0.1","SendBytes":612,"responsetime":0.002,"upstreamtime":"-","upstreamhost":"-","http_host":"10.0.0.91","uri":"/","domain":"10.0.0.91","xff":"-","referer":"-","tcp_xff":"","http_user_agent":"curl/7.68.0","status":"200"}

生產環(huán)境建議

日志輪轉：配置logrotate以防止日志文件過大

vim /etc/logrotate.d/nginx

敏感信息過濾：避免記錄敏感信息如密碼、信用卡號等
性能考慮：在高流量環(huán)境中，JSON日志可能會增加磁盤I/O負載
字段優(yōu)化：根據實際需求調整字段，只記錄必要信息
日志分割：考慮按虛擬主機或日期分割日志文件

擴展配置

添加更多字段

您可以根據需要擴展日志格式，例如添加請求方法：

log_format oldboyedu_nginx_json '{"@timestamp":"$time_iso8601",'
                              ...
                              '"method":"$request_method",'
                              ...
                              '"status":"$status"}';

條件日志記錄

對于靜態(tài)資源等不重要的請求，可以跳過日志記錄：

map $uri $is_static {
    default 0;
    ~*\.(jpg|jpeg|png|gif|ico|css|js|woff|woff2|ttf|svg) 1;
}
server {
    ...
    access_log /var/log/nginx/access.log oldboyedu_nginx_json if=$is_static;
    ...
}