Fixed case in config param table for head input plugin doc. Applies to #2260.

[eschabell]

Fixed case in config param table for head input plugin doc. Applies to #2260.

Summary by CodeRabbit

• Documentation
  • Configuration parameter names in the Head input plugin documentation have been standardized to use consistent snake_case formatting. All parameters now follow a uniform naming convention (e.g., add_path, buf_size, interval_sec). Examples and references throughout the documentation have been updated accordingly.

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

[coderabbitai]

Walkthrough

Documentation update to the Head input plugin that renames configuration parameter keys from CamelCase to snake_case (e.g., Add_Path → add_path, Interval_NSec → interval_nsec). Default values and functionality remain unchanged; only parameter naming conventions are updated in documentation text and examples.

Changes

Cohort / File(s)	Summary
Head input plugin documentation pipeline/inputs/head.md	Parameter names converted from CamelCase to snake_case (Add_Path, Buf_Size, File, Interval_NSec, Interval_Sec, Key, Lines, Split_line, Threaded); example configurations and formula references updated accordingly

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

• Straightforward naming convention updates across documentation
• No logic changes or behavioral modifications
• Verify consistency of snake_case naming throughout examples

Possibly related PRs

• Updated head input plugin doc for standards and order. Fixes #2260. #2261: Modifies the same Head input plugin documentation with identical parameter name conversions (CamelCase to snake_case).

Poem

🐰 The Head now speaks in snake_case true,
No more CamelCase to chew,
Parameters slither, lowercase and clean,
The finest docs we've ever seen!

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 accurately describes the main change: fixing case inconsistencies in configuration parameter names (CamelCase to snake_case) in the head input plugin documentation, which is the primary focus of the changeset.
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

---

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 (1)

pipeline/inputs/head.md (1)

5-19: Clarify that parameter names apply to YAML format.

The configuration table now uses snake_case naming (e.g., add_path, buf_size), which matches the YAML format. However, the classic fluent-bit.conf format uses different casing conventions (e.g., Add_Path, Buf_Size). The documentation should explicitly clarify that the table parameter names apply to YAML configuration files to avoid user confusion, especially since the .conf examples later use different casing.

Consider adding a note above the table: "The parameter names below apply to YAML configuration files. Classic .conf files use CamelCase variations (e.g., Add_Path, Buf_Size)."

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 268b914 and b34412c.

📒 Files selected for processing (1)

• pipeline/inputs/head.md (4 hunks)

🔇 Additional comments (2)

pipeline/inputs/head.md (2)

144-161: Verify correct parameter casing for split_line in .conf format.

Line 150 shows Split_Line in the classic .conf example. For consistency with other .conf parameters shown in this file (e.g., Buf_Size, Interval_Sec), please verify whether this parameter should use different casing. If the actual fluent-bit.conf format accepts lowercase or snake_case for this parameter, it should be changed to match the convention.

---

74-86: Parameter naming appears consistent within the documentation.

The Interval_Nsec parameter on line 81 follows the established CamelCase convention used in this .conf example (consistent with Buf_Size and Interval_Sec). However, verification against the actual fluent-bit plugin implementation requires access to the source code, which is not available in this environment.

[eschabell]

AI review passed, merging.