bug: hook_conf must be present in debug.yaml, otherwise it will throw an exception

[amrellafy]

Current Behavior

if hook_config is not present, the following exception will be thrown

apisix attempt to index local 'hook_conf' (a nil value)

apisix/apisix/debug.lua

Line 171 in aefffe9

local hook_conf = debug_yaml.hook_conf

should include a check.

Expected Behavior

not throwing an error if hook_conf is not present.

Error Logs

No response

Steps to Reproduce

1. create a debug.yaml
2. do not incude hook_conf

Environment

• APISIX version 2.14.1
• on Docker

[spacewander]

The hook_conf is present by default:

apisix/conf/debug.yaml

Line 22 in 1c33ab2

hook_conf:

Are there some user cases people need to remove the default hook_conf?

[amrellafy]

per the documentation, hook_conf is only required in advanced debugging.

[tzssangglass]

per the documentation, hook_conf is only required in advanced debugging.

hook_conf is part of the debug.yaml structure. Just because it is needed for advanced debugging does not mean that it can be removed if advanced debugging is not enabled.

But we could be clearer on this point in the documentation?

[spacewander]

Or we can add validation to https://github.com/apache/apisix/blob/master/apisix/debug.lua, with jsonschema like https://github.com/apache/apisix/blob/master/apisix/cli/schema.lua.

[amrellafy]

per the documentation, hook_conf is only required in advanced debugging.

hook_conf is part of the debug.yaml structure. Just because it is needed for advanced debugging does not mean that it can be removed if advanced debugging is not enabled.

But we could be clearer on this point in the documentation?

For sure, maybe make it clearer. Thanks!

[spacewander]

Would you like to work for it?

[amrellafy]

Sure, if you get access to push.

[spacewander]

Sure, if you get access to push.

PR is welcome!