Skip to content

Add config option documentation for new in_tail option 'ignore_unavailable' #2626

Open
ner216 wants to merge 1 commit into
fluent:masterfrom
ner216:add-tail-ignore-unavailable
Open

Add config option documentation for new in_tail option 'ignore_unavailable' #2626
ner216 wants to merge 1 commit into
fluent:masterfrom
ner216:add-tail-ignore-unavailable

Conversation

@ner216

@ner216 ner216 commented Jul 14, 2026

Copy link
Copy Markdown

Config documentation for the new 'ignore_unavailable' config option for the in_tail plugin.

Companion code: fluent/fluent-bit#12097

This option makes in_tail ignore paths that do not exist while scanning. When active, errors/warnings regarding missing files/paths will be omitted.

Summary by CodeRabbit

  • Documentation
    • Documented the ignore_unavailable option for the Tail input plugin.
    • Clarified that it ignores missing/non-existent file paths encountered during scanning.
    • Noted the option defaults to disabled (false).

@ner216 ner216 requested review from a team and eschabell as code owners July 14, 2026 22:32
@coderabbitai

coderabbitai Bot commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f5b43c74-8800-424b-ba5e-23f0e57d2f7d

📥 Commits

Reviewing files that changed from the base of the PR and between 644e825 and 4b52d49.

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

📝 Walkthrough

Walkthrough

The Tail input plugin configuration table now documents the ignore_unavailable option, which skips nonexistent file paths during scanning and defaults to false.

Changes

Tail input documentation

Layer / File(s) Summary
Document unavailable-path handling
pipeline/inputs/tail.md
Adds the ignore_unavailable option with its scanning behavior and default value.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

Suggested labels: 4.2

Suggested reviewers: eschabell

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the documented new in_tail option added in this pull request.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@pipeline/inputs/tail.md`:
- Line 34: Update the ignore_unavailable option description in tail.md to state
that enabling it ignores nonexistent file paths and suppresses the related
errors and warnings during scanning.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 0f48a2ef-b8cb-4b6b-8131-62653a270ed8

📥 Commits

Reviewing files that changed from the base of the PR and between a4dd9b5 and 1d60210.

📒 Files selected for processing (1)
  • pipeline/inputs/tail.md

Comment thread pipeline/inputs/tail.md Outdated
…documentation for the in_tail plugin.

  - Expand the ignore_unavailable description to state that enabling it ignores
    nonexistent file paths and suppresses the related errors and warnings during
    scanning

Signed-off-by: ner216 <provencher.nolan@gmail.com>
Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell force-pushed the add-tail-ignore-unavailable branch from 644e825 to 4b52d49 Compare July 15, 2026 13:18

@eschabell eschabell left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ner216 I fixed some issues on the wording, but now ready to go once the code PR merges.

@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Jul 15, 2026
@ner216

ner216 commented Jul 15, 2026

Copy link
Copy Markdown
Author

@ner216 I fixed some issues on the wording, but now ready to go once the code PR merges.

Thank you, I really appreciate it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants