Fixes for new documentation of Blob input plugin configuration options and updated code examples.

[eschabell]

Fixes for new documentation of Blob input plugin configuration options and updated code examples.

Applies to Fluent Bit issue: fluent/fluent-bit#11204

Summary by CodeRabbit

• New Features

  • Updated post-upload file action configuration with new handling options (add_suffix and emit_log).
  • Enhanced parameter behavior for suffix renaming and log messaging based on selected action.

• Documentation

  • Updated all examples and references to reflect latest configuration options and terminology.

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

[coderabbitai]

Walkthrough

Documentation refactor of pipeline/inputs/blob.md redefining upload action configuration options: upload_success_action and upload_failure_action now support add_suffix and emit_log instead of move and delete, with corresponding parameter semantics updated for suffix and message handling.

Changes

Cohort / File(s)

Summary

Upload Action Configuration Documentation pipeline/inputs/blob.md

Renamed upload action options from delete/move/none to add_suffix/emit_log/none for both success and failure paths; clarified parameter semantics where upload_success_suffix and upload_failure_suffix now apply only to add_suffix actions, and upload_success_message and upload_failure_message apply only to emit_log actions; updated section header from "after processing" to "after upload" and refreshed all configuration examples to reflect new terminology.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Verify new option naming and descriptions are consistent throughout the documentation
• Cross-check example YAML configurations match the new action semantics
• Confirm parameter applicability (suffix/message) is correctly documented for each action type

Possibly related PRs

• fluent/fluent-bit-docs#2186: Related refactoring of pipeline/inputs/blob.md covering the same upload action options rename and semantic restructuring of suffix and message parameters.

Suggested reviewers

• esmerel
• alexakreizinger

Poem

🐰 Configuration hops with a brand new name,
Move becomes suffix, logs stake their claim,
Upload actions dance with emit_log's flair,
Parameters precise, documentation so fair! ✨📝

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 summarizes the main changes: documentation fixes and updated code examples for Blob input plugin configuration options.
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

---

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.}

[eschabell]

Code PR can be found here: fluent/fluent-bit#11205

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

pipeline/inputs/blob.md (1)

209-225: Example demonstrates only add_suffix action; consider including emit_log example.

The example section effectively shows the add_suffix action for both success and failure cases. However, the delete and emit_log actions are documented in the parameter table but lack practical examples. Adding a configuration example demonstrating emit_log with upload_success_message and upload_failure_message would help users understand the full range of options.

Consider adding a complementary example showing the emit_log action:

pipeline:
  inputs:
    - name: blob
      path: /var/log/binaries/*.bin
      database_file: /var/lib/fluent-bit/blob.db
      upload_success_action: emit_log
      upload_success_message: "File uploaded successfully"
      upload_failure_action: emit_log
      upload_failure_message: "File upload failed"
      tag: blob.data
  outputs:
    - name: stdout
      match: '*'

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ab2ed93 and 95885ea.

📒 Files selected for processing (1)

• pipeline/inputs/blob.md (4 hunks)

🔇 Additional comments (1)

pipeline/inputs/blob.md (1)

26-31: Configuration parameter documentation is clear and well-structured.

The updated parameter definitions clearly specify supported values, conditional applicability, and usage guidance. Descriptions appropriately indicate when each suffix/message parameter applies relative to its corresponding action, making the configuration options unambiguous for users.

[eschabell]

Existing documentation aligned with existing configuration options for blob input plugin. AI review passed so merging.