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

winlogbeat/eventlog: ensure event loggers retain metric collection when handling recoverable errors #36483

Merged
merged 1 commit into from
Sep 5, 2023

Conversation

efd6
Copy link
Contributor

@efd6 efd6 commented Sep 1, 2023

Proposed commit message

When winlogbeat's event loggers encounter recoverable errors they handle this by closing and reopening the channel. This causes the metric collection for the beat and dependent winlog filebeat input to lose metric collection as metric registration only occurs on configuration. So add a soft-close method, Reset, that only closes the channel and leaves the event logger valid, leaving the metrics in tact, and use this for recovering from errors.

Checklist

  • 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.

Author's Checklist

  • [ ]

How to test this PR locally

Related issues

Use cases

Screenshots

Logs

@efd6 efd6 self-assigned this Sep 1, 2023
@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 Sep 1, 2023
@efd6 efd6 force-pushed the 36479-winlog_winlogbeat-alt branch from 917b8e9 to f4ed25b Compare September 1, 2023 04:44
@elasticmachine
Copy link
Collaborator

elasticmachine commented Sep 1, 2023

💚 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 preview

Expand to view the summary

Build stats

  • Start Time: 2023-09-05T20:33:37.117+0000

  • Duration: 73 min 57 sec

Test stats 🧪

Test Results
Failed 0
Passed 9151
Skipped 764
Total 9915

💚 Flaky test report

Tests succeeded.

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@efd6 efd6 marked this pull request as ready for review September 1, 2023 06:01
@efd6 efd6 requested a review from a team as a code owner September 1, 2023 06:01
@elasticmachine
Copy link
Collaborator

Pinging @elastic/security-external-integrations (Team:Security-External Integrations)

Copy link
Member

@andrewkroh andrewkroh left a comment

Choose a reason for hiding this comment

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

LGTM

@taylor-swanson Do you want to take a look? I know you have been involved in improving handling recoverable errors.

@mergify
Copy link
Contributor

mergify bot commented Sep 5, 2023

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b 36479-winlog_winlogbeat-alt upstream/36479-winlog_winlogbeat-alt
git merge upstream/main
git push upstream 36479-winlog_winlogbeat-alt

Copy link
Contributor

@taylor-swanson taylor-swanson left a comment

Choose a reason for hiding this comment

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

LGTM

…en handling recoverable errors

When winlogbeat's event loggers encounter recoverable errors they handle
this by closing and reopening the channel. This causes the metric
collection for the beat and dependent winlog filebeat input to lose
metric collection as metric registration only occurs on configuration.
So add a soft-close method, Reset, that only closes the channel and
leaves the event logger valid, leaving the metrics in tact, and use this
for recovering from errors.
@efd6 efd6 force-pushed the 36479-winlog_winlogbeat-alt branch from f4ed25b to 14d0dc4 Compare September 5, 2023 20:33
@efd6 efd6 merged commit edc7321 into elastic:main Sep 5, 2023
10 checks passed
mergify bot pushed a commit that referenced this pull request Sep 5, 2023
…en handling recoverable errors (#36483)

When winlogbeat's event loggers encounter recoverable errors they handle
this by closing and reopening the channel. This causes the metric
collection for the beat and dependent winlog filebeat input to lose
metric collection as metric registration only occurs on configuration.
So add a soft-close method, Reset, that only closes the channel and
leaves the event logger valid, leaving the metrics in tact, and use this
for recovering from errors.

(cherry picked from commit edc7321)
efd6 added a commit that referenced this pull request Sep 9, 2023
…ain metric collection when handling recoverable errors (#36517)

* winlogbeat/eventlog: ensure event loggers retain metric collection when handling recoverable errors (#36483)

When winlogbeat's event loggers encounter recoverable errors they handle
this by closing and reopening the channel. This causes the metric
collection for the beat and dependent winlog filebeat input to lose
metric collection as metric registration only occurs on configuration.
So add a soft-close method, Reset, that only closes the channel and
leaves the event logger valid, leaving the metrics in tact, and use this
for recovering from errors.

(cherry picked from commit edc7321)

* remove irrelevant changelog line

---------

Co-authored-by: Dan Kortschak <[email protected]>
Scholar-Li pushed a commit to Scholar-Li/beats that referenced this pull request Feb 5, 2024
…en handling recoverable errors (elastic#36483)

When winlogbeat's event loggers encounter recoverable errors they handle
this by closing and reopening the channel. This causes the metric
collection for the beat and dependent winlog filebeat input to lose
metric collection as metric registration only occurs on configuration.
So add a soft-close method, Reset, that only closes the channel and
leaves the event logger valid, leaving the metrics in tact, and use this
for recovering from errors.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Filebeat] winlog input metrics are unregistered after recovery
4 participants