Skip to content

docs: installation: upgrade-notes: document 5.1 input rate metrics and rate gate - #2669

Merged
patrick-stephens merged 1 commit into
fluent:masterfrom
eschabell:erics_update_51_release_notes
Aug 11, 2026
Merged

docs: installation: upgrade-notes: document 5.1 input rate metrics and rate gate#2669
patrick-stephens merged 1 commit into
fluent:masterfrom
eschabell:erics_update_51_release_notes

Conversation

@eschabell

@eschabell eschabell commented Aug 9, 2026

Copy link
Copy Markdown
Collaborator

Add an upgrade-notes entry for the new input rate_window/rate_gate
settings and fluentbit_input_rate_* metrics, which landed in
administration and pipeline docs but weren't cross-referenced in the
v5.1 upgrade notes. Also reword the mutual TLS note to clear a Vale
WordList suggestion on "terminate".

Summary by CodeRabbit

  • Documentation
    • Added guidance for per-input ingestion-rate metrics in Fluent Bit v5.1.
    • Documented the optional rate gate, including configurable thresholds, backpressure, and resume behavior.
    • Clarified when tls.verify_client_cert applies during TLS termination.

@eschabell eschabell self-assigned this Aug 9, 2026
@eschabell
eschabell requested a review from a team as a code owner August 9, 2026 18:37
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 5.1 labels Aug 9, 2026
@coderabbitai

coderabbitai Bot commented Aug 9, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The upgrade notes now describe Fluent Bit v5.1 input rate metrics, opt-in rate gating, and clarified mTLS termination behavior.

Changes

Upgrade notes updates

Layer / File(s) Summary
Document v5.1 upgrade behavior
installation/upgrade-notes.md
Adds input byte and record rate metrics, rate_gate controls, configurable thresholds, backpressure, and resume behavior. Clarifies that Fluent Bit terminates TLS when tls.verify_client_cert uses certificate and key files.

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

Possibly related PRs

Suggested reviewers: patrick-stephens, cosmo0920

🚥 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 identifies the v5.1 upgrade-notes documentation for input rate metrics and the rate gate.
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

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 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 `@installation/upgrade-notes.md`:
- Line 23: Update the v5.1 rate metrics and rate limiting note to document the
per-input rate_window setting, stating that it controls the byte and record
measurement window and defaults to 1s, consistent with the existing pipeline
buffering documentation.
🪄 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: c979f8fc-0a56-4593-bbb5-94a1fd1c1821

📥 Commits

Reviewing files that changed from the base of the PR and between 4087ee3 and 28cbc6b.

📒 Files selected for processing (1)
  • installation/upgrade-notes.md

Comment thread installation/upgrade-notes.md Outdated
…d rate gate

  Add an upgrade-notes entry for the new input rate_window/rate_gate
  settings and fluentbit_input_rate_* metrics, which landed in
  administration and pipeline docs but weren't cross-referenced in the
  v5.1 upgrade notes. Also reword the mutual TLS note to clear a Vale
  WordList suggestion on "terminate". Also documenting rate_window setting.

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell
eschabell force-pushed the erics_update_51_release_notes branch from 28cbc6b to 8100094 Compare August 9, 2026 18:43
@eschabell

Copy link
Copy Markdown
Collaborator Author

@patrick-stephens ready for review!

@patrick-stephens
patrick-stephens merged commit 12568f5 into fluent:master Aug 11, 2026
8 checks passed
@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Aug 12, 2026
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.

2 participants