HADOOP-18606. Add reason in in x-ms-client-request-id on a retry API call. #5299
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| package org.apache.hadoop.fs.azurebfs.services; | ||
|
|
||
| import java.io.IOException; | ||
| import java.net.SocketException; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| public enum RetryReason { | ||
steveloughran marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| CONNECTION_TIMEOUT(((exceptionCaptured, statusCode) -> { | ||
| return exceptionCaptured != null && "connect timed out".equalsIgnoreCase( | ||
| exceptionCaptured.getMessage()); | ||
| }), 2, "CT"), | ||
| READ_TIMEOUT(((exceptionCaptured, statusCode) -> { | ||
| return exceptionCaptured != null && "Read timed out".equalsIgnoreCase( | ||
| exceptionCaptured.getMessage()); | ||
| }), 2, "RT"), | ||
| UNKNOWN_HOST("UH"), | ||
| CONNECTION_RESET(((exceptionCaptured, statusCode) -> { | ||
| return exceptionCaptured != null && exceptionCaptured.getMessage() != null | ||
| && exceptionCaptured.getMessage().contains("Connection reset"); | ||
| }), 2, "CR"), | ||
| STATUS_5XX(((exceptionCaptured, statusCode) -> { | ||
| return statusCode / 100 == 5; | ||
| }), 0, ((ex, statusCode, serverErrorMessage) -> { | ||
| if (statusCode == 503) { | ||
| //ref: https://github.com/apache/hadoop/pull/4564/files#diff-75a2f54df6618d4015c63812e6a9916ddfb475d246850edfd2a6f57e36805e79 | ||
| serverErrorMessage = serverErrorMessage.split(System.lineSeparator(), | ||
| 2)[0]; | ||
| if ("Ingress is over the account limit.".equalsIgnoreCase( | ||
| serverErrorMessage)) { | ||
| return "ING"; | ||
| } | ||
| if ("Egress is over the account limit.".equalsIgnoreCase( | ||
| serverErrorMessage)) { | ||
| return "EGR"; | ||
| } | ||
| if ("Operations per second is over the account limit.".equalsIgnoreCase( | ||
| serverErrorMessage)) { | ||
| return "OPR"; | ||
| } | ||
| return "503"; | ||
| } | ||
| return statusCode + ""; | ||
| })), | ||
| STATUS_4XX(((exceptionCaptured, statusCode) -> { | ||
| return statusCode / 100 == 4; | ||
| }), 0, ((ex, statusCode, serverErrorMessage) -> { | ||
| return statusCode + ""; | ||
| })), | ||
| UNKNOWN_SOCKET_EXCEPTION(((exceptionCaptured, statusCode) -> { | ||
| return exceptionCaptured instanceof SocketException; | ||
| }), 1, "SE"), | ||
| UNKNOWN_IO_EXCEPTION(((exceptionCaptured, statusCode) -> { | ||
| return exceptionCaptured instanceof IOException; | ||
| }), 0, "IOE"); | ||
|
|
||
| private RetryReasonCaptureMechanism mechanism = null; | ||
steveloughran marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| private RetryReasonAbbreviationCreator retryReasonAbbreviationCreator = null; | ||
|
|
||
| private int rank = 0; | ||
|
|
||
| private String abbreviation; | ||
|
|
||
| RetryReason(String abbreviation) { | ||
| this.abbreviation = abbreviation; | ||
| } | ||
|
|
||
| RetryReason(RetryReasonCaptureMechanism mechanism, | ||
| int rank, | ||
| String abbreviation) { | ||
| this.mechanism = mechanism; | ||
| this.rank = rank; | ||
| this.abbreviation = abbreviation; | ||
| } | ||
|
|
||
| RetryReason(RetryReasonCaptureMechanism mechanism, | ||
| int rank, | ||
| RetryReasonAbbreviationCreator abbreviationCreator) { | ||
| this.mechanism = mechanism; | ||
| this.rank = rank; | ||
| this.retryReasonAbbreviationCreator = abbreviationCreator; | ||
| } | ||
|
|
||
| public String getAbbreviation(Exception ex, | ||
| Integer statusCode, | ||
| String serverErrorMessage) { | ||
| if (abbreviation != null) { | ||
| return abbreviation; | ||
| } | ||
| if (retryReasonAbbreviationCreator != null) { | ||
| return retryReasonAbbreviationCreator.getAbbreviation(ex, statusCode, | ||
| serverErrorMessage); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| private static List<RetryReason> retryReasonLSortedist; | ||
|
|
||
| private synchronized static void sortRetryReason() { | ||
| if (retryReasonLSortedist != null) { | ||
| return; | ||
| } | ||
| List<RetryReason> list = new ArrayList<>(); | ||
| for (RetryReason reason : values()) { | ||
| list.add(reason); | ||
| } | ||
| list.sort((c1, c2) -> { | ||
| return c1.rank - c2.rank; | ||
| }); | ||
| retryReasonLSortedist = list; | ||
| } | ||
|
|
||
| static RetryReason getEnum(Exception ex, Integer statusCode) { | ||
| RetryReason retryReasonResult = null; | ||
| if (retryReasonLSortedist == null) { | ||
| sortRetryReason(); | ||
| } | ||
| for (RetryReason retryReason : retryReasonLSortedist) { | ||
| if (retryReason.mechanism != null) { | ||
| if (retryReason.mechanism.canCapture(ex, statusCode)) { | ||
| retryReasonResult = retryReason; | ||
| } | ||
| } | ||
| } | ||
| return retryReasonResult; | ||
| } | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| package org.apache.hadoop.fs.azurebfs.services; | ||
|
|
||
| public interface RetryReasonAbbreviationCreator { | ||
| String getAbbreviation(Exception ex, Integer statusCode, String serverErrorMessage); | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| package org.apache.hadoop.fs.azurebfs.services; | ||
|
|
||
| interface RetryReasonCaptureMechanism { | ||
| boolean canCapture(Exception exceptionCaptured, Integer statusCode); | ||
| } |
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add a javadoc to explain. no need to set as null as that is the default and it actually speeds up object creation to not set it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Made the change.