docs pipeline: outputs: syslog: document DTLS transport mode - #2643
docs pipeline: outputs: syslog: document DTLS transport mode#2643eschabell wants to merge 2 commits into
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe Syslog output documentation now lists DTLS as a supported transport, defines transport and TLS validation rules, and adds YAML and classic configuration examples. ChangesSyslog DTLS support
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@pipeline/outputs/syslog.md`:
- Line 3: Update the _Syslog_ overview to describe UDP, TCP, and DTLS as
transports, while presenting TLS as optional security applied to a transport
rather than as an independent transport. Apply the same terminology correction
to the related wording in the overview’s transport description.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 9546f5f7-d678-43e8-a595-20759436572d
📒 Files selected for processing (1)
pipeline/outputs/syslog.md
Replace the statement that DTLS isn't supported with the four available transport modes and their tls requirements, including the startup validation rules for mode=dtls and mode=udp. Note that mode=tls alone does not secure the connection, and add a DTLS configuration example. Also, clarified that TLS is not a transport. Note, covers code changes without corresponding docs PR. Signed-off-by: Eric D. Schabell <eric@schabell.org>
19774bb to
3e9e4a6
Compare
|
@patrick-stephens ready for review! |
|
Heads-up: this PR was written before 40641ddb (out_syslog: Handle TLS mode automatically) landed on master, and that commit inverts the central claim in the new "Transport modes" section. After 40641ddb, in plugins/out_syslog/syslog.c and syslog_conf.c:
Suggested corrections to pipeline/outputs/syslog.md on this branch:
Everything else in the PR (the mode parameter description, the TLS properties note) matches the current source. I'll process this in the branch shortly and repost for review @patrick-stephens. |
Upstream commit 40641ddb (out_syslog: Handle TLS mode automatically) changed how mode=tls and mode=dtls interact with the tls parameter. Both modes now enable TLS themselves, and the mode=dtls requires tls=on startup check was removed. Update the docs to match: - Intro: list UDP, TCP, TLS, and DTLS as four transports, and drop the claim that TLS isn't a transport of its own. - Transport modes table: change the tls setting for tls and dtls from required to optional and enabled automatically, and drop "behaves the same as tcp" from the tls row. - Replace the paragraph stating that mode=tls doesn't secure the connection on its own with the automatic TLS behavior. - Startup validation: remove the mode=dtls requires tls=on bullet, which no longer exists in the source, and add a bullet for builds compiled without TLS support failing with "TLS support is unavailable". - DTLS example: drop the now-redundant tls: on from both the YAML and classic configuration tabs. Signed-off-by: Eric D. Schabell <eric@schabell.org>
|
@coderabbitai review |
✅ Action performedReview finished.
|
|
@patrick-stephens ready for your review! |
|
@eschabell does that mean it's only on |
2 participants
Replace the statement that DTLS isn't supported with the four available transport modes and their tls requirements, including the startup validation rules for mode=dtls and mode=udp. Note that mode=tls alone does not secure the connection, and add a DTLS configuration example.
Note, covers code changes without corresponding docs PR.
Summary by CodeRabbit