如何通过 location 块 的 log_by_lua 实现自定义的业务指标打点

云浩吖_3486

云浩吖_3486

2026-05-13

954人浏览

原创

log_by_lua是OpenResty请求生命周期最后阶段,适合无阻塞打点;支持读变量、shared dict计数、本地日志、UDP发指标;需配合lua_shared_dict声明字典,按路径/状态码/耗时分桶统计,并可结合query/header/cookie提取业务维度,最终通过/metrics导出至Prometheus。

如何通过 location 块 的 log_by_lua 实现自定义的业务指标打点

在 OpenResty 中,log_by_lua 是请求生命周期的最后阶段(响应已发出但连接尚未关闭),非常适合做轻量级、无阻塞的业务指标打点。配合 location 块使用,可以精准按路由维度采集指标,比如接口成功率、耗时、业务状态码等。

明确 log_by_lua 的执行时机和限制

log_by_lua 在 Nginx worker 进程中同步执行,不支持 I/O 操作(如 ngx.sleep、ngx.socket.tcp),也不能修改响应头或 body。它适合做:

  • 读取已生成的变量(如 ngx.var.status、ngx.var.upstream_status、自定义 $arg_* 或 $cookie_*)
  • 调用 ngx.shared.DICT:incr() 累加共享内存计数器
  • 写入本地日志文件(通过 ngx.log,注意级别和频率)
  • 向 UDP 端口发指标(需提前配置 lua_socket_udp_connect_timeout 等,且必须是非阻塞发送)

用 shared dict 实现低开销实时计数

这是最常用、最高效的方式。先在 http 块声明共享字典:

lua_shared_dict biz_metrics 10m;

再在目标 location 中使用:

location /api/order/pay {
    # ... upstream / rewrite 等逻辑
    log_by_lua_block {
        local dict = ngx.shared.biz_metrics
        local status = tonumber(ngx.var.status) or 0
        local path = ngx.var.uri
        local cost = tonumber(ngx.var.request_time) * 1000  -- ms
<pre class="brush:php;toolbar:false;">    -- 按状态码分类计数
    dict:incr("status_" .. status, 1)

    -- 按路径 + 状态码二维统计
    dict:incr("path_status:" .. path .. ":" .. status, 1)

    -- 耗时分桶(如 0-100ms、100-500ms)
    if cost <p>}</p>

结合业务参数提取关键维度

很多指标需要依赖请求中的业务字段,例如订单 ID、用户等级、渠道来源。只要这些字段在 log_by_lua 阶段仍可访问,就能打点:

  • Query 参数:用 ngx.var.arg_order_id、ngx.var.arg_channel
  • Header 字段:用 ngx.req.get_headers()["x-user-level"](注意大小写归一化)
  • Cookie:用 ngx.var.cookie_uid 或解析 ngx.var.http_cookie
  • Upstream 返回头:如果 upstream 设置了 add_header X-Biz-Code 2001,可用 ngx.var.upstream_http_x_biz_code

示例:统计不同渠道的支付失败率

log_by_lua_block {
    local channel = ngx.var.arg_channel or "unknown"
    local status = tonumber(ngx.var.status)
    local dict = ngx.shared.biz_metrics
<pre class="brush:php;toolbar:false;">dict:incr("channel_req:" .. channel, 1)
if status ~= 200 then
    dict:incr("channel_fail:" .. channel, 1)
end

}

导出指标到外部系统(如 Prometheus)

shared dict 本身不暴露 HTTP 接口,需配合 prometheus.lua(OpenResty 官方库)或自定义 /metrics location 拉取:

location /metrics {
    content_by_lua_block {
        local prometheus = require "prometheus"
        local metric = prometheus:new("biz_metrics")
        local dict = ngx.shared.biz_metrics
<pre class="brush:php;toolbar:false;">    -- 把 shared dict 中的 key 映射为 Prometheus 指标
    for key, val in dict:get_keys(0) do
        if type(val) == "number" and key:match("^status_") then
            metric:counter(key, "Business status count"):set(val)
        end
    end

    metric:collect()
}

}

然后用 Prometheus 的 scrape_configs 定期拉取该 endpoint 即可。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3709

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2468

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1400

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1338

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1436

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2398

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3980

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

18855

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.1万人学习