nginx 配置记录 http 请求参数的 log 和 nginx 常见的一些内置变量

JAVA herman 56浏览 0评论

在前后端分离的开发过程中,我们经常会遇到一些莫名其妙的问题。比如:后端开发在 Swagger 上对接口进行测试没有问题,而前端或者 APP 端一调用就出问题。A 说 A 没错,B 说 B 没错。请求参数都是按照要求进行传递的,那到底是谁的错呢?

为了解决这个问题,我们一般会进行抓包,但是抓包呢有时候不太好使用,比如针对 NAT 的情况,以及 MAC 等环境下,不太好抓。也有人说,在后端将具体的请求参数打印 log,看看 log 就可以了。但是这样做太麻烦了,我将每个接口都打印一下 log,或者说为了 log,我需要重新发一个版本,虽然是在测试环境。频繁的发版并不好,且不说一些应用,编译一下,部署一下,启动一下半天就过去了。那说了这么多该到底怎么解决呢?

答案就是本文的主题,使用 nginx 或者 tomcat 记录每个请求的请求头加参数信息。这样在测试环境中所有的接口,所有的请求都可以获取到。

在 nginx 中配置下面的信息即可实现请求参数的日志打印。

log_format access '$remote_addr - $remote_user [$time_local] "$request" '
'$status $body_bytes_sent "$http_referer" '
'"$http_user_agent" $http_x_forwarded_for';
access_log /var/log/51yip.log access;

这段配置,可以记录用户 ip,用户真实 ip,用户访问时间,用户访问的游览器信息等。以 $ 开头的变量都是 nginx 自带的一些变量。这些变量还有很多,通称为内置变量。下面是罗列的一些常见的内置变量:

  • $arg_PARAMETER 这个变量包含在查询字符串时GET请求PARAMETER的值。
  • $args 这个变量等于请求行中的参数。
  • $binary_remote_addr 二进制码形式的客户端地址。
  • $body_bytes_sent
  • $content_length 请求头中的Content-length字段。
  • $content_type 请求头中的Content-Type字段。
  • $cookie_COOKIE cookie COOKIE的值。
  • $document_root 当前请求在root指令中指定的值。
  • $document_uri 与$uri相同。
  • $host 请求中的主机头字段,如果请求中的主机头不可用,则为服务器处理请求的服务器名称。
  • $is_args 如果$args设置,值为"?",否则为""。
  • $limit_rate 这个变量可以限制连接速率。
  • $nginx_version 当前运行的nginx版本号。
  • $query_string 与$args相同。
  • $remote_addr 客户端的IP地址。
  • $remote_port 客户端的端口。
  • $remote_user 已经经过Auth Basic Module验证的用户名。
  • $request_filename 当前连接请求的文件路径,由root或alias指令与URI请求生成。
  • $request_body 这个变量(0.7.58+)包含请求的主要信息。在使用proxy_pass或fastcgi_pass指令的location中比较有意义。
  • $request_body_file 客户端请求主体信息的临时文件名。
  • $request_completion 请求完成
  • $request_method 这个变量是客户端请求的动作,通常为GET或POST。包括0.8.20及之前的版本中,这个变量总为main request中的动作,如果当前请求是一个子请求,并不使用这个当前请求的动作。
  • $request_uri 这个变量等于包含一些客户端请求参数的原始URI,它无法修改,请查看$uri更改或重写URI。
  • $schemeHTTP 方法(如http,https)。按需使用,例:rewrite ^(.+)$ $scheme://example.com$1 redirect;
  • $server_addr 服务器地址,在完成一次系统调用后可以确定这个值,如果要绕开系统调用,则必须在listen中指定地址并且使用bind参数。
  • $server_name 服务器名称。
  • $server_port 请求到达服务器的端口号。
  • $server_protocol 请求使用的协议,通常是HTTP/1.0或HTTP/1.1。
  • $uri 请求中的当前URI(不带请求参数,参数位于$args),可以不同于浏览器传递的$request_uri的值,它可以通过内部重定向,或者使用index指令进行修改。

这只是一些常用的内置变量,还有很多不常用的,建议大家查看官方文档。

业余草公众号

最后,欢迎关注我的个人微信公众号:业余草(yyucao)!可加QQ1群:135430763,QQ2群:454796847,QQ3群:187424846。QQ群进群密码:xttblog,想加微信群的朋友,可以微信搜索:xmtxtt,备注:“xttblog”,添加助理微信拉你进群。备注错误不会同意好友申请。再次感谢您的关注!后续有精彩内容会第一时间发给您!原创文章投稿请发送至532009913@qq.com邮箱。商务合作可添加助理微信进行沟通!

本文原文出处:业余草: » nginx 配置记录 http 请求参数的 log 和 nginx 常见的一些内置变量