利用nginx+lua实现通用的请求输入输出日志打印

利用nginx+lua实现通用的请求输入输出日志打印

nginx+lua在web开发中现在越来越多用于实现一些公共策略逻辑，比如防攻击等，nginx有着高性能高并发的处理框架，lua语言开发也简单，这次我们尝试在nginx层用lua实现我们请求日志的打印。

在开发调试、问题排查中，日志信息很重要，尤其是一个请求的输入及输出信息，但nginx本身的日志定义不能打印输出信息及POST参数，我们往往会在后端业务代码中（如用PHP）打印一个这样的notice日志，不过也可以在nginx中用lua中实现，所有经过这个nginx的请求日志都会按你想要的格式打印出来，这样实现简单而且统一。下面介绍下我在nginx中用lua实现的一个日志打印脚本。

nginx+lua的具体开发教程见这里 https://github.com/openresty/lua-nginx-module，我就不介绍了，下面主要是介绍一下实现代码：

我们要建立nginx各个处理阶段的代码文件，首先创建一个access.lua文件，代码如下：

if ngx.var.log_val ~= nil then
    local request = "["..ngx.var.time_local.."] ".."\""..ngx.var.request_method.." "..ngx.var.scheme.."://"..
                     ngx.var.host..ngx.var.request_uri.."\""
    local post = ""
    local delimiter = ""
    local item = ""
    ngx.req.read_body()
    local args, err = ngx.req.get_post_args()
    if args then
        for key, val in pairs(args) do
           item = ""
           if type(val) == "string" then
               key =  string.gsub(key,"%c"," ")
               val = string.gsub(val,"%c"," ")
               item = key.."="..val
           elseif type(val) == "table" then
               item = key.."="
               local tstr = "";
               local tdelimiter = ""
               for k, v in pairs(val) do
                   if type(v) == "string" then
                      tstr = tstr..tdelimiter..v
                      tdelimiter = ','
                   end
               end
               item = item..tstr
           end
           post = post..delimiter..item
           delimiter = "&"
        end
    end

    ngx.var.log_val = request.."      ".."  postdata=["..post.."]   output=["
end

这个文件主要是记录请求的时间、url及输入参数等信息，包括post数据

接着创建一个body_filter.lua文件，内容如下：

if ngx.var.log_val ~= nil then
    local newcontent = string.gsub(ngx.arg[1],"%c"," ")
    ngx.var.log_val = ngx.var.log_val..newcontent
end

这里记录输出信息，开发中发现ngx.arg[1]与任何字符串进行连接的话，日志打印都会打印两次，除了与内置log_val变量连接，原因可能跟内部跳转有关，所以这里就两行代码，不会有更多其它操作。

再创建一个log.lua文件，内容如下：

if ngx.var.log_val ~= nil then
    function mylog(msg)
        file = io.open ("/home/rong/nginx/logs/monitor.log","a+")
        file:write (msg)
        file:flush();
        file:close();
    end

    ngx.var.log_val = ngx.var.log_val.."]      httpstatus="..
                      ngx.var.status.." request_time="..ngx.var.request_time.."\n"
    mylog(ngx.var.log_val)
end

这里将拼接起来的各个日志信息写入文件。

创建了各个阶段的处理文件，将其加入nginx配置文件中，如下：

 ......
 access_by_lua_file /home/rong/nginx/conf/access.lua;
 body_filter_by_lua_file /home/rong/nginx/conf/body_filter.lua;
 log_by_lua_file /home/rong/nginx/conf/log.lua;
 .....

注意nginx配置中 client_body_buffer_size 与 client_max_body_size的值要设得一样大，且不能过小。

最后还要在server段定义一个变量，作为存储每条日志信息用

server{
     ......
     set $log_val '';
     ......
}

这样，有请求过来时，在 /home/rong/nginx/logs/monitor.log文件 中就可以很清楚地看到输入输出信息了。