Add simpler Alert.raise interface to notify Bugsnag #12992
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
This reverts commit 2eec3d6. We started tracking 404 errors out of interest without an actual problem to solve. Now we face rate-limiting in our Bugsnag account. And we didn't use these 404 reports in the two years this code was active. We don't even act on all 500 errors. So while our resources are so constrained, let's keep our focus on the severe errors and user reports and ignore the rest. 404 errors are mostly generated by vulnerability scanners.
Needs human to review Bugsnag account.
mkllnk
added
the
technical changes only
Bugsnag expects a string as value, not an ActiveRecord object. The result was just "filtered" data, not showing any of the order's attributes. Since wanting to share the order data seems a common pattern, I added a convenience method for it.
I still think that some of these objects won't be visible in Bugsnag but I don't want to test any more on cases that were broken before and may not be relevant now.
Somehow Bugsnag doesn't report in CI environment and I have no idea how to circumvent that. And I don't want to spend more time on this.
dacook
approved these changes
Nov 28, 2024
Comment on lines
+27
to
+29
| # You need to have a valid Bugsnag API key to record this test. | ||
| # And after recording, you need to check the Bugsnag account for the right | ||
| # data. |
rioug
requested changes
Dec 3, 2024
app/jobs/subscription_confirm_job.rb
Outdated
Comment on lines
58
to
60
| Alert.raise(e) do |payload| | ||
| payload.add_metadata :order, :order, order | ||
| end |
There was a problem hiding this comment.
This should be :
Suggested change
| Alert.raise(e) do |payload| | |
| payload.add_metadata :order, :order, order | |
| end | |
| Alert.raise_with_record(e, order) |
rioug
approved these changes
Dec 3, 2024
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.
What? Why?
Bugsnag's API is great for general purpose but overly complex for our use. It also changes over time and we often make mistakes using it. So this class aims at:
In a previous PR, we tried to fix the syntax like this:
But that didn't work. I think that the
orderobject was converted to a hash before but newer versions of Bugsnag have less magic. And passing the order as value doesn't work either, it just got filtered out when I tested. So this pull request adds some logic to convert an ActiveRecord object to proper Bugsnag metadata. We may want to expand the functionality in the future but I didn't want to spend too much time on this now.Hopefully this PR is enough to propagate correct use from now on.
What should we test?
Release notes
Changelog Category (reviewers may add a label for the release notes):
The title of the pull request will be included in the release notes.
Dependencies
Documentation updates