Skip to content

docs: in_tail: fix boolean defaults and remove duplicate table#2362

Merged
patrick-stephens merged 1 commit intofluent:masterfrom
eschabell:erics_in_tail_updates
Jan 27, 2026
Merged

docs: in_tail: fix boolean defaults and remove duplicate table#2362
patrick-stephens merged 1 commit intofluent:masterfrom
eschabell:erics_in_tail_updates

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Jan 27, 2026

  • Standardize boolean defaults to use true/false instead of on/off:
    • file_cache_advise: on -> true
    • skip_empty_lines: off -> false
    • skip_long_lines: off -> false
  • Remove duplicate Docker mode configuration table that repeated parameters already documented in the main configuration table
  • Replace duplicate table with reference to main configuration section

Fixes #2361

Summary by CodeRabbit

  • Documentation
    • Updated default configuration values for file caching and line filtering options.
    • Reorganized Docker mode configuration documentation for improved clarity and easier reference.

✏️ Tip: You can customize this high-level summary in your review settings.

  - Standardize boolean defaults to use true/false instead of on/off:
    - file_cache_advise: on -> true
    - skip_empty_lines: off -> false
    - skip_long_lines: off -> false
  - Remove duplicate Docker mode configuration table that repeated
    parameters already documented in the main configuration table
  - Replace duplicate table with reference to main configuration section

Fixes fluent#361

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell self-assigned this Jan 27, 2026
@eschabell eschabell requested a review from a team as a code owner January 27, 2026 10:30
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 5.0 labels Jan 27, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 27, 2026

📝 Walkthrough

Walkthrough

Documentation updates to the Tail input configuration file: default value changes for file_cache_advise, skip_empty_lines, and skip_long_lines parameters, plus restructuring of Docker mode configuration notes to reference the main configuration parameters table.

Changes

Cohort / File(s) Summary
Tail Input Documentation
pipeline/inputs/tail.md
Updated parameter defaults (file_cache_advise: on→true, skip_empty_lines/skip_long_lines: off→false); consolidated Docker mode configuration notes into single reference instead of separate per-parameter descriptions

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Suggested reviewers

  • alexakreizinger
  • cosmo0920

Poem

🐰 Whiskers twitch with delight so bright,
Default values set just right,
Docker notes consolidated clean,
The clearest tail config I've seen!
Documentation hops along,
Making configuration strong!

🚥 Pre-merge checks | ✅ 4 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The PR objectives address documentation standardization for in_tail parameters and removing duplicate configuration tables, while the linked issue #361 concerns fixing typos in configuration-file.md. The changes do not appear to address the linked issue's specific requirement. Verify whether the PR should address issue #361's typo correction in configuration-file.md, or if the linked issue reference is incorrect for this documentation update.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main changes: fixing boolean default values in in_tail documentation and removing a duplicate Docker configuration table.
Out of Scope Changes check ✅ Passed The changes are focused on in_tail.md documentation only, updating boolean defaults and removing duplicate Docker configuration content, which aligns with the stated PR objectives.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@patrick-stephens patrick-stephens merged commit bc83de6 into fluent:master Jan 27, 2026
8 checks passed
@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Jan 29, 2026
@eschabell eschabell deleted the erics_in_tail_updates branch January 29, 2026 09:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Tail input plugin doc needs updates

2 participants