Skip to content

Diverse input plugin docs are missing the http_server.workers parameter#2491

Merged
eschabell merged 4 commits intofluent:masterfrom
eschabell:erics_http_server_workers_fix
Mar 20, 2026
Merged

Diverse input plugin docs are missing the http_server.workers parameter#2491
eschabell merged 4 commits intofluent:masterfrom
eschabell:erics_http_server_workers_fix

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Mar 19, 2026

docs: inputs: http, splunk, prometheus-remote-write, elasticsearch:

Added the missing http_server.workers parameter (default: 1) from the shared HTTP server integration. Also note that buffer_chunk_size, buffer_max_size, and http2 are compatibility aliases for their http_server.* canonical names.

Fixes #2486

Summary by CodeRabbit

  • Documentation
    • Updated input plugin documentation (Elasticsearch, HTTP, Prometheus remote write, Splunk) to clarify compatibility aliases for existing HTTP configuration parameters.
    • Added new http_server.workers configuration parameter across HTTP-based inputs for controlling HTTP listener worker thread count (default: 1).

  Add the missing http_server.workers parameter (default: 1) from the
  shared HTTP server integration. Also note that buffer_chunk_size,
  buffer_max_size, and http2 are compatibility aliases for their
  http_server.* canonical names.

  Applies to fluent#2486

Signed-off-by: Eric D. Schabell <eric@schabell.org>
…names

  Add the missing http_server.workers parameter (default: 1) from the
  shared HTTP server integration. Also note that buffer_chunk_size,
  buffer_max_size, and http2 are compatibility aliases for their
  http_server.* canonical names.

  Applies to fluent#2486

Signed-off-by: Eric D. Schabell <eric@schabell.org>
…al key names

  Add the missing http_server.workers parameter (default: 1) from the
  shared HTTP server integration. Also note that buffer_chunk_size,
  buffer_max_size, and http2 are compatibility aliases for their
  http_server.* canonical names.

  Applies to fluent#2486

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 19:17
@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: 08be5c99-ad24-4f70-a817-fa5c085f6d9c

📥 Commits

Reviewing files that changed from the base of the PR and between 21b6f3c and 269d27d.

📒 Files selected for processing (4)
  • pipeline/inputs/elasticsearch.md
  • pipeline/inputs/http.md
  • pipeline/inputs/prometheus-remote-write.md
  • pipeline/inputs/splunk.md

📝 Walkthrough

Walkthrough

This PR updates documentation for four HTTP input plugins (Elasticsearch, HTTP, Prometheus Remote Write, Splunk) to document the new http_server.workers parameter and clarify that existing buffer and HTTP settings are compatibility aliases for their http_server.* counterparts.

Changes

Cohort / File(s) Summary
HTTP Input Plugin Documentation Updates
pipeline/inputs/elasticsearch.md, pipeline/inputs/http.md, pipeline/inputs/prometheus-remote-write.md, pipeline/inputs/splunk.md
Added http_server.workers parameter documentation (HTTP listener worker thread count, default 1). Clarified that buffer_chunk_size, buffer_max_size, and http2 are compatibility aliases mapping to their http_server.* counterparts.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • #2267: Modifies HTTP input documentation with overlapping configuration parameters (buffer_chunk_size, buffer_max_size, http2).
  • #2246: Updates Elasticsearch input documentation for HTTP-related configuration parameters.
  • #2347: Modifies Splunk input documentation with the same configuration parameters (http2, buffer_chunk_size, buffer_max_size).

Suggested reviewers

  • cosmo0920
  • patrick-stephens

Poem

🐰 Hop, hop, hooray! The docs now shine so bright,
With aliases mapped and workers in sight,
Four plugins now speak in a harmonious way,
HTTP servers listening brighter today! ✨

🚥 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 accurately summarizes the main change: documenting the missing http_server.workers parameter across diverse input plugin docs.
Linked Issues check ✅ Passed All requirements from issue #2486 are met: http_server.workers parameter added to all four specified files with correct defaults, and compatibility alias relationships documented.
Out of Scope Changes check ✅ Passed All changes are directly aligned with the linked issue requirements; no out-of-scope modifications are present.
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.

…te canonical key names

  Add the missing http_server.workers parameter (default: 1) from the
  shared HTTP server integration. Nnote that buffer_chunk_size,
  buffer_max_size, and http2 are compatibility aliases for their
  http_server.* canonical names.

  Applies to fluent#2486

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell force-pushed the erics_http_server_workers_fix branch from 447e085 to 269d27d Compare March 19, 2026 19:35
@eschabell
Copy link
Collaborator Author

@patrick-stephens and @cosmo0920 ready for review!

@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Mar 20, 2026
@eschabell eschabell merged commit 5a7a06e into fluent:master Mar 20, 2026
8 checks passed
@eschabell eschabell deleted the erics_http_server_workers_fix branch March 20, 2026 18:35
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.

docs: inputs: several plugin docs need updating with HTTP listener workers details

2 participants