service: prepend the windowsEventLogCore #5298
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## main #5298 +/- ##
=======================================
Coverage 90.58% 90.58%
=======================================
Files 190 190
Lines 11109 11109
=======================================
Hits 10063 10063
Misses 824 824
Partials 222 222 Continue to review full report at Codecov.
|
jsuereth
approved these changes
May 4, 2022
dashpole
approved these changes
May 4, 2022
braydonk
force-pushed
the
PrependWindowsEventLog
branch
from
9fecdb0
to
4268dd2
Compare
dashpole
approved these changes
May 4, 2022
codeboten
approved these changes
May 5, 2022
mx-psi
pushed a commit
that referenced
this pull request
Sep 16, 2024
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description In the CollectorSettings LoggingOptions, when the options are `zap.WrapCore`, the final core wrapped will end up running first. For this reason, the windowsEventLogCore must be the first option in the list of user supplied options, to ensure user supplied options are run before the core that writes to the Windows Event Log. Prior art: I fixed this before in #5298. <!-- Issue number if applicable --> #### Link to tracking issue #5297 <!--Describe what testing was performed and which tests were added.--> #### Testing Testing was manual by running the Collector as a service after this change. I tried to add a unit test but could not find an effective way to do that due to all the type indirection done by the `zap` package. I was hoping to find an easy way to tell that the `windowsEventLogCore` is the first core wrapped in the options but I could not find a way to pull that off. Open to ideas if anyone can find a way.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
When the
windowsEventLogCoreis appended to the logging options, it makes the event log core run before any user specified options. This is undesirable because it means the logs are sent to the event log before any of the user's options are applied. This PR changesnewWithWindowsEventLogCoreto prepending thewindowsEventLogCoreoption to the array of LoggingOptions, so it will always run after the user specified options.Link to tracking Issue: #5297
Testing:
makeandmake fmt