in_tail: permission error handling
Changer glob logic for tail input plugin. Currently if path wildcard matches directories which have insufficient permission, entire tail plugin will fail. By this PR just show warn and keep reading from file with sufficient permission and just show warning.
#10656
Enter [N/A] in the box, if an item is not applicable to your change.
Testing Before we can approve your change; please submit the following in a comment:
- [ ] Example configuration file for the change
- [ ] Debug log output from testing the change
- [ ] Attached Valgrind output that shows no leaks or memory corruption was found
If this is a change to packaging of containers or native binaries then please confirm it works for all targets.
- [ ] Run local packaging test showing all targets (including any new ones) build.
- [ ] Set
ok-package-testlabel to test for all targets (requires maintainer to do).
Documentation
- [ ] Documentation required for this feature
Backporting
- [ ] Backport to latest stable release.
Fluent Bit is licensed under Apache 2.0, by submitting this pull request I understand that this code will be released under the terms of that license.
Summary by CodeRabbit
-
New Features
- Added a configuration option to skip directories with permission errors during scanning, allowing continued processing of accessible directories.
-
Bug Fixes
- Enhanced error handling to avoid scan failures caused by permission issues when the new skip option is enabled.
Walkthrough
A new boolean configuration option, skip_permission_errors, has been introduced to the in_tail plugin. This option allows the plugin to skip directories with permission errors during glob scanning, instead of failing entirely. Supporting logic was added to the configuration structure and the glob scanning function to implement this behavior.
Changes
| Cohort / File(s) | Change Summary |
|---|---|
Config Option Additionplugins/in_tail/tail.c, plugins/in_tail/tail_config.h |
Introduced the skip_permission_errors boolean option in the config map and added an int skip_permission_errors field to the flb_tail_config struct. |
Glob Scanning Logicplugins/in_tail/tail_scan_glob.c |
Updated tail_scan_path to check the skip_permission_errors flag. On permission error (GLOB_ABORTED), logs a warning and retries glob scan (without GLOB_ERR) if skipping is enabled. |
Sequence Diagram(s)
sequenceDiagram
participant User
participant TailPlugin
participant FileSystem
User->>TailPlugin: Start plugin with skip_permission_errors option
TailPlugin->>FileSystem: Perform glob scan (with GLOB_ERR)
FileSystem-->>TailPlugin: Permission error (GLOB_ABORTED)
alt skip_permission_errors enabled
TailPlugin->>TailPlugin: Log warning, retry glob scan (without GLOB_ERR)
FileSystem-->>TailPlugin: Return accessible files/directories
TailPlugin->>User: Continue processing
else skip_permission_errors disabled
TailPlugin->>User: Fail plugin initialization
end
Estimated code review effort
๐ฏ 2 (Simple) | โฑ๏ธ ~8 minutes
Possibly related issues
- fluent/fluent-bit#10656: Implements the same
skip_permission_errorsoption and modifies glob scanning logic to handle permission errors, directly matching the changes in this PR.
Poem
A bunny hopped through files galore,
Skipping errors it found at the door.
"Permission denied?" it gave a shrugโ
Retries the scan with a gentle tug.
Now logs are gathered, neat and bright,
Even when some doors are shut tight!
๐โจ
[!NOTE]
โก๏ธ Unit Test Generation is now available in beta!
Learn more here, or try it out under "Finishing Touches" below.
๐ 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 3c8411f4d320d10c5d3f9c465ba4357e81abfefc and 90999fb0709e1332c83de21dc4ae0e7e94e89f8c.
๐ Files selected for processing (3)
plugins/in_tail/tail.c(1 hunks)plugins/in_tail/tail_config.h(1 hunks)plugins/in_tail/tail_scan_glob.c(1 hunks)
โ Files skipped from review due to trivial changes (1)
- plugins/in_tail/tail.c
๐ง Files skipped from review as they are similar to previous changes (2)
- plugins/in_tail/tail_scan_glob.c
- plugins/in_tail/tail_config.h
โจ Finishing Touches
- [ ] ๐ Generate Docstrings
๐งช Generate unit tests
- [ ] Create PR with unit tests
- [ ] Post copyable unit tests in a comment
๐ชง Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
I pushed a fix in commit <commit_id>, please review it.Explain this complex logic.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai explain this code block.
- PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.@coderabbitai read src/utils.ts and explain its main purpose.@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
Support
Need help? Create a ticket on our support page for assistance with any issues or questions.
CodeRabbit Commands (Invoked using PR comments)
@coderabbitai pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR.@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR.@coderabbitai generate unit teststo generate unit tests for this PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile to the root of your repository. - Please see the configuration documentation for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation:
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.
Thanks @kyo-ke ๐ โ solid work on the glob fallback logic!
The new skip_permission_errors option makes the tail input plugin far more resilient in real-world scenarios where permission inconsistencies are common (especially in multi-tenant environments or containerized workloads).
We've tested the changes with a mix of readable and unreadable directories, and the plugin now gracefully logs warnings and continues scanning valid paths as expected. No memory leaks observed via Valgrind, and everything looks clean on our end.
hmm the retry now runs only when skip_permission_errors is disabled. This is the opposite of the intended behaviour described in the new configuration option and struct comment, causing the plugin to keep running on permission errors when the feature is off and to abort when it is turned on.
I think this has not been tested properly or I missed something...