docs: pipeline: buffering: document input rate gate and rate window

[eschabell]

• Add rate_gate, rate_gate.backpressure, rate_gate.max_bytes, rate_gate.max_records, rate_gate.resume_ratio, and rate_window to the per-input settings table (new in 5.1)
• Add a YAML/classic configuration example enabling the rate gate on an input plugin

Summary by CodeRabbit

• Documentation
  • Added guidance for configuring input rate limits based on bytes and records.
  • Documented backpressure behavior, resume thresholds, and measurement windows.
  • Included YAML and classic configuration examples for pausing and resuming inputs.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 06b548d7-678b-4d98-823e-a979cb924556

📥 Commits

Reviewing files that changed from the base of the PR and between df5b6df and 99b96df.

📒 Files selected for processing (1)

• pipeline/buffering.md

🚧 Files skipped from review as they are similar to previous changes (1)

• pipeline/buffering.md

---

📝 Walkthrough

Walkthrough

The buffering guide documents per-input rate gating, including limits, backpressure, resume hysteresis, measurement windows, and YAML and classic configuration examples.

Changes

Rate-gating documentation

Layer / File(s)	Summary
Rate-gate settings and examples pipeline/buffering.md	Documents rate_gate options and provides YAML and classic examples for a forward input. The section includes Fluent Bit 5.1 availability details.

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

Possibly related PRs

• fluent/fluent-bit-docs#2324: Reorganized the same buffering guide and covers related buffering documentation.

Suggested reviewers: patrick-stephens

🚥 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 documentation changes for the input rate gate and rate window.
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

• X
• Mastodon
• Reddit
• LinkedIn

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

[eschabell]

@coderabbitai review

[coderabbitai]

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

pipeline/buffering.md (1)

151-179: 🎯 Functional Correctness | 🔵 Trivial

Check these Fluent Bit rate-gate examples with a Fluent Bit 5.1 configuration dump.

No configuration validation script or GitHub workflow is present in this repo. Add coverage with a Fluent Bit 5.1-or-later binary, or require manual --dry-run/service.validate() validation for the fluent-bit.yaml and fluent-bit.conf tabs. Validate the classic spellings and boolean values, including Rate_Gate.Max_Bytes and Rate_Gate true.

🤖 Prompt for 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.

In `@pipeline/buffering.md` around lines 151 - 179, The Fluent Bit rate-gate
examples in the fluent-bit.yaml and fluent-bit.conf tabs need validation against
Fluent Bit 5.1 or later. Add automated coverage using a 5.1+ binary, or document
a required manual --dry-run/service.validate() check, confirming the classic
spellings and boolean values including Rate_Gate.Max_Bytes and Rate_Gate true.

Source: Learnings

🤖 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/buffering.md`:
- Line 144: Clarify the rate_gate.resume_ratio documentation to explicitly state
whether ingestion resumes when both configured byte and record rates fall below
their thresholds or when only the limit that triggered the gate falls below its
threshold, and keep this behavior consistent with the later “whichever limit
tripped” wording.

---

Nitpick comments:
In `@pipeline/buffering.md`:
- Around line 151-179: The Fluent Bit rate-gate examples in the fluent-bit.yaml
and fluent-bit.conf tabs need validation against Fluent Bit 5.1 or later. Add
automated coverage using a 5.1+ binary, or document a required manual
--dry-run/service.validate() check, confirming the classic spellings and boolean
values including Rate_Gate.Max_Bytes and Rate_Gate true.

🪄 Autofix

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 Plus

Run ID: 397da15c-4ac0-4276-8816-32f58ca5e91b

📥 Commits

Reviewing files that changed from the base of the PR and between df5b6df and 2e7181b.

📒 Files selected for processing (1)

• pipeline/buffering.md

[coderabbitai]

Note

GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer.

[eschabell]

@patrick-stephens ready for review!