output/exec_filter: document deprecated parameters and section defaults - #666
Merged
Merged
Conversation
Five parameters are declared with `deprecated:` in out_exec_filter.rb but none of them appeared in the documentation. Users had no way to learn what they do or what to use instead. * remove_prefix (0.10.9) use @Label instead * add_prefix (0.10.9) use @Label instead * tag_key (0.14.9) use tag_key in <inject>/<extract> * time_key (0.10.5) use time_key in <inject>/<extract> * time_format (0.10.5) use time_format in <inject>/<extract> All five became deprecated in v0.14.9 (fcc4144f), which the text states. The version column is the release which first accepted the parameter, confirmed against the release tag contents rather than guessed. tag_key is the odd one, and the text explains it: v0.14.9 both added and deprecated it. It was introduced in 0.10.5, dropped during the v0.12 series (eb3ff406 replaced it with in_tag_key / out_tag_key), and fcc4144f reinstated it as a compatibility alias with `deprecated:` already attached. v0.14.8 has no declaration at all, so 0.14.9 is correct for the parameter as it exists today even though it looks like a typo next to time_key at 0.10.5. Three related fixes on the same page: * `## Parameters` had no link to Common Parameters, unlike every other output plugin page. * The `<inject>` section's time_type default is `unixtime`, not `float`. The plugin overrides the inject helper default with `config_set_default :time_type, :unixtime`. * The `<parse>` section's estimate_current_event was missing. The plugin overrides the parser default `true` with `false`. Both time_type entries now note that specifying `time_format` in the same section makes time_type `string`, which is easy to miss because it happens in configure before the section is parsed. Signed-off-by: Shizuo Fujita <fujita@clear-code.com>
kenhys
approved these changes
Aug 6, 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
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.
Five parameters are declared with
deprecated:inout_exec_filter.rbbut none of them appeared in the documentation. Users had no way to learn what they do or what to use instead.@labelinstead@labelinsteadtag_keyin<inject>/<extract>time_keyin<inject>/<extract>time_formatin<inject>/<extract>All five became deprecated in v0.14.9 (fcc4144f), which the text states. The version column is the release which first accepted the parameter, confirmed against the release tag contents rather than guessed.
tag_key is the odd one, and the text explains it: v0.14.9 both added and deprecated it. It was introduced in 0.10.5, dropped during the v0.12 series (eb3ff406 replaced it with
in_tag_key/out_tag_key), and fcc4144f reinstated it as a compatibility alias withdeprecated:already attached. v0.14.8 has no declaration at all, so 0.14.9 is correct for the parameter as it exists today even though it looks like a typo next totime_keyat 0.10.5.Three related fixes on the same page:
## Parametershad no link to Common Parameters, unlike every other output plugin page.<inject>section's time_type default isunixtime, notfloat. The plugin overrides the inject helper default withconfig_set_default :time_type, :unixtime.<parse>section's estimate_current_event was missing. The plugin overrides the parser defaulttruewithfalse.Both time_type entries now note that specifying
time_formatin the same section makes time_typestring, which is easy to miss because it happens in configure before the section is parsed.