Updated head input plugin doc for standards and order. Fixes #2260.

[eschabell]

Updated head input plugin doc for standards and order. Fixes #2260.

Summary by CodeRabbit

• Documentation
  • Added explicit default values for configuration parameters for clarity
  • Introduced comprehensive Getting started section with command-line and configuration file examples
  • Enhanced documentation with illustrative usage examples and output demonstrations
  • Reorganized configuration examples for improved readability

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

[coderabbitai]

Walkthrough

The Head input plugin documentation has been updated to include a Default column in the parameter table with explicit default values for all configuration options, and a comprehensive Getting started section with command-line and configuration file examples demonstrating practical usage.

Changes

Cohort / File(s)

Summary

Head input plugin documentation pipeline/inputs/head.md

Added Default column to parameter table with explicit default values (Add_Path, Buf_Size, File, Interval_NSec, Interval_Sec, Key, Lines, Split_line, Threaded); expanded Getting started section with command-line and configuration file examples (YAML and fluent-bit.conf formats); reorganized and reformatted configuration examples with improved indentation and key alignment; removed/condensed previous Get started sections and historical examples

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Documentation-only changes with content reorganization and formatting updates
• Verify accuracy of newly added default parameter values
• Review consistency of example configurations across different formats (YAML and fluent-bit.conf)

Poem

🐰 With docs now shining, defaults made plain,
Examples dance through sun and rain,
The Head input's path is crystal clear,
A Getting started guide for all to cheer! 📚✨

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 describes the main change: updating the head input plugin documentation for standards and order, with explicit issue reference.
Linked Issues check	✅ Passed	The pull request addresses both objectives from issue #2260: standardizing configuration options (by adding explicit default values) and reorganizing documentation layout.
Out of Scope Changes check	✅ Passed	All changes are scoped to head input plugin documentation updates, with no unrelated modifications to code or other components.
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 47ab62f and f27e98f.

📒 Files selected for processing (1)

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

🧰 Additional context used

🪛 LanguageTool

pipeline/inputs/head.md

[grammar] ~97-~97: Use a hyphen to join words.
Context: ...le: 1.5s = 1s + 500000000ns. ## Split line mode Use this mode to get a specif...

(QB_NEW_EN_HYPHEN)

🔇 Additional comments (4)

pipeline/inputs/head.md (4)

9-19: Default values column added for clarity.

The configuration parameters table is well-structured with explicit defaults now documented. This improves usability by showing users what to expect without setting explicit parameters.

A minor clarification concern: Line 17 documents Lines with default 0 and description "If the number N is set, in_head reads first N lines like head(1) -n." The semantics of the default (whether 0 means read all lines or read no lines) could be clearer in the description itself.

Please confirm that the documented default values (especially for Buf_Size: 256, Interval_Sec: 1, Key: head, and Lines: 0) match the actual plugin defaults in the codebase.

---

21-95: Getting started section is well-structured and practical.

The new comprehensive section effectively demonstrates usage through both command-line and configuration file approaches. The examples are clear, self-contained, and show realistic output. The interval calculation explanation at lines 91-95 is particularly helpful for users understanding the timing model.

Run the documented command-line example and verify that the output matches the expected format shown in lines 35-47 to ensure the example remains accurate with current Fluent Bit versions.

---

101-164: Configuration examples are clear and well-formatted.

The YAML and fluent-bit.conf examples are properly indented, use consistent parameter naming (with proper casing), and clearly demonstrate the split-line mode functionality. The inline comment at line 151 explaining the output structure is particularly helpful for users.

---

97-97: Hyphenate compound modifier "split-line".

Per documentation standards for compound modifiers, this should be "Split-line mode" rather than "Split line mode".

-## Split line mode
+## Split-line mode

---

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.