Updated collectd input plugin docs with missing information. Fix #2196.

[eschabell]

Updated collectd input plugin docs with missing information. Fix #2196.

Summary by CodeRabbit

• Documentation
  • Enhanced Collectd input documentation with improved configuration examples, command-line usage guidance, and clarified default behavior.
  • Added comprehensive TypesDB configuration section with detailed precedence rules for multiple files, practical YAML examples, and best practices.
  • Standardized configuration key naming conventions and corrected file path references for improved usability.

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

[coderabbitai]

Walkthrough

Updated documentation for the Collectd input plugin, including reworded descriptions, renamed configuration keys to lowercase, fixed path typo, expanded examples section, and added detailed TypesDB configuration guidance with precedence rules.

Changes

Cohort / File(s)	Summary
Collectd input plugin documentation pipeline/inputs/collectd.md	Reworded description to clarify UDP transport and protocol-to-records conversion; renamed Listen/Port/TypesDB/Threaded config keys to lowercase; fixed /user/share typo to /usr/share; expanded "Get started" section with CLI usage and command examples; replaced warning with detailed "TypesDB configuration" section explaining multiple-file support, precedence rules, and YAML examples.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Verify accuracy of the reworded Collectd input description and UDP transport details
• Confirm lowercase configuration key changes align with actual plugin implementation
• Validate TypesDB precedence rules and multi-file behavior documentation
• Review YAML examples for correctness and clarity

Suggested labels

waiting-on-review

Suggested reviewers

• esmerel
• patrick-stephens

Poem

🐰 Configuration keys in lowercase now hop,
TypesDB precedence rules never stop,
Fixed that typo, examples run deep,
Documentation changes—quality to keep! 📚✨

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 identifies the main change: updating collectd input plugin documentation with missing information and references the fixed issue.
Linked Issues check	✅ Passed	The pull request comprehensively addresses issue #2196 by adding missing documentation details including configuration examples, TypesDB explanation, and command-line usage.
Out of Scope Changes check	✅ Passed	All changes are focused on updating the collectd input plugin documentation file with relevant information directly aligned with issue #2196 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

🧹 Nitpick comments (1)

pipeline/inputs/collectd.md (1)

76-88: Address static analysis style warnings.

The new TypesDB configuration section provides valuable documentation on precedence rules and multiple file support. However, two style issues flagged by the FluentBit documentation linter need correction:

1. Line 76: The heading "TypesDB configuration" should use sentence-style capitalization per FluentBit conventions (should be "Typesdb configuration").
2. Line 80: The phrase "allows you to" should be replaced with "lets you" per FluentBit style guidelines.

Apply this diff to address the style warnings:

-## TypesDB configuration
+## Typesdb configuration

-The `TypesDB` parameter supports multiple files separated by commas. When multiple files are specified, later entries take precedence over earlier ones if there are duplicate type definitions. This allows you to override default types with custom definitions.
+The `TypesDB` parameter supports multiple files separated by commas. When multiple files are specified, later entries take precedence over earlier ones if there are duplicate type definitions. This lets you override default types with custom definitions.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b3757b8 and 1e1cf1d.

📒 Files selected for processing (1)

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

🧰 Additional context used

🪛 GitHub Check: runner / vale

pipeline/inputs/collectd.md

[warning] 80-80:
[vale] reported by reviewdog 🐶
[FluentBit.WordList] Use 'lets you' instead of 'allows you to'.

Raw Output:
{"message": "[FluentBit.WordList] Use 'lets you' instead of 'allows you to'.", "location": {"path": "pipeline/inputs/collectd.md", "range": {"start": {"line": 80, "column": 199}}}, "severity": "INFO"}

---

[warning] 76-76:
[vale] reported by reviewdog 🐶
[FluentBit.Headings] 'TypesDB configuration' should use sentence-style capitalization.

Raw Output:
{"message": "[FluentBit.Headings] 'TypesDB configuration' should use sentence-style capitalization.", "location": {"path": "pipeline/inputs/collectd.md", "range": {"start": {"line": 76, "column": 4}}}, "severity": "INFO"}

🪛 LanguageTool

pipeline/inputs/collectd.md

[grammar] ~18-~18: Ensure spelling is correct
Context: ... | ## Get started To receive collectd datagrams, you can run the plugin from ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🔇 Additional comments (2)

pipeline/inputs/collectd.md (2)

13-13: Valid typo fix.

The correction from /user/share/collectd/types.db to /usr/share/collectd/types.db aligns with standard Linux filesystem hierarchy. This fix is correct across all instances.

Also applies to: 49-49, 64-64, 85-85

---

16-74: Excellent documentation improvements.

The expanded "Get started" section with practical command-line and configuration examples significantly improves usability. The examples clearly demonstrate default behavior and parameter overrides.

[eschabell]

AI review passed, merging.