一、引言

在傳統(tǒng)的 HTTP 日志中，每個請求都會被單獨記錄，這對于短連接、異步加載等場景非常直觀；但在一些需要以“會話”為單位分析用戶行為的場景下，如視頻點播、多資源并行加載、長輪詢等，單個請求日志難以準確反映用戶整個會話的生命周期和流量消耗。

ngx_http_session_log_module 模塊（商業(yè)訂閱）針對這一需求推出：它可以將多個請求聚合為一個會話，待會話結束后一次寫入日志，方便統(tǒng)計和分析。下面將以零基礎、逐步演示的方式，帶你掌握該模塊。

二、先決條件

• NGINX 商業(yè)版：確認已包含 ngx_http_session_log_module。
• Linux 環(huán)境（Ubuntu/CentOS 等），擁有 sudo 權限。
• 配置與重載命令：會使用 nginx -t、systemctl reload nginx。

三、模塊驗證

在終端執(zhí)行：

nginx -V 2>&1 | grep --color session_log

• 若輸出包含 --with-http_session_log_module 或 session_log，說明模塊可用。
• 否則需聯(lián)系供應商或重新編譯 NGINX（添加 --add-module=.../ngx_http_session_log_module）。

四、核心指令詳解

4.1 session_log_zone

session_log_zone /path/to/log
                 zone=name:size
                 [format=format_name]
                 [timeout=time]
                 [id=var]
                 [md5=expr];

• /path/to/log：會話日志文件路徑。
• zone=name:size：定義共享內存區(qū) name 及大?。ㄈ?nbsp;1m）。
• format=format_name（可選）：引用由 session_log_format 定義的格式，默認使用內置的 combined。
• timeout=time（可選，默認 30s）：自上一次請求起經過該時間則認為會話結束并寫日志。
• id=var（可選）：如果來自客戶端的 var（例如 Cookie）是有效的 MD5，會直接作為會話 ID。
• md5=expr：當 id 不指定或無效時，基于 expr（可由多個變量拼接）計算 MD5 作為新會話 ID。

關鍵點：同一個會話下的所有請求，在 timeout 時間窗口內都歸為同一次日志；超時后才寫入并重啟新會話。

4.2 session_log_format

session_log_format name string ...;

• name：格式名稱，用于 session_log_zone 的 format= 參數(shù)。
• string：日志模板，支持所有標準 HTTP 變量，以及 $body_bytes_sent 會話內累積值，其他變量取首個請求的值。

常見內置變量：

4.3 session_log

session_log name | off;

• name：啟用對應 session_log_zone 中定義的會話日志。
• off：關閉當前級別繼承的會話日志。

可在 http、server 或 location 級別使用。

五、一步步配置示例

下面我們以“客戶端 IP + User-Agent”作為會話標識，統(tǒng)計 /media/ 路徑下所有請求的會話日志。

5.1 創(chuàng)建持久化目錄

sudo mkdir -p /var/log/nginx/session
sudo chown nginx:nginx /var/log/nginx/session

5.2 在 http 塊中定義會話日志區(qū)

編輯 /etc/nginx/nginx.conf，在 http { ... } 內添加：

# 定義會話日志區(qū)，1MB 大小，30s 超時，會話結束寫入 /var/log/nginx/session/media.log
# 會話格式使用默認 combined，也可自定義
session_log_zone /var/log/nginx/session/media.log
                 zone=media_zone:1m
                 timeout=30s
                 md5=$binary_remote_addr$http_user_agent;

5.3 自定義日志格式（可選）

如需記錄更多字段，可在 http 塊繼續(xù)添加：

session_log_format media_fmt 
    '$session_log_id '
    '$remote_addr [$time_local] '
    '"$http_user_agent" '
    'bytes_sent=$body_bytes_sent '
    'session_time=$session_time';

然后在 session_log_zone 中加上 format=media_fmt。

5.4 在 server/location 啟用

server {
    listen 80;
    server_name example.com;

    location /media/ {
        # 開啟會話級日志
        session_log media_zone;
    }

    # 其他路徑不記錄
}

5.5 檢查與重載

sudo nginx -t && sudo systemctl reload nginx

六、驗證與測試

• 模擬會話在瀏覽器或命令行中多次請求同一資源，確保連續(xù)請求間隔小于 30s：

  curl http://example.com/media/video1.ts
  sleep 5
  curl http://example.com/media/video2.ts
  

• 查看日志

  tail -n20 /var/log/nginx/session/media.log
  

  你將看到類似：

  5f2d3a4b... 192.168.1.10 [12/May/2025:14:00:00 +0800] "Mozilla/5.0 ..." bytes_sent=1048576 session_time=5.123
  

  其中：

  • 第一列 為會話 ID；
  • bytes_sent 為兩次請求的累計發(fā)送字節(jié)；
  • session_time 為首次到最后一次請求的時長。

七、典型應用場景

• 流媒體點播統(tǒng)計聚合一次完整的視頻播放會話（多個分片請求），統(tǒng)計總流量與觀看時長。
• 長輪詢/Comet 會話將多次心跳/推送請求歸為一次會話，評估用戶在線時長。
• API 批量操作若客戶端將多次批量操作拆分為多請求，可按會話統(tǒng)計請求總量與數(shù)據(jù)大小。

八、進階配置與優(yōu)化

• 調整 timeout

  • 對于長連接、心跳場景，可將 timeout 設置更高（如 5m）。

• 指定 id 參數(shù)

  • 若前端通過 Cookie 提供穩(wěn)定會話 ID，可寫 id=$cookie_sessionid，避免重復新建。

• 日志輪轉

  • 配合 logrotate 工具定期切割 /var/log/nginx/session/*.log，防止磁盤占滿。

• 性能監(jiān)控

  • 監(jiān)控共享內存使用情況，若活躍會話數(shù)極多，可增大 zone=size。

九、常見問題與排查

十、總結

通過 ngx_http_session_log_module，你可以：

• 以會話級別代替請求級日志，直觀統(tǒng)計用戶完整交互。
• 聚合流量與時長，方便流媒體、長輪詢、批量 API 等場景分析。
• 靈活配置超時、格式、ID 源，滿足各種業(yè)務需求。

掌握以上配置與調優(yōu)方法后，即可在 NGINX 層為復雜 HTTP 會話提供精準、連貫的日志記錄，助力業(yè)務監(jiān)控與數(shù)據(jù)分析。祝你上手順利，靈活運維！

到此這篇關于詳解ngx_http_session_log_module的使用的文章就介紹到這了,更多相關ngx_http_session_log_module使用內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

最新評論