在 Redis 中调试 Lua 脚本

如何使用内置 Lua 调试器

从 3.2 版本开始，Redis 包含一个完整的 Lua 调试器，可用于简化编写复杂 Redis 脚本的任务。

Redis Lua 调试器（代号为 LDB）具有以下重要功能

  • 它使用服务器-客户端模型，因此它是一个远程调试器。Redis 服务器充当调试服务器，而默认客户端是 redis-cli。但是，可以通过遵循服务器实现的简单协议来开发其他客户端。
  • 默认情况下，每个新的调试会话都是一个分叉会话。这意味着在调试 Redis Lua 脚本时，服务器不会阻塞，并且可用于开发或并行执行多个调试会话。这也意味着在脚本调试会话完成后，更改将回滚，因此可以使用与前一个调试会话完全相同的数据集重新启动新的调试会话。
  • 可按需使用替代的同步（非分叉）调试模型，以便保留对数据集的更改。在此模式下，服务器在调试会话处于活动状态时会阻塞。
  • 支持逐步执行。
  • 支持静态和动态断点。
  • 支持将调试脚本记录到调试器控制台。
  • 检查 Lua 变量。
  • 跟踪脚本执行的 Redis 命令。
  • 以美观的方式打印 Redis 和 Lua 值。
  • 检测无限循环和长时间执行，模拟断点。

快速开始

开始使用 Lua 调试器的简单方法是观看此视频介绍

重要提示：请务必避免使用 Redis 生产服务器调试 Lua 脚本。请改用开发服务器。另请注意，使用同步调试模式（非默认模式）会导致 Redis 服务器在整个调试会话期间一直处于阻塞状态。

若要使用 redis-cli 启动新的调试会话，请执行以下操作

  1. 使用首选编辑器在某个文件中创建脚本。假设您正在编辑位于 /tmp/script.lua 的 Redis Lua 脚本。

  2. 使用以下命令启动调试会话

    ./redis-cli --ldb --eval /tmp/script.lua

请注意，使用 redis-cli 的 --eval 选项可以将键名和参数传递给脚本，并用逗号分隔，如下例所示

./redis-cli --ldb --eval /tmp/script.lua mykey somekey , arg1 arg2

您将进入一种特殊模式，在该模式下 redis-cli 不再接受其正常命令，而是打印一个帮助屏幕，并将未修改的调试命令直接传递给 Redis。

未传递给 Redis 调试器的唯一命令是

  • quit -- 这将终止调试会话。这就像删除所有断点并使用 continue 调试命令一样。此外，该命令将退出 redis-cli。
  • restart -- 调试会话将从头开始重新启动，从文件中重新加载脚本的新版本。因此，正常的调试周期包括在进行一些调试后修改脚本，然后调用 restart 以使用新的脚本更改重新开始调试。
  • help -- 此命令传递给 Redis Lua 调试器，它将打印以下命令列表
lua debugger> help
Redis Lua debugger help:
[h]elp               Show this help.
[s]tep               Run current line and stop again.
[n]ext               Alias for step.
[c]ontinue           Run till next breakpoint.
[l]ist               List source code around current line.
[l]ist [line]        List source code around [line].
                     line = 0 means: current position.
[l]ist [line] [ctx]  In this form [ctx] specifies how many lines
                     to show before/after [line].
[w]hole              List all source code. Alias for 'list 1 1000000'.
[p]rint              Show all the local variables.
[p]rint <var>        Show the value of the specified variable.
                     Can also show global vars KEYS and ARGV.
[b]reak              Show all breakpoints.
[b]reak <line>       Add a breakpoint to the specified line.
[b]reak -<line>      Remove breakpoint from the specified line.
[b]reak 0            Remove all breakpoints.
[t]race              Show a backtrace.
[e]val <code>        Execute some Lua code (in a different callframe).
[r]edis <cmd>        Execute a Redis command.
[m]axlen [len]       Trim logged Redis replies and Lua var dumps to len.
                     Specifying zero as <len> means unlimited.
[a]bort              Stop the execution of the script. In sync
                     mode dataset changes will be retained.

Debugger functions you can call from Lua scripts:
redis.debug()        Produce logs in the debugger console.
redis.breakpoint()   Stop execution as if there was a breakpoint in the
                     next line of code.

请注意，当您启动调试器时，它将以单步模式启动。它将在实际执行脚本的第一行代码之前停止。

从这一点开始，您通常调用step以执行该行并转到下一行。当您单步执行时，Redis 将显示服务器执行的所有命令，如下例所示

* Stopped at 1, stop reason = step over
-> 1   redis.call('ping')
lua debugger> step
<redis> ping
<reply> "+PONG"
* Stopped at 2, stop reason = step over

<redis> 和 <reply> 行显示刚刚执行的行执行的命令以及服务器的答复。请注意，这仅在单步模式下发生。如果您使用 continue 以执行脚本直到下一个断点，则不会将命令转储到屏幕上以防止输出过多。

调试会话终止

当脚本自然终止时，调试会话结束，redis-cli 返回其正常的非调试模式。您可以像往常一样使用 restart 命令重新启动会话。

停止调试会话的另一种方法是通过按 Ctrl+C 手动中断 redis-cli。请注意，任何中断 redis-cli 和 redis-server 之间连接的事件也会中断调试会话。

当服务器关闭时，所有已分叉的调试会话都将终止。

缩写调试命令

调试可能是一项非常重复的任务。出于此原因，每个 Redis 调试器命令都以不同的字符开头，您可以使用单个初始字符来引用该命令。

因此，例如，您可以只键入 s 而不是键入 step。

断点

如在线帮助中所述，添加和删除断点非常简单。只需使用 b 1 2 3 4 在第 1、2、3、4 行添加断点。命令 b 0 删除所有断点。可以使用要删除的断点所在的行作为参数来删除选定的断点，但前面加上减号。因此，例如 b -3 从第 3 行删除断点。

请注意，将断点添加到 Lua 从不执行的行（如局部变量的声明或注释）将不起作用。将添加断点，但由于脚本的这一部分永远不会执行，因此程序永远不会停止。

动态断点

使用 breakpoint 命令，可以将断点添加到特定行中。但是，有时我们只希望在发生特殊情况时停止程序执行。为此，您可以在 Lua 脚本中使用 redis.breakpoint() 函数。调用时，它模拟将在下一行执行的断点。

if counter > 10 then redis.breakpoint() end

此功能在调试时非常有用，这样我们就可以避免在遇到给定条件之前多次手动继续脚本执行。

同步模式

如前所述，但默认 LDB 使用分叉会话，回滚脚本在调试期间操作的所有数据更改。确定性通常是调试中一件好事，这样可以启动连续的调试会话，而无需将数据库内容重置为其原始状态。

但是，为了跟踪某些错误，您可能希望保留每个调试会话对键空间执行的更改。当这是一个好主意时，您应该使用特殊选项 ldb-sync-mode 在 redis-cli 中启动调试器。

./redis-cli --ldb-sync-mode --eval /tmp/script.lua

注意：在此模式下，在调试会话期间无法访问 Redis 服务器，因此请谨慎使用。

在此特殊模式下，abort 命令可以中途停止脚本，获取对数据集操作的更改。请注意，这与正常结束调试会话不同。如果您只是中断 redis-cli，则脚本将完全执行，然后会话终止。相反，使用 abort，您可以在中间中断脚本执行，并在需要时启动新的调试会话。

从脚本记录

redis.debug() 命令是一个强大的调试功能，可以在 Redis Lua 脚本中调用，以便将内容记录到调试控制台中

lua debugger> list
-> 1   local a = {1,2,3}
   2   local b = false
   3   redis.debug(a,b)
lua debugger> continue
<debug> line 3: {1; 2; 3}, false

如果在调试会话之外执行脚本，则 redis.debug() 没有任何效果。请注意，该函数接受多个参数，这些参数在输出中用逗号和空格分隔。

正确显示表格和嵌套表格，以便程序员调试脚本时可以轻松观察值。

使用 print 和 eval 检查程序状态

虽然 redis.debug() 函数可用于直接从 Lua 脚本中打印值，但通常在逐步执行或停止在断点时观察程序的局部变量很有用。

print 命令正是如此，它从当前调用帧开始向后到前一个调用帧执行查找，直到顶级。这意味着即使我们在 Lua 脚本中的嵌套函数中，我们仍然可以使用 print foo 来查看调用函数上下文中 foo 的值。当不带变量名称调用时，print 将打印所有变量及其各自的值。

eval 命令执行小段 Lua 脚本（不在当前调用帧的上下文中（使用当前 Lua 内部在当前调用帧的上下文中求值是不可能的）。但是，您可以使用此命令来测试 Lua 函数。

lua debugger> e redis.sha1hex('foo')
<retval> "0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33"

调试客户端

LDB 使用客户端-服务器模型，其中 Redis 服务器充当调试服务器，使用 RESP 进行通信。虽然 redis-cli 是默认调试客户端，但只要满足以下条件之一，任何 客户端 都可用于调试

  1. 客户端提供用于设置调试模式和控制调试会话的本机接口。
  2. 客户端提供用于通过 RESP 发送任意命令的接口。
  3. 客户端允许向 Redis 服务器发送原始消息。

例如，Redis 插件 适用于 ZeroBrane Studio，使用 redis-lua 与 LDB 集成。以下 Lua 代码是插件如何实现这一目标的简化示例

local redis = require 'redis'

-- add LDB's Continue command
redis.commands['ldbcontinue'] = redis.command('C')

-- script to be debugged
local script = [[
  local x, y = tonumber(ARGV[1]), tonumber(ARGV[2])
  local result = x * y
  return result
]]

local client = redis.connect('127.0.0.1', 6379)
client:script("DEBUG", "YES")
print(unpack(client:eval(script, 0, 6, 9)))
client:ldbcontinue()
对本页面评分