-
Notifications
You must be signed in to change notification settings - Fork 4.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[filebeat] Update documentation / changelog / beta warnings for the syslog input #25047
Conversation
Pinging @elastic/agent (Team:Agent) |
💚 Build Succeeded
Expand to view the summary
Build stats
Test stats 🧪
Trends 🧪💚 Flaky test reportTests succeeded. Expand to view the summary
Test stats 🧪
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
minor edit; otherwise LGTM
<<{beatname_lc}-input-{type}-common-options>> described later. | ||
|
||
===== `format` | ||
|
||
Which syslog variant to use: `rfc3164`, `rfc5424`, or `auto` to attempt to detect the variant automatically from the log entries. The default is `rfc3164`. `rfc5424` and `auto` options are currently in beta. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Which syslog variant to use: `rfc3164`, `rfc5424`, or `auto` to attempt to detect the variant automatically from the log entries. The default is `rfc3164`. `rfc5424` and `auto` options are currently in beta. | |
The syslog variant to use when attempting to detect the variant automatically from the log entries. Valid values are `rfc3164`, `rfc5424`, or `auto`. The default is `rfc3164`. The `rfc5424` and `auto` options are currently in beta. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggest moving the list of valid values later in case we add support for more variants. 3 is OK, 4 would be too much.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The suggested edit doesn't quite work since auto-detection is only used for the auto
setting -- I tried to clarify, let me know if this version works.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! LGTM.
…-github-pr-comment-template * upstream/master: [Ingest Manager] Keep http and logging config during enroll (elastic#25132) Refactor kubernetes autodiscover to avoid skipping short-living pods (elastic#24742) [libbeat] New decode xml wineventlog processor (elastic#25115) Add svc to agent k8s clusterRole (elastic#25146) Add awsfargate module to collect container logs from Amazon ECS on Fargate (elastic#25041) [Filebeat][Cisco ASA] log enhancement and performance (elastic#24744) Watch kubernetes namespaces for autodiscover metadata for pods (elastic#25117) Cyberark Privileged Access Security module (elastic#24803) [Elastic Agent] Log the container command output with LOGS_PATH (elastic#25150) Fix for tests after `device...` field has been removed (elastic#25141) [Ingest Manager] Restart process on output change (elastic#24907) Set --insecure in container when FLEET_SERVER_ENABLE and FLEET_INSECURE set. (elastic#25137) [filebeat] Update documentation / changelog / beta warnings for the syslog input (elastic#25047) Add support for ignore_inactive in filestream input (elastic#25036) Fix bug with annotations dedot config on k8s not used (elastic#25111)
What does this PR do?
This is a followup to #23954, which added support for syslog RFC 5424. This PR updates the documentation and changelog, and logs a beta warning when using the new RFC format. This is part of the meta-issue to complete the syslog input and bring it to GA.
My code follows the style guidelines of this projectI have commented my code, particularly in hard-to-understand areasI have added tests that prove my fix is effective or that my feature worksCHANGELOG.next.asciidoc
orCHANGELOG-developer.next.asciidoc
.