docs: in_syslog: fix descriptions and typos in config params

[eschabell]

• Rewrite buffer_chunk_size description for clarity
• Fix "TCP port" to "port" (applies to both TCP and UDP modes)
• Fix typo "OS-dependant" to "OS-dependent"
• Add missing comma in parser description
• Remove redundant "(set in code)" from buffer_chunk_size default

Fixes #2355

Summary by CodeRabbit

• Documentation
  • Clarified syslog settings: buffer_chunk_size now describes on-demand, chunked allocation and its role as max message size for UDP transports.
  • Refined parser guidance on fractional seconds and when to prefer RFC5424 vs RFC3164-local formats.
  • Simplified port description to "port to listen for incoming connections."
  • Standardized receive_buffer_size wording and clarified Linux-specific limits.

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

[coderabbitai]

📝 Walkthrough

Walkthrough

Updated syslog input plugin documentation: clarified buffer_chunk_size behavior (on-demand chunked allocation and UDP/unix_udp max message size), refined parser guidance for fractional seconds and RFC selection, simplified port wording, and standardized receive_buffer_size phrasing and OS-dependent note.

Changes

Cohort / File(s)

Summary

Syslog Configuration Documentation pipeline/inputs/syslog.md

Clarified buffer_chunk_size (on-demand, chunked memory allocation; sets max message size for udp/unix_udp); adjusted parser wording around fractional seconds and when to use syslog-rfc5424 vs syslog-rfc3164-local; simplified port to "the port to listen for incoming connections"; standardized and corrected receive_buffer_size wording (maximum socket receive buffer size, OS-dependent, Linux cap note).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested labels

4.2.1

Suggested reviewers

• cosmo0920
• patrick-stephens
• esmerel

Poem

🐇 I nibble lines and tweak a phrase,
Buffers snug in tidy ways,
Parsers sing with seconds true,
Ports listen, clean and new,
Docs hop bright — a rabbit's muse.

🚥 Pre-merge checks | ✅ 5

✅ 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: documentation fixes (descriptions and typos) for in_syslog configuration parameters.
Linked Issues check	✅ Passed	The pull request addresses all objectives from linked issue #2355: clarified descriptions, corrected typos (OS-dependant→OS-dependent), updated configuration parameter documentation, and synchronized content with actual behavior.
Out of Scope Changes check	✅ Passed	All changes are within scope: documentation fixes to syslog input plugin descriptions, typo corrections, and clarity improvements directly related to issue #2355 objectives.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

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

🤖 Fix all issues with AI agents

In `@pipeline/inputs/syslog.md`:
- Line 18: The description for the `port` field incorrectly uses “incoming
connections” which is misleading for UDP; update the documentation string that
mentions `port` and `mode` so it uses connectionless phrasing (e.g., “incoming
traffic/messages/packets” or “incoming messages/packets for UDP, connections for
TCP”) instead of “incoming connections” to accurately describe UDP behavior.
- Line 16: Update the grammar in the `parser` description so the clause reads
with a comma after "udp" and optionally remove the word "then" for clarity;
specifically edit the sentence that currently reads "If `mode` is set to `tcp`
or `udp` then the default parser is `syslog-rfc5424`." to "If `mode` is set to
`tcp` or `udp`, the default parser is `syslog-rfc5424`." in
pipeline/inputs/syslog.md where the `parser` table entry is defined.