Patch BigQueryClient to retry on network error #3088
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
At the moment sometimes long jobs can cause the BigQueryClient to timeout since the connection is created at initialisation of the target. This patch retries by re-creating the client object if it fails (up to a retry limit), so that the client will not be timed out when calling `complete()` on the BigQueryTarget after a long job.
hirosassa
reviewed
Jun 23, 2021
luigi/contrib/bigquery.py
Outdated
Comment on lines
161
to
166
| except (TimeoutError, BrokenPipeError, IOError) as bq_connection_error: | ||
| if self.retry_count > self.retry_limit: | ||
| raise Exception(f"Exceeded max retries for BigQueryClient connection error: {bq_connection_error}") from bq_connection_error | ||
| self.retry_count += 1 | ||
| self.__initialise_client() | ||
| self.dataset_exists(dataset) |
There was a problem hiding this comment.
How about using retry decorator to simplify the codes?
The implementation below will be helpful.
https://github.com/spotify/luigi/blob/master/luigi/contrib/gcs.py#L72-L81
There was a problem hiding this comment.
Thanks, I'll make that change.
There was a problem hiding this comment.
@jamesmcm Thank you! Looks good to me, but flake8 notifies some formatting problems.
There was a problem hiding this comment.
Thanks, I fixed that too.
Note the use of the after lambda function to re-create the client if the connection fails
|
This PR looks great! |
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
This patch retries by re-creating the client object if it fails (up to a retry limit), so that the client will not be timed out when calling
complete()on the BigQueryTarget after a long job.Motivation and Context
At the moment sometimes long jobs can cause the BigQueryClient to timeout since the connection is created at initialisation of the target.
Have you tested this? If so, how?
Yes, passing this patched client worked for jobs that would have timeout issues previously.