out_udp: general output doc updates

[eschabell]

• Change Host, Port, Format to lowercase in config table
• Sort configuration parameters alphabetically
• Update command line example to use lowercase parameters

Fixes #2144.

Summary by CodeRabbit

Release Notes

• Documentation
  • UDP output configuration parameter keys updated to lowercase format (host, port, format).
  • Configuration examples updated to reflect new parameter naming.

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

[coderabbitai]

Walkthrough

The UDP output plugin documentation was updated with parameter key casing changes from uppercase to lowercase forms (Host→host, Port→port, Format→format). Configuration descriptions and example command-line invocations were aligned with the new lowercase naming convention. Functional behavior remains unchanged.

Changes

Cohort / File(s)	Summary
UDP output documentation pipeline/outputs/udp.md	Updated parameter keys from uppercase to lowercase (Host, Port, Format → host, port, format); adjusted descriptions and examples to match new casing; json_date_key parameter documented alongside json_date_format.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

• PR #2195: Modifies the same UDP output documentation file and adjusts the same configuration parameter keys (Host/host, Port/port, Format/format, json_date_key/json_date_format).

Suggested labels

4.2.1

Poem

🐰 A rabbit hops through docs with glee,
Where uppercase once danced free—
Now lowercase reigns, clean and bright,
Config keys polished, oh what a sight!
From Host to host, the change takes flight. ✨

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 'out_udp: general output doc updates' accurately describes the main change—updating UDP output plugin documentation with general improvements like parameter casing and ordering.
Linked Issues check	✅ Passed	The PR addresses issue #2144 by creating UDP output plugin documentation (udp.md) with proper parameter documentation and configuration examples, fulfilling the requirement to add UDP plugin docs analogous to TCP documentation.
Out of Scope Changes check	✅ Passed	All changes are scoped to the UDP output plugin documentation file (udp.md) and directly address the objectives in issue #2144: documenting configuration parameters and command-line examples.
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 cb601fc and 538da5f.

📒 Files selected for processing (1)

• pipeline/outputs/udp.md (2 hunks)

🔇 Additional comments (3)

pipeline/outputs/udp.md (3)

80-82: Align .conf format keys with lowercase convention.

The configuration table and YAML examples use lowercase keys (host, port, format), but the .conf format examples still use capitalized keys (Host, Port, Format). This inconsistency may confuse users.

Apply this diff to align the .conf example with the lowercase convention:

-  Host  192.168.2.3
-  Port  5170
-  Format json_lines
+  host  192.168.2.3
+  port  5170
+  format json_lines

---

124-128: Align .conf format keys with lowercase convention.

The configuration table and YAML examples use lowercase keys, but this .conf example still uses mixed-case keys (Host, Port, Format, Json_date_key, Json_date_format).

Apply this diff to align with the documented lowercase convention:

-  Host            127.0.0.1
-  Port            5170
-  Format          json_lines
-  Json_date_key   timestamp
-  Json_date_format iso8601
+  host            127.0.0.1
+  port            5170
+  format          json_lines
+  json_date_key   timestamp
+  json_date_format iso8601

---

181-183: Align .conf format keys with lowercase convention.

For consistency with the configuration table and YAML examples, update the capitalized keys in this .conf example to lowercase.

Apply this diff:

-  Host           127.0.0.1
-  Port           5170
-  Raw_message_key message
+  host           127.0.0.1
+  port           5170
+  raw_message_key message

---

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]

@esmerel review please!

[esmerel]

those are good catches - we're never sure if certain things are capitalized or not so we tend to leave them alone.