Skip to content
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

Merged
merged 7 commits into from
Apr 19, 2021

Conversation

faec
Copy link
Contributor

@faec faec commented Apr 13, 2021

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 project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

@faec faec added docs needs_backport PR is waiting to be backported to other branches. cleanup Team:Elastic-Agent Label for the Agent team 7.13 candidate labels Apr 13, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/agent (Team:Agent)

@botelastic botelastic bot added needs_team Indicates that the issue/PR needs a Team:* label and removed needs_team Indicates that the issue/PR needs a Team:* label labels Apr 13, 2021
@faec faec mentioned this pull request Apr 13, 2021
7 tasks
@elasticmachine
Copy link
Collaborator

elasticmachine commented Apr 13, 2021

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview

Expand to view the summary

Build stats

  • Build Cause: Started by user Ivan Fernandez Calvo

  • Start Time: 2021-04-16T08:16:37.438+0000

  • Duration: 60 min 48 sec

  • Commit: 881e994

Test stats 🧪

Test Results
Failed 0
Passed 13531
Skipped 2271
Total 15802

Trends 🧪

Image of Build Times

Image of Tests

💚 Flaky test report

Tests succeeded.

Expand to view the summary

Test stats 🧪

Test Results
Failed 0
Passed 13531
Skipped 2271
Total 15802

Copy link
Contributor

@dedemorton dedemorton left a 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Copy link
Contributor

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.

Copy link
Contributor Author

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.

Copy link
Contributor

@dedemorton dedemorton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! LGTM.

@faec faec added the backport-v7.13.0 Automated backport with mergify label Apr 19, 2021
@faec faec merged commit 36af608 into elastic:master Apr 19, 2021
mergify bot pushed a commit that referenced this pull request Apr 19, 2021
@faec faec deleted the syslog-docs branch April 19, 2021 13:38
v1v added a commit to v1v/beats that referenced this pull request Apr 20, 2021
…-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)
faec added a commit that referenced this pull request Apr 20, 2021
…yslog input (#25047) (#25142)

(cherry picked from commit 36af608)

Co-authored-by: Fae Charlton <fae.charlton@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
7.13 candidate backport-v7.13.0 Automated backport with mergify cleanup docs needs_backport PR is waiting to be backported to other branches. Team:Elastic-Agent Label for the Agent team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants