nginx 常用日志参数

off999 2025-01-21 20:35 33 浏览 0 评论

Nginx 提供了多种日志参数（变量），可以用来记录请求的不同方面。

常用日志参数

$remote_addr: 客户端的IP地址。
$remote_user: 客户端用户名。
$time_local: 局部时间，格式为 HH:MM:SS。
$request: 完整的请求行，包括请求方法、URI 和 HTTP 版本。
$status: HTTP状态码。
$body_bytes_sent: 发送给客户端的响应体的字节数。
$request_time: 请求处理时间，单位为秒。
$upstream_response_time: 后端服务器响应时间，单位为秒。
$upstream_addr: 后端服务器的地址和端口。
$sent_http_x_accel_redirect: 发送给客户端的 X-Accel-Redirect 响应头的值。
$http_referer: 包含一个 URL，客户端从该 URL 链接到当前请求的页面。
$http_user_agent: 客户端浏览器的 User-Agent 字符串。
$http_cookie: 客户端的 Cookie 信息。
$host: 请求中的 Host 头部。
$request_uri: 不包含查询字符串的请求 URI。
$request_filename: 请求的文件路径。
$request_method: 请求方法（如 GET、POST）。
$scheme: HTTP 方法（如 http、https）。
$request_length: 请求的长度（包括请求行、请求头和请求体）。
$content_length: 请求体的长度。
$args: 与 $uri 相同，包含查询字符串。
$document_uri: 与 $request_uri 相同。
$document_root: 根目录路径。
$server_addr: 服务器地址。
$server_name: 服务器名称。
$server_port: 服务器端口号。
$server_protocol: 请求使用的协议和版本。
$https: 如果使用了 SSL/TLS，则为 "on"。
$connection: 连接序列号。
$connection_requests: 同一连接中的请求数。

自定义日志格式

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

access_log "access.log";

我们这里设置为json日志格式，示例代码如下：

http {
    # 定义JSON格式的日志
    log_format json '{"remote_addr": "$remote_addr", '
                     '"remote_user": "$remote_user", '
                     '"time_local": "$time_local", '
                     '"request": "$request", '
                     '"status": $status, '
                     '"body_bytes_sent": $body_bytes_sent, '
                     '"bytes_sent": $bytes_sent, '
                     '"http_referer": "$http_referer", '
                     '"http_user_agent": "$http_user_agent"}';

    # 应用日志格式到某个server块
    server {
        listen 80;
        server_name example.com;

        access_log /var/log/nginx/access.log json;

        location / {
            root /usr/share/nginx/html;
            index index.html;
        }
    }
}

log_format json ：定义了一个名为 json 的日志格式，其中每个字段都用JSON格式表示。

access_log ：将定义的 json 格式应用到指定的访问日志文件。

body_bytes_sent 和 bytes_sent的区别

body_bytes_sent 和 bytes_sent ，它们记录了响应给客户端数据的不同部分的大小。

bytes_sent：

记录的是发送给客户端的总字节数，包括HTTP头部（headers）和响应体（body）。它表示整个HTTP响应的大小，即从Nginx服务器发送到客户端的所有数据的总和。

body_bytes_sent：

只记录了HTTP响应体的大小，不包括HTTP头部。它仅指实际的数据内容大小，比如网页的内容、图片、文件等。

当你需要知道实际传输的数据量时，例如为了统计下载文件的大小或计算实际传递内容的流量，通常会使用body_bytes_sent。如果你需要了解包括HTTP头部在内的全部传输数据量，例如用于网络带宽分析或评估HTTP头信息对总传输量的影响，那么应该使用bytes_sent。

假设一个HTTP响应包含100字节的头部和500字节的响应体：

bytes_sent 将会是600字节（100字节的头部 + 500字节的响应体）。

body_bytes_sent 则是500字节，仅计算响应体部分。

request_time 和 upstream_time 区别

request_time：

记录的是从Nginx接收到客户端请求开始到Nginx向客户端发送完响应结束的总时间。这个参数包含了客户端请求的接收时间，Nginx处理请求的时间，包括解析请求、查找配置、生成响应等。如果请求被代理到上游服务器（如后端应用服务器），还包括等待上游服务器响应的时间。将响应数据发送回客户端的时间。这个时间可以用来评估整个请求处理周期的性能。

upstream_response_time：

记录的是从Nginx将请求转发给上游服务器开始到Nginx接收到上游服务器的完整响应为止的时间。包含Nginx将请求转发给上游服务器的时间，上游服务器处理请求并生成响应的时间。响应从上游服务器传输回Nginx的时间。这个时间可以用来评估上游服务器的响应性能，不包括Nginx自身的处理时间和客户端的网络延迟。

nginx 分析日志