Skip to content

docs: inputs: fluentbit-logs: add new input plugin documentation#2481

Merged
eschabell merged 1 commit intofluent:masterfrom
eschabell:erics_inputs_fb_logs_new
Mar 20, 2026
Merged

docs: inputs: fluentbit-logs: add new input plugin documentation#2481
eschabell merged 1 commit intofluent:masterfrom
eschabell:erics_inputs_fb_logs_new

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Mar 19, 2026

  • Add pipeline/inputs/fluentbit-logs.md for the new fluentbit_logs input plugin
  • Document record format (level and message fields, all level values)
  • Note no configuration parameters
  • Note event-driven delivery model and 1024-entry queue limit
  • Add YAML and classic config examples for stdout and OpenTelemetry output destinations
  • Add SUMMARY.md entry alphabetically before Fluent Bit metrics

Fixes #2480

Summary by CodeRabbit

  • Documentation
    • Added documentation for the Fluent Bit logs input plugin, explaining how it converts Fluent Bit internal logs into pipeline records with level and message fields. Includes details on event-driven delivery, buffering behavior, and setup examples with OpenTelemetry collector integration.

  - Add pipeline/inputs/fluentbit-logs.md for the new fluentbit_logs
    input plugin
  - Document record format (level and message fields, all level values)
  - Note no configuration parameters
  - Note event-driven delivery model and 1024-entry queue limit
  - Add YAML and classic config examples for stdout and OpenTelemetry
    output destinations
  - Add SUMMARY.md entry alphabetically before Fluent Bit metrics

  Applies to fluent#2480

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell self-assigned this Mar 19, 2026
@eschabell eschabell requested a review from a team as a code owner March 19, 2026 18:09
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 5.0 labels Mar 19, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 19, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 660c6214-a84a-4668-a44a-aa013212bdd6

📥 Commits

Reviewing files that changed from the base of the PR and between 21b6f3c and 821df2c.

📒 Files selected for processing (2)
  • SUMMARY.md
  • pipeline/inputs/fluentbit-logs.md

📝 Walkthrough

Walkthrough

This pull request adds documentation for a new "Fluent Bit logs" input plugin. It includes a new documentation file describing the plugin's functionality, buffering behavior, and usage examples, along with a navigation entry in SUMMARY.md.

Changes

Cohort / File(s) Summary
Documentation Navigation
SUMMARY.md
Added table of contents entry for the Fluent Bit logs input plugin documentation.
Plugin Documentation
pipeline/inputs/fluentbit-logs.md
New documentation page describing the Fluent Bit logs input plugin, including functionality overview, bounded in-memory buffering (1024 entries), record field specifications, and "Get started" examples with stdout and OpenTelemetry collector configurations.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related issues

Suggested labels

4.2.1

Suggested reviewers

  • cosmo0920

Poem

🐰 A doc for logs so bright and clear,
Fluent Bit whispers now we hear,
With buffers bounded, records neat,
This plugin makes the pipeline sweet!
hippity-hop, the docs take flight 📖✨

🚥 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 and concisely describes the main change: adding new documentation for the fluentbit-logs input plugin.
Linked Issues check ✅ Passed The PR fully meets all coding requirements from issue #2480: new documentation file created, plugin behavior documented, config options noted, and SUMMARY.md updated.
Out of Scope Changes check ✅ Passed All changes are directly aligned with issue #2480 requirements; no extraneous modifications detected beyond documenting the fluentbit_logs plugin.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
📝 Coding Plan
  • Generate coding plan for human review comments

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.

@eschabell
Copy link
Collaborator Author

@patrick-stephens , @lecaros and @cosmo0920 review needed for new input plugin doc please!

@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Mar 20, 2026
@eschabell eschabell merged commit bd9bf52 into fluent:master Mar 20, 2026
8 checks passed
@eschabell eschabell deleted the erics_inputs_fb_logs_new branch March 20, 2026 18:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

New input plugin doc needed for Fluent Bit Logs

2 participants