in_http: document undocumented parameters and Plugin Helpers - #668
Merged
Conversation
Four parameters are accepted by in_http but were not described anywhere
in the documentation, and the page had no Plugin Helpers section at all
even though every other input plugin page has one.
* backlog (0.10.36) integer, nil
* dump_error_log (1.11.1) bool, true
* add_query_params (1.12.0) bool, false
* add_tag_prefix (1.18.0) string, nil
Notes on the descriptions:
* backlog reuses the wording added to input/forward.md, because both
plugins pass the value to server_create_connection and end up at
Addrinfo#listen, whose default is Socket::SOMAXCONN.
* dump_error_log only suppresses the log.error calls on the 400 and 500
paths. The response to the client is unchanged, so the text says so.
* add_query_params applies the same name conversion as add_http_headers
(k.tr('-','_').upcase), so the text points at that parameter and gives
?user-id=1 to QUERY_USER_ID as an example.
* add_tag_prefix raises a configuration error on an empty value.
Plugin Helpers lists the four helpers declared in in_http.rb in
declaration order: parser, compat_parameters, event_loop, server.
Signed-off-by: Shizuo Fujita <fujita@clear-code.com>
kenhys
approved these changes
Aug 7, 2026
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
2 participants
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.
Four parameters are accepted by
in_httpbut were not described anywhere in the documentation, and the page had no Plugin Helpers section at all even though every other input plugin page has one.backlog(0.10.36)integer,nildump_error_log(1.11.1)bool,trueadd_query_params(1.12.0)bool,falseadd_tag_prefix(1.18.0)string,nilNotes on the descriptions:
backlogreuses the wording added toinput/forward.md, because both plugins pass the value to server_create_connection and end up atAddrinfo#listen, whose default isSocket::SOMAXCONN.dump_error_logonly suppresses the log.error calls on the 400 and 500 paths. The response to the client is unchanged, so the text says so.add_query_paramsapplies the same name conversion asadd_http_headers(k.tr('-','_').upcase), so the text points at that parameter and gives?user-id=1toQUERY_USER_IDas an example.add_tag_prefixraises a configuration error on an empty value.Plugin Helpers lists the four helpers declared in
in_http.rbin declaration order:parser,compat_parameters,event_loop,server.