fix: inappropriate default timeout of syslog schema#6807
Merged
Conversation
spacewander
previously approved these changes
Apr 8, 2022
spacewander
approved these changes
Apr 8, 2022
leslie-tsang
approved these changes
Apr 10, 2022
shuaijinchao
approved these changes
Apr 10, 2022
Liu-Junlin
pushed a commit
to Liu-Junlin/apisix
that referenced
this pull request
May 20, 2022
spacewander
pushed a commit
that referenced
this pull request
Jun 30, 2022
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
We use 3 as the default timeout configuration in the syslog plugin. This configuration will eventually be used as the timeout configuration of the lua-resty-logger-socket library, and its unit is milliseconds.
It is obviously inappropriate to use 3 milliseconds as the default configuration, because it is easy to trigger a timeout. I think the author of the syslog plugin should have mistakenly thought that the timeout unit in lua-resty-logger-socket is seconds, so 3 is used as the default value.
So this PR modifies the default value to 3000, and clarifies the timeout unit in the documentation.
apisix/apisix/plugins/syslog.lua
Line 36 in 51eec3e
apisix/apisix/plugins/syslog.lua
Lines 90 to 101 in 51eec3e
https://github.com/cloudflare/lua-resty-logger-socket/blob/master/README.md?plain=1#L102-L104
Checklist