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
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,176 @@ | ||
| /** | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * <p> | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * <p> | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.apache.hadoop.fs.azurebfs.services; | ||
|
|
||
| import java.io.IOException; | ||
| import java.net.SocketException; | ||
| import java.net.UnknownHostException; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| import static java.net.HttpURLConnection.HTTP_UNAVAILABLE; | ||
| import static org.apache.hadoop.fs.azurebfs.constants.AbfsHttpConstants.HTTP_STATUS_CATEGORY_QUOTIENT; | ||
|
|
||
| /** | ||
| * In case of retry, this enum would give the information on the reason for | ||
| * previous API call. | ||
| * */ | ||
|
||
| public enum RetryReason { | ||
steveloughran marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| CONNECTION_TIMEOUT(2, ((ex, statusCode, serverErrorMessage) -> { | ||
| if (ex != null && "connect timed out".equalsIgnoreCase( | ||
| ex.getMessage())) { | ||
| return "CT"; | ||
| } | ||
| return null; | ||
| })), | ||
| READ_TIMEOUT(2, ((exceptionCaptured, statusCode, serverErrorMessage) -> { | ||
steveloughran marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| if (exceptionCaptured != null && "Read timed out".equalsIgnoreCase( | ||
| exceptionCaptured.getMessage())) { | ||
| return "RT"; | ||
| } | ||
| return null; | ||
| })), | ||
| UNKNOWN_HOST(2, ((ex, statusCode, serverErrorMessage) -> { | ||
| if (ex instanceof UnknownHostException) { | ||
| return "UH"; | ||
| } | ||
| return null; | ||
| })), | ||
| CONNECTION_RESET(2, ((exceptionCaptured, statusCode, serverErrorMessage) -> { | ||
| if (exceptionCaptured != null && exceptionCaptured.getMessage() != null | ||
| && exceptionCaptured.getMessage().contains("Connection reset")) { | ||
|
||
| return "CR"; | ||
| } | ||
| return null; | ||
| })), | ||
| STATUS_5XX(0, ((ex, statusCode, serverErrorMessage) -> { | ||
| if (statusCode == null || statusCode / HTTP_STATUS_CATEGORY_QUOTIENT != 5) { | ||
| return null; | ||
| } | ||
| if (statusCode == HTTP_UNAVAILABLE) { | ||
| //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 HTTP_UNAVAILABLE + ""; | ||
| } | ||
| return statusCode + ""; | ||
| })), | ||
| STATUS_4XX(0, ((ex, statusCode, serverErrorMessage) -> { | ||
| if (statusCode == null || statusCode / HTTP_STATUS_CATEGORY_QUOTIENT != 4) { | ||
| return null; | ||
| } | ||
| return statusCode + ""; | ||
| })), | ||
| UNKNOWN_SOCKET_EXCEPTION(1, ((ex, statusCode, serverErrorMessage) -> { | ||
| if (ex instanceof SocketException) { | ||
| return "SE"; | ||
| } | ||
| return null; | ||
| })), | ||
| UNKNOWN_IO_EXCEPTION(0, ((ex, statusCode, serverErrorMessage) -> { | ||
| if (ex instanceof IOException) { | ||
| return "IOE"; | ||
| } | ||
| return null; | ||
| })); | ||
|
|
||
| private RetryReasonAbbreviationCreator retryReasonAbbreviationCreator = null; | ||
|
|
||
| private int rank = 0; | ||
|
|
||
| /** | ||
| * Constructor to have rank and the implementation of {@link RetryReasonAbbreviationCreator}. | ||
| * @param rank rank of a given enum. For example SocketTimeoutException is | ||
| * subclass of IOException. Rank of SocketTimeoutException enum has to be | ||
| * more than that of IOException enum. | ||
| * @param abbreviationCreator The implementation of {@link RetryReasonAbbreviationCreator} | ||
| * which would give the information if a given enum can be mapped to an error or not. | ||
| * */ | ||
| RetryReason(int rank, | ||
| RetryReasonAbbreviationCreator abbreviationCreator) { | ||
| this.rank = rank; | ||
| this.retryReasonAbbreviationCreator = abbreviationCreator; | ||
| } | ||
|
|
||
| private static List<RetryReason> retryReasonSortedList; | ||
|
|
||
| /** | ||
| * Synchronized method to assign sorted list in {@link RetryReason#retryReasonSortedList}. | ||
| * Method would check if list is assigned or not. If yes, method would return. This is required | ||
| * because multiple threads could be waiting to get into this method, and once a thread is done | ||
| * with this method, other thread would get into this method. Since the list would be assigned by | ||
| * first thread, the second thread need not run the whole mechanism of sorting. | ||
| * The enums are sorted on the ascending order of their rank. | ||
| * */ | ||
| private static synchronized void sortRetryReason() { | ||
| if (retryReasonSortedList != null) { | ||
| return; | ||
| } | ||
| List<RetryReason> list = new ArrayList<>(); | ||
| for (RetryReason reason : values()) { | ||
| list.add(reason); | ||
| } | ||
| list.sort((c1, c2) -> { | ||
| return c1.rank - c2.rank; | ||
| }); | ||
| retryReasonSortedList = list; | ||
| } | ||
|
|
||
| /** | ||
| * Method to get correct abbreviation for a given set of exception, statusCode, | ||
| * storageStatusCode. | ||
| * Method would iterate through the {@link RetryReason#retryReasonSortedList}, | ||
| * and would return the abbreviation returned by highest enum to be applicable on the group. | ||
| * For example, if SocketTimeoutException(rank 2) and IOException(rank 0) can be | ||
| * applied on the group, the abbreviation of SocketTimeoutException has to be returned. | ||
| * | ||
| * @param ex exception caught during server communication. | ||
| * @param statusCode statusCode in the server response. | ||
| * @param storageErrorMessage storageErrorMessage in the server response. | ||
| * */ | ||
| static String getAbbreviation(Exception ex, | ||
| Integer statusCode, | ||
| String storageErrorMessage) { | ||
| String result = null; | ||
| if (retryReasonSortedList == null) { | ||
| sortRetryReason(); | ||
| } | ||
| for (RetryReason retryReason : retryReasonSortedList) { | ||
| String enumCapturedAndAbbreviate | ||
| = retryReason.retryReasonAbbreviationCreator.capturableAndGetAbbreviation( | ||
| ex, statusCode, storageErrorMessage); | ||
| if (enumCapturedAndAbbreviate != null) { | ||
| result = enumCapturedAndAbbreviate; | ||
| } | ||
| } | ||
| return result; | ||
| } | ||
| } | ||
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,40 @@ | ||
| /** | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * <p> | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * <p> | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.apache.hadoop.fs.azurebfs.services; | ||
|
|
||
| /** | ||
| * Interface to be implemented by each enum in {@link RetryReason}. The methods | ||
| * of the interface define if the given enum can be applied on the given server | ||
| * response. | ||
| * */ | ||
| public interface RetryReasonAbbreviationCreator { | ||
|
|
||
| /** | ||
| * Returns an abbreviation if the {@link RetryReason} enum can be applied on | ||
| * the server response. | ||
| * @param ex exception captured in the server API call. | ||
| * @param statusCode statusCode on the server response | ||
| * @param serverErrorMessage serverErrorMessage on the server response. | ||
| * @return <ol><li>null if the enum can not be used on the server response</li> | ||
| * <li>abbreviation corresponding to the server response.</li></ol> | ||
| * */ | ||
| String capturableAndGetAbbreviation(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
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.
Uh oh!
There was an error while loading. Please reload this page.