Log monitoring errors as warning and reduce verbosity #5287
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
nflaig
added
scope-logging
Performance Report✔️ no performance regression detected Full benchmark results
|
wemeetagain
previously approved these changes
Mar 21, 2023
nflaig
commented
Mar 21, 2023
| expect(logger.error).to.have.been.calledWithMatch("Failed to send client stats", {}, error); | ||
| function assertError(error: {message: string}): void { | ||
| // errors are not thrown and need to be asserted based on the log | ||
| expect(logger.warn).to.have.been.calledWithMatch("Failed to send client stats", {reason: error.message}); |
There was a problem hiding this comment.
The assertions here are a bit brittle due to checking the error messages, but should not break unless the log level is changed and having this stricter assertion is important to ensure we are actually testing correctly.
wemeetagain
approved these changes
Mar 21, 2023
|
🎉 This PR is included in v1.7.0 🎉 |
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.
Motivation
Similar to changes introduced in #5285, the monitoring service is just a sidecar to the main functionality/process and should be considered non-critical, meaning it should be fine here if we just log this as a warning.
Description
Log monitoring errors as
warninstead oferrorand reduce verbosity (no stacktrace).The expected errors here are
The error message is enough to convey the issue, the stacktrace is not needed. Based on my observations using this for several weeks the errors I usually see are becasue of timeouts which are kinda expected since we send request 24/7 every minute and the remote service might be unresponsive sometimes.