Instrument transient GitHub user refresh failures - #1492
Open
jt-schmidt wants to merge 1 commit into
Open
Conversation
Assisted-By: devx/c427d7ec-0c56-4e55-a319-ae0556f7c78b
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
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
Adds targeted observability for transient GitHub network failures during
Shipit::User#refresh_from_github!.When a refresh fails with a known transient connection/timeout error (
Faraday::ConnectionFailed,Faraday::TimeoutError,Net::OpenTimeout,Net::ReadTimeout), Shipit now:ActiveSupport::Notificationsevent:transient_github_refresh_error.shipitWhy
PI investigation of shop/issues#16591 / Vault issue 15928 found the current Observe error group is from
Shipit::RefreshGithubUserJobtiming out while opening a TCP connection toapi.github.com:443.This keeps the first change low risk: add signal before changing retry/error reporting behavior.
Test plan
Net::OpenTimeoutduringrefresh_from_github!emits the notification, logs, and re-raises.ruby -c app/models/shipit/user.rbruby -c test/models/users_test.rbI could not run the full model test locally because the checkout is missing bundled native/test dependencies (
Bundler::GemNotFoundfor sqlite3/ejson-rails/mysql2/etc.).Refs: https://github.com/shop/issues/issues/16591