如何通过log_by_lua实现自定义业务指标打点教程

夏丽小哥_7047

夏丽小哥_7047

2026-05-28

757人浏览

原创

log_by_lua是最常用、最安全的打点阶段,因在响应发出后执行,保证数据完整可靠且不影响性能;适合采集状态码、耗时等指标并上报至Prometheus或StatsD。

如何通过log_by_lua实现自定义业务指标打点教程

在 OpenResty 环境中,log_by_lua 是最常用、最安全的打点阶段——它在请求处理完成、响应已发出后执行,不影响性能和响应逻辑,特别适合采集业务指标(如成功数、耗时、错误码分布等)并上报到 Prometheus、StatsD 或自建日志系统。

为什么选 log_by_lua 而不是 access_by_lua?

access_by_lua 在权限校验、路由匹配前执行,可能因鉴权失败、限流拦截等提前退出,导致打点丢失;而 log_by_lua 保证只要 Nginx 接收过该请求(哪怕返回 401/403/500),就一定会运行,数据更完整可靠。

同时,它不参与响应生成,不会阻塞 client,对吞吐影响极小。

基础打点:记录请求状态与耗时

OpenResty 默认提供 ngx.var.upstream_response_time、ngx.var.status、ngx.var.request_time 等变量,可直接用于统计:

  • 用 ngx.var.request_time 获取总处理时间(秒,精度为毫秒)
  • 用 ngx.var.status 获取最终 HTTP 状态码(如 200、404、500)
  • 用 ngx.var.uri 或 ngx.var.args 提取关键路径或参数(注意脱敏)

示例(写入本地日志):

log_by_lua_block {
  local status = tonumber(ngx.var.status)
  local cost_ms = math.floor(tonumber(ngx.var.request_time) * 1000)
  local uri = ngx.var.uri
  ngx.log(ngx.INFO, string.format("metric: uri=%s status=%d cost_ms=%d", uri, status, cost_ms))
}

进阶打点:聚合计数 + 上报 StatsD/Prometheus

高频打点不宜每请求都 IO 写磁盘或发网络。推荐方式:

  • 使用 lua_shared_dict 做内存计数器(线程安全、进程内共享)
  • 配合定时器(ngx.timer.at)或采样(如每 100 次 flush 一次)批量上报
  • 对接 StatsD(UDP)或通过 resty-prometheus 暴露 /metrics 接口

例如,统计各接口成功率:

lua_shared_dict api_metrics 10m;
log_by_lua_block {
  local dict = ngx.shared.api_metrics
  local key = "status:" .. ngx.var.uri
  dict:incr(key .. ":" .. ngx.var.status, 1)
  dict:incr(key .. ":total", 1)
}

注意事项与避坑指南

  • 禁止在 log_by_lua 中调用阻塞操作:如 os.execute、同步 socket、无超时的 http request
  • 避免变量未定义报错:用 tonumber(ngx.var.xxx) or 0 或 ngx.var.xxx == nil and "default" or ngx.var.xxx
  • 敏感信息必须脱敏:不要记录 ngx.var.args 全量,应只提取必要字段(如 ngx.req.get_uri_args().order_id),且过滤 token、phone、id_card 等
  • 注意 shared_dict 容量和过期:设置合理大小,必要时用 dict:expire(key, 60) 防止内存泄漏
PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

相关标签:

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

相关专题

更多
nginx 重启
nginx 重启

nginx重启对于网站的运维来说是非常重要的,根据不同的需求,可以选择简单重启、平滑重启或定时重启等方式。本专题为大家提供nginx重启的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.27

423

5

nginx 配置详解
nginx 配置详解

Nginx的配置是指设置和调整Nginx服务器的行为和功能的过程。通过配置文件,可以定义虚拟主机、HTTP请求处理、反向代理、缓存和负载均衡等功能。Nginx的配置语法简洁而强大,允许管理员根据自己的需要进行灵活的调整。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3907

6

nginx配置详解
nginx配置详解

NGINX与其他服务类似,因为它具有以特定格式编写的基于文本的配置文件。本专题为大家提供nginx配置相关的文章,大家可以免费学习。

2023.08.04

6705

6

tomcat和nginx有哪些区别
tomcat和nginx有哪些区别

tomcat和nginx的区别:1、应用领域;2、性能;3、功能;4、配置;5、安全性;6、扩展性;7、部署复杂性;8、社区支持;9、成本;10、日志管理。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.02.23

601

5

nginx报404怎么解决
nginx报404怎么解决

当访问 nginx 网页服务器时遇到 404 错误,表明服务器无法找到请求资源,可以通过以下步骤解决:1. 检查文件是否存在且路径正确;2. 检查文件权限并更改为 644 或 755;3. 检查 nginx 配置,确保根目录设置正确、没有冲突配置等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.07.09

1496

5

Nginx报404错误解决方法
Nginx报404错误解决方法

解决方法:只需要加上这段配置:try_files $uri $uri/ /index.html;即可。想了解更多Nginx的相关内容,可以阅读本专题下面的文章。

2024.08.07

3978

3

nginx部署php项目教程汇总
nginx部署php项目教程汇总

本专题整合了nginx部署php项目教程汇总,阅读专题下面的文章了解更多详细内容。

2026.01.13

122

12

nginx配置文件详细教程
nginx配置文件详细教程

本专题整合了nginx配置文件相关教程详细汇总,阅读专题下面的文章了解更多详细内容。

2026.01.13

537

23

Nginx跨平台安装实操指南:Windows、macOS与Linux环境快速搭建
Nginx跨平台安装实操指南:Windows、macOS与Linux环境快速搭建

本指南详解Nginx在Windows、macOS及Linux系统的安装全流程。涵盖官方包解压、Homebrew一键部署、APT/YUM源配置及Docker容器化方案。无论新手或开发者,均可快速搭建运行环境,掌握跨平台核心指令,为后续配置与调优奠定坚实基础。

2026.03.16

179

12

热门下载

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

精品课程

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

共6课时 | 54.7万人学习

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

共89课时 | 134.1万人学习