Add parameters which were missing from the docs - #665
Merged
Conversation
Six parameters are accepted by the plugins but were not described anywhere in the documentation. Users could only find them by reading the plugin source. * formatter/json.md json_parser (0.14.0) * input/exec.md encoding (1.17.1) * input/forward.md backlog (0.10.36) * input/syslog.md source_host_key (0.10.53) * input/tail.md path_delimiter (1.9.1) * parser/multiline.md unmatched_lines (1.9.3) The version column is taken from the commit which introduced each `config_param` and the first release tag containing it, not guessed. Two related fixes on pages touched here: * input/forward.md: `resolve_hostname` cannot be `false` when `source_hostname_key` is set. The wording matches the note which input/syslog.md already has for the same constraint. * input/syslog.md: `include_source_host` assigns `@source_address_key`, so it adds the source *address* under the field name given by `source_host_key`, not the hostname. Signed-off-by: Shizuo Fujita <fujita@clear-code.com>
kenhys
requested changes
Aug 5, 2026
Co-authored-by: Kentaro Hayashi <kenhys@gmail.com> Signed-off-by: Shizuo Fujita <fujita@clear-code.com>
Co-authored-by: Kentaro Hayashi <kenhys@gmail.com> Signed-off-by: Shizuo Fujita <fujita@clear-code.com>
Watson1978
force-pushed
the
docs-undocumented-params
branch
from
August 5, 2026 05:42
c5b8213 to
229dec8
Compare
kenhys
approved these changes
Aug 5, 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.
Six parameters are accepted by the plugins but were not described anywhere in the documentation. Users could only find them by reading the plugin source.
The version column is taken from the commit which introduced each
config_paramand the first release tag containing it, not guessed.Two related fixes on pages touched here:
resolve_hostnamecannot befalsewhensource_hostname_keyis set. The wording matches the note which input/syslog.md already has for the same constraint.include_source_hostassigns@source_address_key, so it adds the source address under the field name given bysource_host_key, not the hostname.