fluent-bit-docs icon indicating copy to clipboard operation
fluent-bit-docs copied to clipboard

tail: New keep_file_handle and fstat_interval_nsec options for tail i…

Open david-garcia-garcia opened this issue 1 month ago • 3 comments

See https://github.com/fluent/fluent-bit/pull/11151

Summary by CodeRabbit

  • Documentation
    • Added docs for two new Tail input options: keeping file handles open and configuring file-status check intervals, with notes on effects for cloud and SMB/Samba backends.
    • New SMB/Samba tailing section with behavior guidance and example configs.
    • Expanded character-encoding conversion guidance with more examples, usage scenarios, and supported encodings details.

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

david-garcia-garcia avatar Nov 20 '25 14:11 david-garcia-garcia

Walkthrough

Updates Tail input documentation: adds keep_file_handle and fstat_interval_nsec options, introduces an SMB/Samba tailing section with behavior notes and example Fluent Bit YAML/conf configs, and expands the Character Encoding Conversion guidance with examples and encoding details.

Changes

Cohort / File(s) Summary
Tail input documentation
pipeline/inputs/tail.md
Added keep_file_handle and fstat_interval_nsec configuration options and explanations; added an SMB/Samba tailing section describing behavior and implications, with example Fluent Bit YAML and conf configurations; expanded Character Encoding Conversion section with additional guidance, examples, and encoding details.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Documentation-only changes; no code or API modifications.
  • Focus review on clarity and correctness of examples and encoding details.

Poem

🐇 I hopped through lines of tail and file,

Kept a handle close or let it roam a while,
Counting nanos in a patient beat,
SMB corners swept tidy and neat,
A rabbit's note — docs polished with a smile.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main changes: two new configuration options (keep_file_handle and fstat_interval_nsec) added to the Tail input documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • [ ] Create PR with unit tests
  • [ ] Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 96b09280b6a62f557d61694d092456822fa99be0 and ae0b9d15c6487126ca48f321720c8e653adcca5d.

📒 Files selected for processing (1)
  • pipeline/inputs/tail.md (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • pipeline/inputs/tail.md

[!TIP]

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  • Provide your own instructions using the high_level_summary_instructions setting.
  • Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
  • Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

  1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
  2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
  3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
  4. 📊 Contributor Summary — Include a Markdown table showing contributions: | Contributor | Lines Added | Lines Removed | Files Changed |
  5. ✔️ Additional Notes — Add any extra reviewer context. Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.


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.

coderabbitai[bot] avatar Nov 20 '25 14:11 coderabbitai[bot]

@david-garcia-garcia failing on some lint issues... if you can take a look so this is ready when the code PR merges?

eschabell avatar Nov 24 '25 15:11 eschabell

@eschabell I just caught/fixed the failing check, should be able to merge now :)

alexakreizinger avatar Nov 24 '25 19:11 alexakreizinger