telemetry: add no-op functionality to SegmentClient to make sure errors in initialization are not fatal #4100
Conversation
This file contains hidden or 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
cfergeau
reviewed
Apr 3, 2024
gbraad
requested changes
Apr 10, 2024
|
I think something went wrong during rebase, as I see some stuff about snyk and the However, the rest looks good to me, |
cfergeau
reviewed
Apr 22, 2024
There was a problem hiding this comment.
Looks good to me, I'd squash the 2 commits though, we don't need to have the isInitProperly version of the code in the upstream git history.
The shortlog for both commits overflows on github, it's supposed to be kept short, with a longer description in the longer commit log.
telemetry: add no-op functionality
Currently, when telemetry initialization fails, this is a hard failure for the `crc` command and daemon, and they exit.
This commit handles this more gracefully, when there's a telemetry initialization failure, an empty `NoOp` `Client` instance is returned, and all `Client` methods check for this `NoOp` instance and return early if needed.
About 20 to 30 characters. |
Currently, when telemetry initialization fails, this is a hard failure for the `crc` command and daemon, and they exit. This commit handles this more gracefully, when there's a telemetry initialization failure, an empty `Noop Client` instance is returned, and all `Client` methods check for this `Noop` instance and return early if needed.
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.
Fixes: Issue #4085
A new field has been added to Client struct signalling whether the client has been initialized properly. Default value is
falseand it is set totrueonly if the initialization went as expected.Methods on Client check if this field is true before progressing further.
In case of any error during initialization, an empty Client is returned (and its methods do nothing).