nginx + openresty 备忘

nginx的开发者提供了一种简单、粗暴的方式来实现日志文件的切换。来自官网的一篇文章Log Rotation介绍了这种方法，核心脚本如下：

1
2
3
4
5


mv access.log access.log.0
kill -USR1 `cat master.nginx.pid`
sleep 1# 
do something with access.log.0
gzip access.log.0

nginx指令

set_header 设置response header proxy_set_header 设置request header

openresty

request部分 header赋值 ngx.req.set_header(‘X-Credential-Username’, username); header取值 local headers = ngx.req.get_headers(); headers[“X-Credential-Username”]; response部分

Reading ngx.header.HEADER will return the value of the response header named HEADER.

ngx.var.VARIABLE Read and write Nginx variable values. Note that only already defined nginx variables can be written to. For example:

1
2
3
4
5
6
7


 location /foo {
     set $my_var ''; # this line is required to create $my_var at config time
     content_by_lua_block {
         ngx.var.my_var = 123;
         ...
     }
 }

使用 Nginx 内置绑定变量

Nginx作为一个成熟、久经考验的负载均衡软件，与其提供丰富、完整的内置变量是分不开的，它极大增加了对Nginx网络行为的控制细度。这些变量大部分都是在请求进入时解析的，并把他们缓存到请求cycle中，方便下一次获取使用。首先来看看Nginx对都开放了那些API。

参看下表：

名称	说明
$arg_name	请求中的name参数
$args	请求中的参数
$binary_remote_addr	远程地址的二进制表示
$body_bytes_sent	已发送的消息体字节数
$content_length	HTTP请求信息里的”Content-Length”
$content_type	请求信息里的”Content-Type”
$document_root	针对当前请求的根路径设置值
$document_uri	与$uri相同; 比如 /test2/test.php
$host	请求信息中的”Host”，如果请求中没有Host行，则等于设置的服务器名
$hostname	机器名使用 gethostname系统调用的值
$http_cookie	cookie 信息
$http_referer	引用地址
$http_user_agent	客户端代理信息
$http_via	最后一个访问服务器的Ip地址。
$http_x_forwarded_for	相当于网络访问路径
$is_args	如果请求行带有参数，返回“?”，否则返回空字符串
$limit_rate	对连接速率的限制
$nginx_version	当前运行的nginx版本号
$pid	worker进程的PID
$query_string	与$args相同
$realpath_root	按root指令或alias指令算出的当前请求的绝对路径。其中的符号链接都会解析成真是文件路径
$remote_addr	客户端IP地址
$remote_port	客户端端口号
$remote_user	客户端用户名，认证用
$request	用户请求
$request_body	这个变量（0.7.58+）包含请求的主要信息。在使用proxy_pass或fastcgi_pass指令的location中比较有意义
$request_body_file	客户端请求主体信息的临时文件名
$request_completion	如果请求成功，设为”OK”；如果请求未完成或者不是一系列请求中最后一部分则设为空
$request_filename	当前请求的文件路径名，比如/opt/nginx/www/test.php
$request_method	请求的方法，比如”GET”、”POST”等
$request_uri	请求的URI，带参数
$scheme	所用的协议，比如http或者是https
$server_addr	服务器地址，如果没有用listen指明服务器地址，使用这个变量将发起一次系统调用以取得地址(造成资源浪费)
$server_name	请求到达的服务器名
$server_port	请求到达的服务器端口号
$server_protocol	请求的协议版本，”HTTP/1.0”或”HTTP/1.1”
$uri	请求的URI，可能和最初的值有不同，比如经过重定向之类的

其实这还不是全部，Nginx在不停迭代更新是一个原因，还有一个是有些变量太冷门，借助它们，会有很多玩法。

首先，在OpenResty中如何引用这些变量呢？参考 ngx.var.VARIABLE 小节。

利用这些内置变量，来做一个简单的数学求和运算例子：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13


    server {
        listen    80;
        server_name  localhost;

        location /sum {
            #处理业务
           content_by_lua_block {
                local a = tonumber(ngx.var.arg_a) or 0
                local b = tonumber(ngx.var.arg_b) or 0
                ngx.say("sum: ", a + b )
            }
        }
    }

验证一下：

1
2


➜  ~  curl 'http://127.0.0.1/sum?a=11&b=12'
sum: 23

特别注意 access_by_lua_content阶段取不到location中通过proxy_set_header设置的值

ngx.header.HEADER syntax: ngx.header.HEADER = VALUE

syntax: value = ngx.header.HEADER

context: rewrite_by_lua, access_by_lua, content_by_lua, header_filter_by_lua, body_filter_by_lua, log_by_lua

Set, add to, or clear the current request’s HEADER response header that is to be sent.

获取header值和赋值

– equivalent to ngx.header[“Content-Type”] = ‘text/plain’ ngx.header.content_type = ‘text/plain’;

ngx.header[“X-My-Header”] = ‘blah blah’;

文章目录

nginx + openresty 备忘

nginx指令

使用 Nginx 内置绑定变量