如何从自定义Nginx模块写入Access Log？

首先明确几个核心点：

• ngx_log_debug0/ngx_log_error等系列函数仅用于写入Error Log，和Access Log完全无关，你之前的尝试方向错误。
• Access Log是请求级别的日志，仅能在HTTP请求的上下文（即持有ngx_http_request_t *r的函数）中写入，配置加载阶段（postconfiguration函数，持有ngx_conf_t *cf）没有请求实例，无法操作Access Log。

正确实现方式：自定义日志变量（推荐） #

Nginx的Access Log由ngx_http_log_module管理，标准做法是通过自定义日志变量，让Access Log在请求结束时自动包含你的自定义内容，步骤如下：

1. 在模块中注册自定义变量 #

首先在你的模块定义中添加自定义变量的相关代码：

// 自定义变量的key
static ngx_str_t ngx_http_my_custom_msg_key = ngx_string("my_custom_msg");

// 变量数组，最后以空元素结尾
static ngx_http_variable_t ngx_http_my_variables[] = {
    {
        ngx_http_my_custom_msg_key,  // 变量名（$my_custom_msg）
        NULL,                        // setter函数（可选）
        ngx_http_my_custom_msg_get,  // getter函数
        0,                           // 标志位
        0,                           // 数据长度
        0                            // 自定义数据
    },
    { ngx_null_string, NULL, NULL, 0, 0, 0 }
};

// 模块上下文的结构体（需提前定义）
typedef struct {
    ngx_str_t custom_msg;  // 存储自定义日志内容
} ngx_http_my_ctx_t;

2. 实现变量的getter函数 #

这个函数负责从请求上下文中取出你设置的自定义内容：

static ngx_int_t ngx_http_my_custom_msg_get(ngx_http_request_t *r, ngx_http_variable_value_t *v, uintptr_t data) {
    ngx_http_my_ctx_t *ctx = ngx_http_get_module_ctx(r, ngx_http_my_module);
    
    if (ctx && ctx->custom_msg.len > 0) {
        v->len = ctx->custom_msg.len;
        v->data = ctx->custom_msg.data;
        v->valid = 1;
        v->no_cacheable = 0;
        v->not_found = 0;
    } else {
        v->not_found = 1;
    }
    
    return NGX_OK;
}

3. 在请求处理函数中设置自定义内容 #

在你的my_function中，给请求上下文的custom_msg赋值：

ngx_int_t my_function(ngx_http_request_t *r) {
    // 获取或创建模块上下文
    ngx_http_my_ctx_t *ctx = ngx_http_get_module_ctx(r, ngx_http_my_module);
    if (!ctx) {
        ctx = ngx_pcalloc(r->pool, sizeof(ngx_http_my_ctx_t));
        if (!ctx) {
            return NGX_HTTP_INTERNAL_SERVER_ERROR;
        }
        ngx_http_set_module_ctx(r, ngx_http_my_module, ctx);
    }
    
    // 设置要写入Access Log的自定义内容
    ctx->custom_msg = ngx_string("your custom access log content here");
    
    // 其他请求处理逻辑...
    return NGX_HTTP_OK;
}

4. 在nginx.conf中配置Access Log包含自定义变量 #

修改你的access_log配置，添加$my_custom_msg变量：

access_log /var/log/nginx/access.log combined "$remote_addr - $remote_user [$time_local] \"$request\" $status $body_bytes_sent \"$http_referer\" \"$http_user_agent\" \"$my_custom_msg\"";

补充说明 #

• 如果要手动触发Access Log写入（不推荐，可能导致重复日志），可以调用ngx_http_log_request(r)，但前提是请求的日志处理链已经正确初始化，且需确保不会和默认的日志流程冲突。
• 配置阶段（postconfiguration）无法写入Access Log，因为此时还没有任何HTTP请求被处理，Access Log的本质是记录请求的处理结果，必须绑定到具体请求。

内容的提问来源于stack exchange，提问作者Hiero