Updated syslog input plugin doc for new octet counting support. Fixes #2211.

[eschabell]

Updated syslog input plugin doc for new octet counting support. Fixes #2211.

Summary by CodeRabbit

• Documentation
  • Updated syslog configuration parameters from CamelCase to snake_case naming convention; configurations using the old naming format will require updates.
  • Added two new configuration options: format and raw_message_key.

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

[coderabbitai]

Warning

Rate limit exceeded

@eschabell has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 25 minutes and 9 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 4ae631d and c349ea7.

📒 Files selected for processing (1)

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

Walkthrough

The syslog input plugin documentation is updated to standardize configuration parameter names from CamelCase to snake_case. Eleven existing parameters are renamed, and two new options (format and raw_message_key) are introduced to support enhanced syslog input functionality.

Changes

Cohort / File(s)	Change Summary
Syslog Input Documentation pipeline/inputs/syslog.md	Configuration parameter table refactored: CamelCase parameter names (Mode, Listen, Port, Path, Unix_Perm, Parser, Buffer_Chunk_Size, Buffer_Max_Size, Receive_Buffer_Size, Source_Address_Key, Threaded) converted to snake_case equivalents; new options format and raw_message_key added; descriptions and cross-references updated accordingly.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Verify all 11 parameter name conversions from CamelCase to snake_case are consistent and correctly applied
• Confirm new options (format, raw_message_key) are properly documented with descriptions and context
• Check that internal cross-references and footnotes reflect updated parameter names (e.g., Unix_Perm → unix_perm)

Suggested labels

waiting-on-review

Suggested reviewers

• patrick-stephens

Poem

🐰 From CamelCase to snake_case we hop,
Parameters renamed, the changes won't stop,
New options added, the docs now align,
Syslog input shining with format so fine! ✨

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 directly relates to the main change: updating syslog input plugin documentation for octet counting support.
Linked Issues check	✅ Passed	The PR updates syslog input plugin documentation with snake_case configuration parameters and new options including format/raw_message_key relevant to RFC compliance improvements [#2211].
Out of Scope Changes check	✅ Passed	All changes are scoped to syslog input plugin documentation updates; no unrelated modifications are present.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

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: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e63917d and 4ae631d.

📒 Files selected for processing (1)

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

🧰 Additional context used

🪛 GitHub Check: runner / vale

pipeline/inputs/syslog.md

[warning] 13-13:
[vale] reported by reviewdog 🐶
[FluentBit.Acronyms] Spell out 'RFC', if it's unfamiliar to the audience.

Raw Output:
{"message": "[FluentBit.Acronyms] Spell out 'RFC', if it's unfamiliar to the audience.", "location": {"path": "pipeline/inputs/syslog.md", "range": {"start": {"line": 13, "column": 87}}}, "severity": "INFO"}

🪛 LanguageTool

pipeline/inputs/syslog.md

[grammar] ~13-~13: Use a hyphen to join words.
Context: ...at. Set to octet_counting for RFC 6587 compliant octet-counting framing, or `ne...

(QB_NEW_EN_HYPHEN)

🔇 Additional comments (1)

pipeline/inputs/syslog.md (1)

11-24: Parameter naming and new options look good.

The systematic conversion from CamelCase to snake_case across all configuration parameters is consistent and comprehensive. The two new options (format and raw_message_key) are clearly documented with appropriate descriptions and defaults. All example configurations have been correctly updated to use the new naming convention.

[eschabell]

AI review passed, merging.