Updated exec input plugin doc config parameter table and general standardization. Fixes #2249.

[eschabell]

Updated exec input plugin doc config parameter table and general standardization. Fixes #2249.

Summary by CodeRabbit

• Documentation
  • Configuration keys renamed to snake_case (e.g., Command → command, Parser → parser, Interval_Sec → interval_sec)
  • Configuration table adds a Default column and updates default values (e.g., buf_size 4096, interval_sec 1, interval_nsec 0, oneshot false, threaded false)
  • Usage examples and narrative updated to use new key names (including exit_after_oneshot and propagate_exit_code)

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

[coderabbitai]

Walkthrough

Documentation for the exec input plugin updated: configuration keys were renamed from CamelCase to snake_case and a "Default" column with clarified default values was added; examples and prose were adjusted to use the new key names and defaults.

Changes

Cohort / File(s)

Summary

Exec input plugin documentation pipeline/inputs/exec.md

Rename configuration keys from CamelCase to snake_case (Command → command, Parser → parser, Interval_Sec → interval_sec, Interval_NSec → interval_nsec, Buf_Size → buf_size, Oneshot → oneshot, Exit_After_Oneshot → exit_after_oneshot, Propagate_Exit_Code → propagate_exit_code, Threaded → threaded); add a "Default" column and set/clarify defaults (e.g., buf_size: 4096, interval_sec: 1, interval_nsec: 0, oneshot: false, threaded: false); update examples and prose to use lowercase key names and new defaults.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

• Verify consistent key renames throughout the document.
• Confirm default values in the table and examples match the intended defaults.
• Check prose and example command blocks for lowercase keys.

Possibly related PRs

• Fixed config doc error and general cleanup on exec wasi input plugin doc. Fixes #2247. #2248 — Same refactor of configuration keys to snake_case and defaults updates for exec variants.
• Added two new config parameters and general updates to docker metrics input plugin doc. Fixes #2241. #2242 — Same API-style rename to snake_case for input-plugin docs (interval_sec, interval_nsec, threaded).
• Adjusted config option table and cleanup of disk io metrics input plugin doc. Fixes #2235. #2236 — Standardization of configuration option names from CamelCase to snake_case in input plugin docs.

Suggested reviewers

• esmerel
• alexakreizinger

Poem

🐇 I hopped through docs at break of day,
CamelCase carrots rolled away.
Lowercase leaves now neatly spread,
Defaults tucked snug for each bed.
Thump-thump — a tidy trail ahead.

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 summarizes the main change: updating the exec input plugin documentation with config parameter table revisions and standardization, directly matching the changeset.
Linked Issues check	✅ Passed	The PR meets the primary objectives from issue #2249: the configuration parameter table has been updated with snake_case naming and default values, and general standardization has been applied throughout the documentation.
Out of Scope Changes check	✅ Passed	All changes are in-scope and directly address the linked issue requirements: configuration key standardization, default value additions, and documentation wording updates are all aligned with the stated objectives.
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: 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 d96332f and 21f91be.

📒 Files selected for processing (1)

• pipeline/inputs/exec.md (3 hunks)

🔇 Additional comments (2)

pipeline/inputs/exec.md (2)

186-188: Update configuration keys in security concerns example.

The security section example still references the old CamelCase keys (exit_after_oneshot, propagate_exit_code), which is inconsistent with the documented updates. If the standardization is to use snake_case, this example is already correct; however, verify this aligns with your standardization goal. If .conf format keys are CamelCase, the .conf examples elsewhere should match this pattern.

---

21-31: Configuration table restructuring is clear.

The parameter table now clearly lists all configuration keys, their descriptions, and default values. The addition of the Default column improves clarity for users. The snake_case naming convention in the table is well-structured.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

pipeline/inputs/exec.md (1)

28-28: Minor: Consider shorter alternative to "prior to".

Line 28 uses "prior to" which is slightly wordy for documentation. Consider replacing with "before" for a more concise phrasing: "This allows collection of data before Fluent Bit startup."

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 21f91be and 316e560.

📒 Files selected for processing (1)

• pipeline/inputs/exec.md (3 hunks)

🧰 Additional context used

🪛 LanguageTool

pipeline/inputs/exec.md

[style] ~28-~28: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...startup. This allows collection of data prior to Fluent Bit startup. ...

(EN_WORDINESS_PREMIUM_PRIOR_TO)

🔇 Additional comments (4)

pipeline/inputs/exec.md (4)

21-31: Configuration table standardization looks solid.

The table properly uses snake_case keys with explicit defaults and clear dependencies documented in descriptions. This aligns with YAML pipeline format conventions and addresses the standardization requirements from issue #2249.

---

63-101: Format-specific examples correctly demonstrate naming conventions.

Both YAML (snake_case) and fluent-bit.conf (CamelCase) examples use format-appropriate keys. The side-by-side presentation effectively shows the distinction, addressing the standardization goal.

---

105-165: Wrapper section correctly uses updated key names.

Narrative and examples consistently use snake_case in YAML (line 117-118) and CamelCase in .conf (lines 134-135). Security guidance and exit code documentation remain clear and comprehensive.

---

166-169: Parser option reference properly uses snake_case.

Narrative correctly refers to the parser option in lowercase, consistent with documentation standardization.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

pipeline/inputs/exec.md (3)

63-101: Consider adding an explicit note clarifying configuration key naming by format.

The examples correctly show snake_case for YAML and CamelCase for fluent-bit.conf, and the tab labels help distinguish them. However, a previous review suggested adding an explicit prose note above the examples to clarify this naming convention difference. While the tab structure is helpful, users who only reference the configuration parameter table (which uses snake_case) and then glance at one example might not realize the naming depends on the format.

Consider adding a brief note like: "Configuration keys use lowercase snake_case in YAML pipeline format (e.g., buf_size, interval_sec) and CamelCase with underscores in INI-style .conf format (e.g., Buf_Size, Interval_Sec). Use the format-appropriate keys for your configuration file type."

---

168-168: Minor grammar refinement: awkward double preposition.

Line 168 reads: "Use the parser option to specify the name of a parser configuration to use to process the command input."

The phrase "to use to process" contains a redundant preposition. Suggest: "...parser configuration to parse the command input." or "...parser configuration for processing the command input."

---

28-28: Fix grammar: remove or replace the preposition "to."

Line 28 reads: "This allows collection of data before to Fluent Bit startup."

The phrase "before to" is grammatically awkward. Suggest: "This allows collection of data before Fluent Bit startup." or "...data prior to Fluent Bit startup."

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 316e560 and 6285a4d.

📒 Files selected for processing (1)

• pipeline/inputs/exec.md (3 hunks)

🔇 Additional comments (1)

pipeline/inputs/exec.md (1)

21-31: Configuration parameter table is well-structured and complete. ✓

The table correctly documents snake_case keys with sensible defaults and clear descriptions. Default values like 4096 for buf_size and 1 for interval_sec are appropriate.

[eschabell]

AI review (and @patrick-stephens!) passed, merging.