Debian Nginx日志格式自定义技巧

Debian 下 Nginx 日志格式自定义技巧

一基础配置步骤

在 /etc/nginx/nginx.conf 的 http { } 段使用 log_format 定义格式名称与内容；在 server 或 location 段用 access_log 指定日志路径与格式名称；如需关闭访问日志可用 access_log off;。完成后执行 sudo nginx -t 校验，再 sudo systemctl reload nginx 生效。示例：

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

    server {
        listen 80;
        server_name example.com;
        access_log /var/log/nginx/example.com.access.log main;
        error_log  /var/log/nginx/example.com.error.log;
        location / { root /var/www/html; index index.html; }
    }
}

以上路径、指令与生效方式均为 Debian 环境的通用做法。

二常用变量与格式模板

常用变量速览（按需挑选组合）：
- 客户端与请求：$remote_addr, $remote_user, $time_local, $time_iso8601, $request, $request_uri, $uri, $host, $http_user_agent, $http_referer, $http_x_forwarded_for
- 响应与传输：$status, $body_bytes_sent, $bytes_sent, $request_length
- 时间与性能：$request_time, $upstream_response_time, $upstream_connect_time, $upstream_header_time
- SSL：$ssl_protocol, $ssl_cipher
- 其它：$msec, $pipe

实用模板示例：

带上游耗时的扩展格式（便于定位后端瓶颈）

log_format upstream_time '$remote_addr - $remote_user [$time_local] "$request" '
                      '$status $body_bytes_sent "$http_referer" "$http_user_agent" '
                      'rt=$request_time uct="$upstream_connect_time" '
                      'uht="$upstream_header_time" urt="$upstream_response_time"';

JSON 结构化（便于 ELK 等系统解析）

log_format json_log escape=json
  '{'
  '"@timestamp":"$time_iso8601",'
  '"client":"$remote_addr",'
  '"method":"$request_method",'
  '"uri":"$request_uri",'
  '"status":$status,'
  '"size":$body_bytes_sent,'
  '"responsetime":$request_time,'
  '"upstreamtime":"$upstream_response_time",'
  '"xff":"$http_x_forwarded_for",'
  '"referer":"$http_referer",'
  '"ua":"$http_user_agent"'
  '}';

变量含义与模板写法可参考 Nginx 常用变量与官方指令说明。

三高级用法与性能优化

条件与多路日志：在不同 location 记录不同日志，或对特定条件关闭日志（如静态资源）。示例：

server {
    access_log /var/log/nginx/access.log main;
    location /static/ {
        access_log off;
    }
    location /api/ {
        access_log /var/log/nginx/api.access.log main;
    }
}

缓冲、压缩与刷新：提升高并发写入性能与磁盘占用效率。

access_log /var/log/nginx/access.log main
            buffer=32k gzip flush=1m;

动态路径与文件句柄缓存：当 access_log 路径包含变量时，建议开启 open_log_file_cache 减少频繁打开关闭文件的开销。
```
open_log_file_cache max=1000 inactive=20s valid=1m min_uses=2;
```
错误日志级别与调试：错误日志不支持自定义格式，但可按需调整级别；仅对特定连接输出调试日志可用 debug_connection。
```
error_log /var/log/nginx/error.log warn;
events {
    debug_connection 192.0.2.10;
}
```
以上用法均为 Nginx 标准指令能力，适用于 Debian 的默认安装形态。

四日志轮转与运维建议

使用 logrotate 管理日志滚动，避免单文件过大。Debian 常见做法：创建 /etc/logrotate.d/nginx，内容示例：

/var/log/nginx/*.log {
    daily
    missingok
    rotate 7
    compress
    delaycompress
    notifempty
    create 0640 www-data adm
    sharedscripts
    postrotate
        if [ -f /var/run/nginx.pid ]; then
            kill -USR1 $(cat /var/run/nginx.pid)
        fi
    endscript
}

说明：daily 每天轮转；rotate 7 保留 7 份；compress 压缩旧日志；postrotate 向 Nginx 发送 USR1 信号让其重新打开日志文件。

变更流程与验证：每次修改日志格式或路径后，先 sudo nginx -t，再 sudo systemctl reload nginx；用 tail -f /var/log/nginx/*.log 实时观察输出是否符合预期。

最新问答

相关标签