Skip to content

docs: yaml: add http_server.idle_timeout to shared HTTP listener settings#2583

Merged
eschabell merged 1 commit into
fluent:masterfrom
eschabell:erics_http_server_idle_timeout_updates
May 22, 2026
Merged

docs: yaml: add http_server.idle_timeout to shared HTTP listener settings#2583
eschabell merged 1 commit into
fluent:masterfrom
eschabell:erics_http_server_idle_timeout_updates

Conversation

@eschabell
Copy link
Copy Markdown
Collaborator

@eschabell eschabell commented May 22, 2026

  • pipeline-section.md: added http_server.idle_timeout row to the shared HTTP listener settings table with description and default of 10s
  • service-section.md: added http_server.idle_timeout to the inline list of plugin-specific HTTP listener settings in the note below the table

Note these updates are from code changes without corresponding docs PR.

Summary by CodeRabbit

  • Documentation
    • Added documentation for the http_server.idle_timeout configuration setting for HTTP input listeners.
    • Clarified that the service section only controls the built-in monitoring and control HTTP server.
    • Updated list of plugin-specific HTTP listener settings.

Review Change Stack

…ings

  - pipeline-section.md: added http_server.idle_timeout row to the shared
    HTTP listener settings table with description and default of 10s
  - service-section.md: added http_server.idle_timeout to the inline list
    of plugin-specific HTTP listener settings in the note below the table

  Note these updates are from code changes without corresponding docs PR.

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell self-assigned this May 22, 2026
@eschabell eschabell requested a review from a team as a code owner May 22, 2026 08:47
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 5.0.6 labels May 22, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 22, 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: 57af85bc-37e4-40bf-acc8-a73d132938cd

📥 Commits

Reviewing files that changed from the base of the PR and between 22be61b and ab0a56f.

📒 Files selected for processing (2)
  • administration/configuring-fluent-bit/yaml/pipeline-section.md
  • administration/configuring-fluent-bit/yaml/service-section.md

📝 Walkthrough

Walkthrough

This PR updates Fluent Bit documentation for HTTP server configuration. A new http_server.idle_timeout setting is documented in the pipeline section with its behavior and default value, and the service section documentation is clarified to distinguish between built-in HTTP server configuration and plugin-specific HTTP listener settings.

Changes

HTTP Server Configuration Documentation

Layer / File(s) Summary
Idle timeout setting documentation
administration/configuring-fluent-bit/yaml/pipeline-section.md
The HTTP input listener settings table adds a new http_server.idle_timeout row with description, disable behavior (0), accepted time formats, and default value (10s).
Service section scope clarification
administration/configuring-fluent-bit/yaml/service-section.md
The service section documentation is updated to clarify that only the built-in monitoring and control HTTP server is configured there, while plugin-specific HTTP listener settings are configured on input plugins; the enumerated settings list replaces http_server.workers with http_server.ingress_queue_event_limit and adds http_server.ingress_queue_byte_limit.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • fluent/fluent-bit-docs#2576: Documents http_server.idle_timeout for HTTP input listeners with the same parameter details (default, disable, format).
  • fluent/fluent-bit-docs#2546: Introduces http_server.ingress_queue_event_limit and http_server.ingress_queue_byte_limit settings that are referenced in the service section update.
  • fluent/fluent-bit-docs#2491: Updates shared HTTP server settings documentation for input plugins, including http_server.workers which is removed from the service section list in this PR.

Suggested reviewers

  • cosmo0920
  • patrick-stephens

Poem

🐰 A timeout for REST, docs now shine bright,
HTTP listeners sleep when idle at night,
The service and pipeline, now clearly defined,
Settings aligned, with peace of mind!

🚥 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 specifically describes the main change: adding documentation for the http_server.idle_timeout setting to shared HTTP listener settings.
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.

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

✨ 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 and usage tips.

@eschabell eschabell merged commit fd105f8 into fluent:master May 22, 2026
8 checks passed
@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label May 22, 2026
@eschabell eschabell deleted the erics_http_server_idle_timeout_updates branch May 22, 2026 15:08
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