Debug Mode
基本调试模式
设置 conf/debug.yaml
即可开启基本调试模式:
basic:
enable: true
注意:在 APISIX 2.10 之前,开启基本调试模式曾经是设置 conf/config.yaml
中的 apisix.enable_debug
为 true
。
比如对 /hello
开启了 limit-conn
和 limit-count
插件,这时候应答头中会有 Apisix-Plugins: limit-conn, limit-count
。
$ curl http://127.0.0.1:1984/hello -i
HTTP/1.1 200 OK
Content-Type: text/plain
Transfer-Encoding: chunked
Connection: keep-alive
Apisix-Plugins: limit-conn, limit-count
X-RateLimit-Limit: 2
X-RateLimit-Remaining: 1
Server: openresty
hello world
如果这个信息无法通过 HTTP 应答头传递,比如插件在 stream 子系统里面执行, 那么这个信息会以 warn 等级日志写入到错误日志中。
高级调试模式
设置 conf/debug.yaml
中的选项,开启高级调试模式。由于 APISIX 服务启动后是每秒定期检查该文件, 当可以正常读取到 #END
结尾时,才认为文件处于写完关闭状态。
根据文件最后修改时间判断文件内容是否有变化,如有变化则重新加载,如没变化则跳过本次检查。 所以高级调试模式的开启、关闭都是热更新方式完成。
名称 | 必选项 | 说明 | 默认值 |
---|---|---|---|
hook_conf.enable | 是 | 是否开启 hook 追踪调试。开启后将打印指定模块方法的请求参数或返回值。 | false |
hook_conf.name | 是 | 开启 hook 追踪调试的模块列表名称。 | |
hook_conf.log_level | 是 | 打印请求参数和返回值的日志级别。 | warn |
hook_conf.is_print_input_args | 是 | 是否打印输入参数。 | true |
hook_conf.is_print_return_value | 是 | 是否打印返回值。 | true |
请看下面示例:
hook_conf:
enable: false # 是否开启 hook 追踪调试
name: hook_phase # 开启 hook 追踪调试的模块列表名称
log_level: warn # 日志级别
is_print_input_args: true # 是否打印输入参数
is_print_return_value: true # 是否打印返回值
hook_phase: # 模块函数列表,名字:hook_phase
apisix: # 引用的模块名称
- http_access_phase # 函数名:数组
- http_header_filter_phase
- http_body_filter_phase
- http_log_phase
#END
动态高级调试模式
动态高级调试模式是基于高级调试模式,可以由单个请求动态开启高级调试模式。设置 conf/debug.yaml
中的选项。
示例:
http_filter:
enable: true # 是否动态开启高级调试模式
enable_header_name: X-APISIX-Dynamic-Debug # 追踪携带此 header 的请求
......
#END
动态开启高级调试模式,示例:
curl 127.0.0.1:9090/hello --header 'X-APISIX-Dynamic-Debug: foo'
注意:动态高级调试模式无法调试 apisix.http_access_phase
, 模块(因为请求进入 apisix.http_access_phase
模块后,才会判断是否动态开启高级调试模式)。