Fix parameter default value and type#648
Merged
Merged
Conversation
Four mismatches found by comparing config_param declarations in fluentd
v1.19 (0579b12b) with the documented tables.
* inject_key_prefix, hash_value_field (filter/parser.md)
Both are declared as :string with default nil, but the tables said
"false", which is not a valid value for a string parameter:
config_param :inject_key_prefix, :string, default: nil
config_param :hash_value_field, :string, default: nil
* resolve_hostname (input/forward.md)
Declared as :bool with default nil, not false. The distinction matters
here because of in_forward.rb:106-113: when source_hostname_key is set,
a nil resolve_hostname is promoted to true, while an explicitly
configured false raises "resolve_hostname must be true with
source_hostname_key". So "unset" and "false" are not interchangeable.
input/syslog.md already documents the same parameter of in_syslog,
which shares the declaration, as nil.
* generate_cert_expiration (configuration/transport-section.md)
Declared as :time, not :integer:
config_param :generate_cert_expiration, :time, default: 10 * 365 * 86400
The documented default is already correct, only the type was wrong.
[time] is the notation used for time parameters in buffer-section.md.
None of the four is overridden by config_set_default anywhere in the
tree, so the declared values are the effective ones. The version columns
were rechecked against the introducing commits and are correct as they
are: 96664acd (v0.14.9) for the two filter_parser parameters and
5c6ffceb (v0.14.10) for resolve_hostname.
Signed-off-by: Shizuo Fujita <fujita@clear-code.com>
kenhys
approved these changes
Jul 27, 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 mismatches found by comparing config_param declarations in fluentd v1.19 (0579b12b) with the documented tables.
inject_key_prefix, hash_value_field (filter/parser.md)
Both are declared as :string with default nil, but the tables said "false", which is not a valid value for a string parameter:
resolve_hostname (input/forward.md)
Declared as :bool with default nil, not false. The distinction matters here because of in_forward.rb:106-113: when source_hostname_key is set, a nil resolve_hostname is promoted to true, while an explicitly configured false raises "resolve_hostname must be true with source_hostname_key". So "unset" and "false" are not interchangeable. input/syslog.md already documents the same parameter of in_syslog, which shares the declaration, as nil.
generate_cert_expiration (configuration/transport-section.md)
Declared as :time, not :integer:
The documented default is already correct, only the type was wrong. [time] is the notation used for time parameters in buffer-section.md.