Skip to content

docs: administration: document adaptive flush intervals and FIPS mode - #2636

Open
eschabell wants to merge 1 commit into
fluent:masterfrom
eschabell:erics_admin_flush_fips_updates
Open

docs: administration: document adaptive flush intervals and FIPS mode#2636
eschabell wants to merge 1 commit into
fluent:masterfrom
eschabell:erics_admin_flush_fips_updates

Conversation

@eschabell

@eschabell eschabell commented Jul 31, 2026

Copy link
Copy Markdown
Collaborator

Add the eight flush.adaptive service keys and security.fips_mode to the YAML and classic service configuration tables, with sections describing how the adaptive interval responds to chunk backpressure and what FIPS mode requires and changes. Document the matching --enable-fips command line flag.

Note: this update is from code merges without docs PR.

Summary by CodeRabbit

  • Documentation
    • Added guidance for enabling OpenSSL FIPS mode, including configuration options, startup validation, reload limitations, and plugin-specific behavior.
    • Documented the --enable-fips command-line option and FIPS requirements.
    • Added configuration references and examples for adaptive flush behavior, including pressure thresholds, interval limits, and stabilization settings.

@eschabell eschabell self-assigned this Jul 31, 2026
@eschabell eschabell added the waiting-on-review Waiting on a review from mainteners label Jul 31, 2026
@eschabell
eschabell requested a review from a team as a code owner July 31, 2026 15:56
@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

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: b51ad23d-8a10-4da1-b508-314997a0708b

📥 Commits

Reviewing files that changed from the base of the PR and between 8afdfc0 and d83738f.

📒 Files selected for processing (3)
  • administration/configuring-fluent-bit.md
  • administration/configuring-fluent-bit/classic-mode/configuration-file.md
  • administration/configuring-fluent-bit/yaml/service-section.md
🚧 Files skipped from review as they are similar to previous changes (3)
  • administration/configuring-fluent-bit.md
  • administration/configuring-fluent-bit/classic-mode/configuration-file.md
  • administration/configuring-fluent-bit/yaml/service-section.md

📝 Walkthrough

Walkthrough

The documentation adds adaptive flush settings and OpenSSL FIPS mode references for command-line, classic configuration, and YAML service configuration.

Changes

Adaptive flush documentation

Layer / File(s) Summary
Adaptive flush settings and behavior
administration/configuring-fluent-bit/classic-mode/configuration-file.md, administration/configuring-fluent-bit/yaml/service-section.md
The references document adaptive flush keys, interval bounds, pressure thresholds, transition counts, clamping, hysteresis, failure behavior, and a YAML example.

FIPS mode documentation

Layer / File(s) Summary
FIPS configuration and requirements
administration/configuring-fluent-bit.md, administration/configuring-fluent-bit/classic-mode/configuration-file.md, administration/configuring-fluent-bit/yaml/service-section.md
The documentation covers FIPS configuration, version and OpenSSL requirements, startup validation, reload restrictions, command-line equivalence, and plugin MD5 behavior.

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

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 identifies the documentation changes for adaptive flush intervals and FIPS mode.
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 `@administration/configuring-fluent-bit/yaml/service-section.md`:
- Around line 69-81: Update the adaptive-flush example’s service configuration
so its documented behavior matches the multiplier of 2: adjust the baseline
flush value in the YAML under the “fluent-bit.yaml” tab, while preserving the
existing adaptive min/max interval and high-pressure settings.
🪄 Autofix (Beta)

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: fe2c482f-64e2-49a3-8da5-4c52ae786852

📥 Commits

Reviewing files that changed from the base of the PR and between 0eb06a6 and 8afdfc0.

📒 Files selected for processing (3)
  • administration/configuring-fluent-bit.md
  • administration/configuring-fluent-bit/classic-mode/configuration-file.md
  • administration/configuring-fluent-bit/yaml/service-section.md

Comment thread administration/configuring-fluent-bit/yaml/service-section.md Outdated
Add the eight flush.adaptive service keys and security.fips_mode to the
YAML and classic service configuration tables, with sections describing
how the adaptive interval responds to chunk backpressure and what FIPS
mode requires and changes. Document the matching --enable-fips command
line flag.

The adaptive flush example set flush to 1 while the surrounding text
described an idle interval of three seconds. Because the idle pressure
level multiplies flush by 2, that configuration produced a two second
idle interval and never reached the configured max_interval of 3.

Note: this update is from code merges without docs PR.

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell
eschabell force-pushed the erics_admin_flush_fips_updates branch from 8afdfc0 to d83738f Compare July 31, 2026 16:09
@eschabell

Copy link
Copy Markdown
Collaborator Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Aug 1, 2026

Copy link
Copy Markdown
Contributor
✅ 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.

@eschabell

Copy link
Copy Markdown
Collaborator Author

@patrick-stephens ready for review!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

5.0.9 waiting-on-review Waiting on a review from mainteners

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant