Skip to content

output/exec_filter: document deprecated parameters and section defaults - #666

Merged
kenhys merged 1 commit into
fluent:1.0from
Watson1978:docs-exec_filter-deprecated-params
Aug 6, 2026
Merged

output/exec_filter: document deprecated parameters and section defaults#666
kenhys merged 1 commit into
fluent:1.0from
Watson1978:docs-exec_filter-deprecated-params

Conversation

@Watson1978

@Watson1978 Watson1978 commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

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.

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>
@Watson1978
Watson1978 requested a review from kenhys August 6, 2026 06:39
@kenhys
kenhys merged commit bfc7766 into fluent:1.0 Aug 6, 2026
2 checks passed
@Watson1978
Watson1978 deleted the docs-exec_filter-deprecated-params branch August 6, 2026 08:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants