Redis Lua脚本调试与日志记录方法

Redis Lua脚本调试中，`redis.log` 是唯一可用的服务端日志工具，但使用限制极严：仅限 `EVAL`/`EVALSHA` 上下文、必须用正确大小写的日志级别常量（如 `redis.LOG_DEBUG`）、参数须为预拼接的字符串（推荐 `string.format` 安全组装），且依赖 `redis.conf` 中 `loglevel` 和可写 `logfile` 配置生效；若日志“消失”，大概率是路径权限、级别设置或 Docker 日志重定向问题；相比脆弱的日志依赖，更高效的做法是本地纯 Lua 模拟调试、结合 `redis-cli --eval` 快速验证，或用临时键存储调试状态——真正阻碍排障的往往不是打不出日志，而是逻辑分支未触发或 `redis.call` 返回值与预期不符，此时构造最小复现场景比盲目加日志更直达本质。

redis.log 函数在 Lua 脚本里到底能不能用？

能，但有严格限制：只有 redis.log 在 Redis 服务器端执行 Lua 脚本时可用，且仅限于 EVAL / EVALSHA 上下文；它不能在客户端或本地 Lua 环境中调用，也不支持格式化字符串（如 printf 风格），只接受固定参数数量和类型。

常见错误现象是脚本返回 (error) ERR Error running script (call to f_...): @user_script:3: user_script:3: attempt to call a nil value (global 'print')——这是因为误用了 print，或把 redis.log 写成了 redis.LOG（大小写敏感）。

• redis.log 第一个参数必须是日志级别常量：redis.LOG_DEBUG、redis.LOG_VERBOSE、redis.LOG_NOTICE、redis.LOG_WARNING、redis.LOG_ERR
• 第二个及以后的参数必须是字符串字面量或可转为字符串的值（如数字、布尔、nil 会被转成 "nil"），但不支持连接符 .. 拼接表达式——必须提前拼好再传入
• Redis 默认只记录 NOTICE 及以上级别到日志文件；若想看到 DEBUG 或 VERBOSE，需在 redis.conf 中设置 loglevel verbose 或 debug，并确保 logfile 路径可写

如何安全地拼接调试信息再传给 redis.log

不能直接写 redis.log(redis.LOG_DEBUG, "key=" .. KEYS[1] .. ", val=" .. ARGV[1])，Lua 解释器会报错：「attempt to concatenate a nil value」或「syntax error」——因为 redis.log 不接受表达式，只接受逗号分隔的独立参数。

正确做法是用 string.format 预先组装成单个字符串：

local msg = string.format("DEBUG: key=%s, len=%d, type=%s", KEYS[1], #ARGV, type(ARGV[1]))
redis.log(redis.LOG_DEBUG, msg)

注意点：

• string.format 是 Redis 内置支持的 Lua 标准库函数，无需额外加载
• 避免在格式串中引用可能为 nil 的变量（如 ARGV[1] 未传时），应先做存在性判断：ARGV[1] and ARGV[1] or "MISSING"
• 日志内容过长（超 1024 字符）会被 Redis 截断，建议控制单条日志在 200 字符内

为什么 redis.log 输出看不到？排查路径和权限

即使脚本执行成功、redis.log 调用无报错，也可能完全不见输出——这通常不是脚本问题，而是服务端配置或环境导致。

• 检查 redis.conf 中 logfile 是否设为绝对路径（如 /var/log/redis/redis-server.log），相对路径（如 redis.log）会写到 Redis 启动时的工作目录，容易找不到
• 确认 Redis 进程对日志文件或其父目录有写权限（常见于 systemd 启动时用户为 redis，但 /var/log/redis 属主是 root）
• 运行 redis-cli CONFIG GET loglevel 确认当前级别是否 ≥ 你用的 redis.LOG_* 级别；动态修改可用 CONFIG SET loglevel verbose（重启后失效）
• 若用 Docker，需挂载日志路径并确认容器内路径可写，且未被 stdout 重定向覆盖（有些镜像默认把日志输出到终端，logfile "" 表示禁用文件日志）

替代方案：本地模拟调试比依赖 redis.log 更可靠

真正难调试的往往是逻辑分支、边界条件或原子性假设，而 redis.log 只能在真实服务端触发，无法单步、不能查变量作用域、也不支持断点。线上开启 DEBUG 级日志还可能引发 I/O 压力或敏感信息泄露。

更务实的做法是：

• 用 redis-cli --eval 在开发机连接本地 Redis 实例跑脚本，配合 loglevel verbose 快速验证
• 把核心逻辑抽成纯 Lua 函数，在本地 Lua 环境（如 lua5.1 或 luajit）中用 print 全量调试，只保留 redis.call 相关部分最后整合
• 对关键状态，改用 redis.call('set', '__dbg_'..math.random(1000), msg) 临时存入 Redis，再用 redis-cli keys '__dbg_*' 查看——比日志更易检索、不依赖配置

真正卡住的往往不是“怎么打日志”，而是“哪条路径没走到”或者“某个 redis.call 返回值和预期不符”——这时候，硬塞 redis.log 不如先在客户端构造最小复现场景，再反推服务端行为。

本篇关于《Redis Lua脚本调试与日志记录方法》的介绍就到此结束啦，但是学无止境，想要了解学习更多关于数据库的相关知识，请关注golang学习网公众号！