Fixed elasticsearch input plugin doc with missing config parameters and some cleanup. Fixed #2245

[eschabell]

Fixed elasticsearch input plugin doc with missing config parameters and some cleanup. Fixed #2245

Summary by CodeRabbit

• Documentation
  • Added new connection options: http2, listen, port, and version
  • Introduced TLS/SSL guidance and transport security examples
  • Replaced and clarified sniffing guidance; updated hostname guidance for production reachability
  • Removed buffer_max_size from parameter table and adjusted ordering/placement of tag_key/meta_key
  • Updated usage examples and clarified bulk ingestion and buffer-sizing recommendations

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

[coderabbitai]

Walkthrough

Documentation update for the Elasticsearch input plugin: reorganized configuration parameters, added http2, listen, port, and version; introduced TLS/SSL and a dedicated Sniffing section; clarified hostname usage; and updated examples to match the new parameter set.

Changes

Cohort / File(s)

Change Summary

Elasticsearch input plugin documentation pipeline/inputs/elasticsearch.md

Reorganized parameters table; added http2, listen, port, and version entries; repositioned meta_key/tag_key and removed original buffer_max_size placement; added TLS/SSL guidance with Transport Security reference and TLS option examples (tls.verify, tls.ca_file, tls.crt_file, tls.key_file); replaced prior sniffing text with a dedicated Sniffing section and clarified hostname role for sniffing and client reachability; updated usage examples and large-bulk ingestion narrative.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Documentation-only changes; review focus:
  • Verify exact option names (http2, listen, port, version, tls.*, meta_key, tag_key, buffer_max_size).
  • Confirm TLS example syntax and Transport Security link/reference.
  • Ensure hostname/sniffing guidance matches implementation behavior.

Poem

🐰 I hopped through lines of config bright,
I nudged some keys to set them right,
TLS blankets and sniffing tunes,
Ports and versions under moons,
A carrot cheer for docs tonight 🥕

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 clearly summarizes the main change: documentation fixes for Elasticsearch input plugin with parameter updates and cleanup, directly addressing issue #2245.
Linked Issues check	✅ Passed	The PR addresses both objectives from #2245: adds missing http-related parameters (http2, listen, port, version) and performs layout standardization (rewrites descriptions, adds sections, reorganizes entries).
Out of Scope Changes check	✅ Passed	All changes are documentation-focused and directly related to #2245 objectives: parameter additions, TLS/SSL guidance, sniffing section, hostname rewrites, and usage examples align with the stated scope.
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 1aff26e and 2277daa.

📒 Files selected for processing (1)

• pipeline/inputs/elasticsearch.md (1 hunks)

🔇 Additional comments (4)

pipeline/inputs/elasticsearch.md (4)

12-20: AI summary inconsistency: buffer_max_size is not removed.

The AI-generated summary claims that buffer_max_size was removed, but the parameter remains in the configuration table at line 12 with its full description. This discrepancy may cause confusion during code review or implementation verification. Please ensure the summary is corrected or confirm that the removal was intentional.

Regarding the added parameters themselves, the table entries are clear and well-documented.

---

20-20: Version parameter description improved.

The updated description effectively addresses the past review's concerns by clarifying that this value is what Fluent Bit reports to clients (during sniffing and API requests) rather than the actual server version. The redundancy and ambiguity from the original wording have been resolved.

---

22-36: New TLS/SSL and Sniffing sections greatly improve documentation clarity.

Both sections are well-written and fill important gaps in the documentation:

• The TLS/SSL section appropriately references the general Transport Security documentation while providing concrete examples of common configuration options.
• The Sniffing section clearly explains the sniffing discovery process and properly contextualizes why the hostname parameter is important. The guidance to use external IPs or load balancer addresses in production (rather than localhost) is practical and prevents common misconfigurations.

These additions support the PR's objective of standardizing and expanding the documentation.

---

61-122: Example configurations correctly utilize updated parameters.

The YAML and configuration file examples properly demonstrate the new listen and port parameters. The buffer configuration examples remain appropriate since buffer_max_size and buffer_chunk_size are retained in the parameter table. Examples are syntactically correct and align with the documentation updates.

---

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.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

pipeline/inputs/elasticsearch.md (2)

22-24: TLS/SSL section reference could include more specific guidance.

The new TLS/SSL section (lines 22–24) is helpful but provides only a pointer to general Transport Security documentation. Consider adding a brief note about common TLS configuration patterns specific to Elasticsearch ingestion (e.g., certificate validation, client authentication) to reduce friction for users configuring secure Elasticsearch endpoints.

---

26-26: Clarify sniffing concept for new users.

Line 26 mentions cluster "sniffing" for auto-discovery but assumes familiarity. Consider expanding briefly: what sniffing does, why users might need it (e.g., cluster topology changes), and any trade-offs or requirements.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5e126a3 and fcc5892.

📒 Files selected for processing (1)

• pipeline/inputs/elasticsearch.md (1 hunks)

🔇 Additional comments (3)

pipeline/inputs/elasticsearch.md (3)

12-12: Inconsistency: Parameter removal claims not reflected in final table.

The AI summary indicates that buffer_max_size, tag_key, meta_key, and version were removed from the parameters table, but these entries remain visible in lines 12, 16, 18, and 20. Additionally, examples on lines 87–88 and 103–104 reference buffer_max_size, which would be unavailable if removal were intentional.

Please clarify whether these parameters should remain documented or whether removal is incomplete.

Also applies to: 16-16, 18-18, 20-20

---

14-14: Verify the intended parameter name per PR objectives.

The PR objective states "Add the missing http configuration parameter," but the added parameter is named http2 (line 14). Confirm whether:

• http2 is the correct parameter name intended to address the objective, or
• An additional http parameter should also be documented.

---

14-17: Well-documented parameter additions.

The new http2, listen, and port parameters are clearly documented with sensible defaults, and the examples correctly demonstrate their usage. This directly addresses the stated objective of adding missing configuration guidance.

Also applies to: 51-52, 65-66, 85-86, 101-102

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fcc5892 and 1aff26e.

📒 Files selected for processing (1)

• pipeline/inputs/elasticsearch.md (1 hunks)

🔇 Additional comments (2)

pipeline/inputs/elasticsearch.md (2)

22-31: Verify TLS property names against Transport Security documentation.

The TLS/SSL section references tls.verify, tls.ca_file, tls.crt_file, and tls.key_file as common configuration options. Ensure these property names match those defined in the Transport Security documentation and that they are the correct properties supported by this input plugin.

---

1-144: Documentation update successfully addresses PR objectives.

The changes effectively implement the stated PR objectives:

• ✓ Added missing HTTP configuration parameters (listen, port, http2)
• ✓ Reorganized documentation with new TLS/SSL and Sniffing sections
• ✓ Updated hostname parameter description and linked it to the new Sniffing section
• ✓ Updated configuration examples to use the new parameters
• ✓ Clarified parameter defaults and layout

The overall structure is well-organized and the new sections provide helpful context for users configuring Elasticsearch ingestion.

[eschabell]

AI review passed, merging.