Updated Blob input plugin adding missing configuration option descriptions and updated code examples.

[eschabell]

Updated Blob input plugin adding missing configuration option descriptions and updated code examples.

#11204

Testing
Before we can approve your change; please submit the following in a comment:

• [N/A] Example configuration file for the change
• [N/A] Debug log output from testing the change
• [N/A] Attached Valgrind output that shows no leaks or memory corruption was found
• [N/A] Run local packaging test showing all targets (including any new ones) build.
• [N/A] Set ok-package-test label to test for all targets (requires maintainer to do).

Documentation

• Documentation required for this feature
  Fixes for new documentation of Blob input plugin configuration options and updated code examples. fluent-bit-docs#2201

Backporting

• [N/A] 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

Documentation

• Configuration options in the blob plugin now include descriptive guidance for file exclusion patterns, database file paths, upload success/failure handling actions, custom suffixes, and log messages.

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

[coderabbitai]

Walkthrough

Adds human-readable description strings to eight configuration entries in the blob plugin's config_map initializer (exclude_pattern, database_file, upload_success_action, upload_success_suffix, upload_success_message, upload_failure_action, upload_failure_suffix, upload_failure_message). No functional changes to control flow or behavior.

Changes

Cohort / File(s)	Summary
Blob plugin config documentation plugins/in_blob/blob.c	Added descriptive strings to config_map entries for exclude_pattern, database_file, and upload success/failure action options (actions, suffixes, and messages)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Straightforward annotation additions with no logic changes or behavioral impact

Possibly related issues

• Blob input plugin - Missing descriptions for various configuration options. #11204 — This PR directly addresses the missing description strings for the exact same config_map entries (exclude_pattern, database_file, upload_success_, upload_failure_) reported in the issue.

Suggested labels

docs-required

Suggested reviewers

• edsiper
• cosmo0920

Poem

🐰 A carrot-crunching quest so fine,
Eight descriptions now align,
Config options, clear and bright,
Docs make users' futures light!
Fluffy docs, our gift so kind 🎀

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 accurately describes the main changes: adding missing configuration option descriptions to the Blob input plugin, which aligns with the detailed summary showing descriptions added for 8 config options.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

plugins/in_blob/blob.c (1)

991-1045: Config descriptions are accurate; consider minor clarity tweaks

The added descriptions look correct and improve discoverability. Two small, optional clarifications you might consider to better align with the actual behavior:

• exclude_pattern: apply_glob_pattern() operates on the basename only and implements a simple *-wildcard matcher rather than full POSIX glob semantics. You might want to hint at that to avoid confusion for users expecting full-path patterns or ?/[] support, e.g.:

-     "Glob pattern to exclude files from being processed"
+     "Glob-style pattern (applied to file name only) to exclude files from being processed"

• upload_*_suffix and upload_*_message: in in_blob_init() the *_suffix fields are required when *_action is "add_suffix", and the *_message fields are used when *_action is "emit_log". You could make that implicit contract clearer in the descriptions, e.g.:

-     "Suffix to append to filename when upload_success_action is \"add_suffix\""
+     "Suffix to append to filename when upload_success_action is \"add_suffix\" (required when action is \"add_suffix\")"

-     "Message to emit as log when upload_success_action is \"emit_log\""
+     "Message to emit as log when upload_success_action is \"emit_log\" (recommended/required when action is \"emit_log\")"

Same idea applies to the corresponding upload_failure_* entries.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f4108db and 77b0850.

📒 Files selected for processing (1)

• plugins/in_blob/blob.c (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (31)

• GitHub Check: pr-windows-build / call-build-windows-package (Windows 64bit (Arm64), amd64_arm64, -DCMAKE_SYSTEM_NAME=Windows -DCMA...
• GitHub Check: pr-windows-build / call-build-windows-package (Windows 64bit, x64, x64-windows-static, 3.31.6)
• GitHub Check: pr-windows-build / call-build-windows-package (Windows 32bit, x86, x86-windows-static, 3.31.6)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SANITIZE_THREAD=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DSANITIZE_ADDRESS=On, 3.31.6, clang, clang++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_COMPILER_STRICT_POINTER_TYPES=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_ARROW=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SIMD=Off, 3.31.6, clang, clang++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SMALL=On, 3.31.6, clang, clang++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SIMD=Off, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SIMD=On, 3.31.6, clang, clang++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SIMD=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SANITIZE_THREAD=On, 3.31.6, clang, clang++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SANITIZE_MEMORY=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DSANITIZE_UNDEFINED=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SMALL=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DSANITIZE_ADDRESS=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DSANITIZE_UNDEFINED=On, 3.31.6, clang, clang++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SANITIZE_MEMORY=On, 3.31.6, clang, clang++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_COVERAGE=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_JEMALLOC=Off, 3.31.6, clang, clang++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_JEMALLOC=Off, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_JEMALLOC=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_JEMALLOC=On, 3.31.6, clang, clang++)
• GitHub Check: pr-compile-without-cxx (3.31.6)
• GitHub Check: pr-compile-system-libs (-DFLB_PREFER_SYSTEM_LIBS=On, 3.31.6, clang, clang++, ubuntu-22.04, clang-12)
• GitHub Check: pr-compile-system-libs (-DFLB_PREFER_SYSTEM_LIBS=On, 3.31.6, gcc, g++, ubuntu-22.04, clang-12)
• GitHub Check: pr-compile-system-libs (-DFLB_PREFER_SYSTEM_LIBS=On, 3.31.6, clang, clang++, ubuntu-24.04, clang-14)
• GitHub Check: pr-compile-system-libs (-DFLB_PREFER_SYSTEM_LIBS=On, 3.31.6, gcc, g++, ubuntu-24.04, clang-14)
• GitHub Check: pr-compile-centos-7
• GitHub Check: PR - fuzzing test

[eschabell]

Closing this out as I've messed with the branch a bit too much, will resubmit a new PR.