Added missing config parameter and some general cleanup for http input plugin doc. Fixes #2266.

[eschabell]

Fixed the following:

• missing http2 config parameter
• sort config parameter table
• standardize example configurations

Summary by CodeRabbit

• Documentation
  • Updated HTTP input plugin documentation with expanded configuration options for buffering, HTTP/2 support, and response handling.
  • Clarified configuration examples and removed documentation inconsistencies.
  • Improved documentation formatting and structure for enhanced readability.

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

[coderabbitai]

Walkthrough

The HTTP input plugin documentation was consolidated and clarified by adding new configuration key documentation (buffer_chunk_size, buffer_max_size, http2, success_header, successful_response_code), removing duplicate entries, fixing example tag formatting, and standardizing configuration syntax capitalization.

Changes

Cohort / File(s)

Summary

HTTP input plugin documentation pipeline/inputs/http.md

Added new configuration keys (buffer_chunk_size, buffer_max_size, http2, success_header, successful_response_code) with descriptions and defaults; removed duplicate configuration parameter entries; corrected example tag formatting and standardized configuration directive capitalization (Name, Listen, Port, Tag_Key) for consistency with documented syntax; minor adjustments to TLS/SSL, gzipped content notes, and curl examples.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

• Documentation-only changes with no code logic or control flow modifications
• Primarily clarifications, consolidations of duplicate entries, and formatting fixes

Poem

📝 A rabbit hops through docs so neat,
With config keys now all concrete,
Duplicates removed, examples bright,
The HTTP path shines crystal light! 🐰✨

Pre-merge checks and finishing touches

✅ Passed checks (3 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 summarizes the main changes: adding missing configuration parameters and general documentation cleanup for the HTTP input plugin.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 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 9abf597 and 670469c.

📒 Files selected for processing (1)

• pipeline/inputs/http.md (8 hunks)

🔇 Additional comments (9)

pipeline/inputs/http.md (9)

10-17: Verify documented parameter defaults match code implementation.

The configuration table now documents five additional parameters with specific defaults. Ensure the defaults for buffer_chunk_size (512K), buffer_max_size (4M), http2 (true), and successful_response_code (201) are accurate and match the actual fluent-bit code implementation.

Please confirm these defaults are correct by checking the HTTP input plugin source code or running a quick validation against the actual fluent-bit binary.

---

38-38: Format correction is accurate.

The typo fix removing **. ** formatting artifact improves readability and correctness.

---

66-72: Configuration file examples now use correct capitalization.

The standardization to capitalized keys (Name, Listen, Port, Match) in the fluent-bit.conf examples is correct and improves adherence to the actual fluent-bit.conf format.

---

106-112: Configuration examples use consistent capitalization.

The standardization continues correctly across all fluent-bit.conf examples.

---

151-158: Proper Snake_Case capitalization for composite keys.

The standardization correctly applies to keys like Tag_Key with proper underscore handling per fluent-bit.conf syntax conventions.

---

185-187: Success_Header parameter example uses correct fluent-bit.conf syntax.

The proper Snake_Case capitalization and formatting align with the newly documented parameter in the configuration table.

---

221-227: All fluent-bit.conf examples now use consistent standardized capitalization.

The systematic capitalization changes across all .conf configuration examples improve clarity and compliance with fluent-bit.conf format expectations.

---

236-236: Command-line example is correctly formatted.

The fluent-bit invocation with HTTP input and port configuration is accurate and provides a useful quick-start reference.

---

10-17: Overall assessment: Documentation standardization is solid and improves clarity.

The PR successfully addresses the stated objectives:

• ✓ Adds documentation for the http2 configuration parameter
• ✓ Standardizes fluent-bit.conf examples with proper capitalization (Name, Listen, Port, Tag_Key, Success_Header, Match)
• ✓ Maintains correct lowercase in YAML examples
• ✓ Removes formatting artifacts (typo fix on line 38)
• ✓ Consolidates duplicate documentation entries

The changes improve consistency and align examples with actual fluent-bit.conf syntax conventions. The YAML and fluent-bit.conf examples now clearly demonstrate the parallel configuration approaches.

The critical next step is to validate that the documented parameter defaults are accurate:

• http2: default true
• successful_response_code: default 201
• buffer_max_size: default 4M
• buffer_chunk_size: default 512K

Please verify these match the HTTP input plugin implementation in the fluent-bit codebase.

---

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]

AI review passed, merging.