in_http: added missing config parameter descriptions.

[eschabell]

• 4 parameters need descriptions: http2, buffer_max_size, buffer_chunk_size, tag_key

Fixes #11239.

---

Testing

• [N/A ] Example configuration file for the change
• [N/A ] Debug log output from testing the change
• [N/A ] Attached Valgrind output that shows no leaks or memory corruption was found
• [N/A ] Run local packaging test showing all targets (including any new ones) build.
• [N/A ] Set ok-package-test label to test for all targets (requires maintainer to do).

Documentation

• [X ] Documentation required for this feature

Doc fix PR: fluent/fluent-bit-docs#2267

Backporting

• [N/A ] Backport to latest stable release.

---

Fluent Bit is licensed under Apache 2.0, by submitting this pull request I understand that this code will be released under the terms of that license.

Summary by CodeRabbit

• Documentation
  • Updated HTTP plugin configuration descriptions with clearer guidance for HTTP/2 support, buffer sizing, header configuration, and request data handling.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

The HTTP input plugin configuration now includes descriptions for previously undocumented parameters: http2, buffer_max_size, buffer_chunk_size, and tag_key. Additionally, the success_header parameter description was standardized with improved formatting.

Changes

Cohort / File(s)	Summary
HTTP input plugin configuration descriptions plugins/in_http/http.c	Added descriptive text for four configuration parameters (http2, buffer_max_size, buffer_chunk_size, tag_key) and standardized the success_header description with proper punctuation. No functional logic changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Straightforward documentation update with no logic changes
• Purely additive modifications to static configuration strings
• No behavioral or control-flow implications

Suggested reviewers

• edsiper
• cosmo0920
• patrick-stephens

Poem

🐰 A rabbit hops through config fields so neat,
Where missing words made documentation incomplete.
Now descriptions bloom like carrots in the sun,
HTTP parameters clearly shine—their purpose now well-won!

Pre-merge checks and finishing touches

✅ 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 and concisely summarizes the main change: adding missing config parameter descriptions to the in_http plugin.
Linked Issues check	✅ Passed	The pull request successfully addresses all coding requirements from issue #11239 by providing descriptions for the four specified parameters (http2, buffer_max_size, buffer_chunk_size, tag_key).
Out of Scope Changes check	✅ Passed	All changes are scoped to adding missing parameter descriptions in the HTTP plugin configuration map; no unrelated modifications are present.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 10ebd3a and dd414bd.

📒 Files selected for processing (1)

• plugins/in_http/http.c (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)

• GitHub Check: run-qemu-ubuntu-unit-tests (riscv64)
• GitHub Check: run-macos-unit-tests (-DFLB_JEMALLOC=Off, 3.31.6)
• GitHub Check: run-qemu-ubuntu-unit-tests (s390x)
• GitHub Check: run-macos-unit-tests (-DFLB_SANITIZE_MEMORY=On, 3.31.6)
• GitHub Check: run-macos-unit-tests (-DFLB_SANITIZE_THREAD=On, 3.31.6)

🔇 Additional comments (1)

plugins/in_http/http.c (1)

207-232: Descriptions require corrections for accuracy and clarity.

While most descriptions are well-intentioned, verification against official documentation reveals accuracy issues:

• http2 (line 207): The description "Enable HTTP/2 support" is misleading. In Fluent Bit v3+, HTTP/2 is enabled by default; the parameter controls disabling it (http2 off). Revise to: "Enable HTTP/2 support (enabled by default in v3+, set to 'off' to disable)." or similar.

• tag_key (line 231): The description "Specify a key name for extracting the tag from incoming request data" is vague and imprecise. The parameter specifies a JSON field name whose value becomes the event tag (overwriting the default tag). Revise to: "Specify a JSON field name whose value will be used as the event tag."

• buffer_chunk_size (line 219): Accurate but could clarify it's for per-message incremental allocation. Current "Set the initial buffer size" is acceptable but consider: "Set the initial buffer chunk size for per-message incremental allocation (default 512K)."

• buffer_max_size (line 213): Accurate and clear.

⛔ Skipped due to learnings

Learnt from: cosmo0920
Repo: fluent/fluent-bit PR: 11171
File: include/fluent-bit/flb_lib.h:52-53
Timestamp: 2025-11-21T06:23:29.770Z
Learning: In Fluent Bit core (fluent/fluent-bit repository), function descriptions/documentation are not required for newly added functions in header files.

---

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

[eschabell]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

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.