openresty通过lua增加随机traceid

朴灿烈づ我的快乐病毒、 2024-04-17 06:07 82阅读 0赞

在没有引入[zipkin][]（或者阿里的鹰眼，百度的华佗）这种trace系统的时候，排查问题的一般思路都是按照请求链路来寻找问题源。因此如果能在请求链路中有一个唯一的标识就最好了，而在[nginx][]/[openresty][]做接入层的架构中，可以通过lua脚本生成一个随机[traceid][]。

随机数的生成原理，都是先初始化一个随机数种子，由于伪随机数的特性，种子的随机性就显得格外重要，而一般种子的生成都是通过时间的倒序来选取

**lua 随机数生成方法**

首先我们看下通常lua的随机数生成方法

math.randomseed(tonumber(tostring(os.time()):reverse():sub(1,6)))
    math.random(m,n)

通过时间字符串的逆序初始化随机种子，这里注意到有个sub函数做了截断，是因为

`math.randomseed will call the underlying C function srand which takes an unsigned integer valueLua will cast the value of the seed to this format. In case of an overflow the seed will actually become a bad seed, without warning`

所以需要避免出现高类型向低类型转换的溢出问题

**common 方法的问题**

但上面的方法有个问题，就是os.time()函数返回的是秒(10位整数), 所以在做web请求的traceid时很容易就出现重复，影响问题追踪的效率，而lua如果要以毫秒为单位的时间来初始化随机种子，需要引入[socket][]等外部模块，对于openresty来说一般都是封装好的，不方便去做这种定制

**利用openresty 与lua生成traceid**

幸运的是，[nginx][nginx 1]\-lua中有个函数ngx.now会返回一个浮点数（当然在lua中统一为number类型），3位小数即为毫秒位，所以问题就变得简单了

access_by_lua_block {
        math.randomseed(tonumber(tostring(ngx.now()*1000):reverse():sub(1,9)))
        local randvar = string.format("%.0f",math.random(1000000000000000000,9223372036854775807))
        ngx.req.set_header("traceid", randvar)
    }

[zipkin]: https://www.centos.bz/tag/zipkin/
[nginx]: https://www.centos.bz/category/web-server/nginx/
[openresty]: https://www.centos.bz/tag/openresty/
[traceid]: https://www.centos.bz/tag/traceid/
[socket]: https://www.centos.bz/tag/socket/
[nginx 1]: https://www.centos.bz/tag/nginx-2/