[FLINK-39730][runtime] Honor maxExceptions on ApplicationExceptionsHandler #28226
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
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
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 |
|---|---|---|
|
|
@@ -27,9 +27,10 @@ | |
| import org.apache.flink.runtime.rest.handler.HandlerRequestException; | ||
| import org.apache.flink.runtime.rest.messages.ApplicationExceptionsInfoWithHistory; | ||
| import org.apache.flink.runtime.rest.messages.ApplicationIDPathParameter; | ||
| import org.apache.flink.runtime.rest.messages.EmptyRequestBody; | ||
| import org.apache.flink.runtime.rest.messages.application.ApplicationExceptionsHeaders; | ||
| import org.apache.flink.runtime.rest.messages.application.ApplicationExceptionsMessageParameters; | ||
| import org.apache.flink.runtime.rest.messages.job.UpperLimitExceptionParameter; | ||
| import org.apache.flink.runtime.webmonitor.RestfulGateway; | ||
| import org.apache.flink.runtime.webmonitor.TestingRestfulGateway; | ||
| import org.apache.flink.runtime.webmonitor.retriever.GatewayRetriever; | ||
|
|
@@ -57,13 +58,28 @@ class ApplicationExceptionsHandlerTest { | |
|
|
||
| private static HandlerRequest<EmptyRequestBody> createRequest(ApplicationID applicationId) | ||
| throws HandlerRequestException { | ||
| return createRequest(applicationId, Collections.emptyMap()); | ||
| } | ||
|
|
||
| private static HandlerRequest<EmptyRequestBody> createRequest( | ||
| ApplicationID applicationId, int maxExceptions) throws HandlerRequestException { | ||
| Map<String, List<String>> queryParameters = new HashMap<>(); | ||
| queryParameters.put( | ||
| UpperLimitExceptionParameter.KEY, | ||
| Collections.singletonList(Integer.toString(maxExceptions))); | ||
| return createRequest(applicationId, queryParameters); | ||
| } | ||
|
|
||
| private static HandlerRequest<EmptyRequestBody> createRequest( | ||
| ApplicationID applicationId, Map<String, List<String>> queryParameters) | ||
| throws HandlerRequestException { | ||
| Map<String, String> pathParameters = new HashMap<>(); | ||
| pathParameters.put(ApplicationIDPathParameter.KEY, applicationId.toString()); | ||
| return HandlerRequest.resolveParametersAndCreate( | ||
| EmptyRequestBody.getInstance(), | ||
| new ApplicationExceptionsMessageParameters(), | ||
| pathParameters, | ||
| queryParameters, | ||
| Collections.emptyList()); | ||
| } | ||
|
|
||
|
|
@@ -143,6 +159,116 @@ void testExceptionWithJobId() throws Exception { | |
| assertThat(exceptionInfo.getJobId()).isEqualTo(jobId); | ||
| } | ||
|
|
||
| @Test | ||
| void testMaxExceptionsLimitsHistorySize() throws Exception { | ||
|
Contributor
There was a problem hiding this comment. Could u please clarify, whether there are tests for:
Author
There was a problem hiding this comment. Good catch, they were both missing as explicit cases. Added two tests in ApplicationExceptionsHandlerTest.java:
|
||
| final List<ApplicationExceptionHistoryEntry> exceptionHistory = new ArrayList<>(); | ||
| for (int i = 0; i < 5; i++) { | ||
| exceptionHistory.add( | ||
| new ApplicationExceptionHistoryEntry( | ||
| new RuntimeException("exception #" + i), | ||
| System.currentTimeMillis(), | ||
| null)); | ||
| } | ||
|
|
||
| final ArchivedApplication applicationWithExceptions = | ||
| new ArchivedApplication( | ||
| archivedApplication.getApplicationId(), | ||
| archivedApplication.getApplicationName(), | ||
| ApplicationState.FAILED, | ||
| new long[] {1L, 1L, 1L, 1L, 1L, 1L, 1L}, | ||
| Collections.emptyMap(), | ||
| exceptionHistory); | ||
|
|
||
| testingRestfulGateway = | ||
| new TestingRestfulGateway.Builder() | ||
| .setRequestApplicationFunction( | ||
| applicationId -> | ||
| CompletableFuture.completedFuture( | ||
| applicationWithExceptions)) | ||
| .build(); | ||
|
|
||
| final HandlerRequest<EmptyRequestBody> limitedRequest = | ||
| createRequest(archivedApplication.getApplicationId(), 2); | ||
|
|
||
| final ApplicationExceptionsInfoWithHistory response = | ||
| handler.handleRequest(limitedRequest, testingRestfulGateway).get(); | ||
|
|
||
| assertThat(response.getExceptionHistory().getEntries()).hasSize(2); | ||
|
Contributor
There was a problem hiding this comment. Shouldn't we also verify/assert the intended order? |
||
| } | ||
|
|
||
| @Test | ||
| void testDefaultCapAppliedWhenMaxExceptionsNotProvided() throws Exception { | ||
| final int totalExceptions = ApplicationExceptionsHandler.MAX_NUMBER_EXCEPTION_TO_REPORT + 5; | ||
| final List<ApplicationExceptionHistoryEntry> exceptionHistory = new ArrayList<>(); | ||
| for (int i = 0; i < totalExceptions; i++) { | ||
| exceptionHistory.add( | ||
| new ApplicationExceptionHistoryEntry( | ||
| new RuntimeException("exception #" + i), | ||
| System.currentTimeMillis(), | ||
| null)); | ||
| } | ||
|
|
||
| final ArchivedApplication applicationWithExceptions = | ||
| new ArchivedApplication( | ||
| archivedApplication.getApplicationId(), | ||
| archivedApplication.getApplicationName(), | ||
| ApplicationState.FAILED, | ||
| new long[] {1L, 1L, 1L, 1L, 1L, 1L, 1L}, | ||
| Collections.emptyMap(), | ||
| exceptionHistory); | ||
|
|
||
| testingRestfulGateway = | ||
| new TestingRestfulGateway.Builder() | ||
| .setRequestApplicationFunction( | ||
| applicationId -> | ||
| CompletableFuture.completedFuture( | ||
| applicationWithExceptions)) | ||
| .build(); | ||
|
|
||
| final ApplicationExceptionsInfoWithHistory response = | ||
| handler.handleRequest(handlerRequest, testingRestfulGateway).get(); | ||
|
|
||
| assertThat(response.getExceptionHistory().getEntries()) | ||
| .hasSize(ApplicationExceptionsHandler.MAX_NUMBER_EXCEPTION_TO_REPORT); | ||
| } | ||
|
|
||
| @Test | ||
| void testMaxExceptionsLargerThanHistorySizeReturnsAllEntries() throws Exception { | ||
| final List<ApplicationExceptionHistoryEntry> exceptionHistory = new ArrayList<>(); | ||
| for (int i = 0; i < 3; i++) { | ||
|
Contributor
There was a problem hiding this comment. nit: the loop iterates |
||
| exceptionHistory.add( | ||
| new ApplicationExceptionHistoryEntry( | ||
| new RuntimeException("exception #" + i), | ||
| System.currentTimeMillis(), | ||
| null)); | ||
| } | ||
|
|
||
| final ArchivedApplication applicationWithExceptions = | ||
| new ArchivedApplication( | ||
| archivedApplication.getApplicationId(), | ||
| archivedApplication.getApplicationName(), | ||
| ApplicationState.FAILED, | ||
| new long[] {1L, 1L, 1L, 1L, 1L, 1L, 1L}, | ||
| Collections.emptyMap(), | ||
| exceptionHistory); | ||
|
|
||
| testingRestfulGateway = | ||
| new TestingRestfulGateway.Builder() | ||
| .setRequestApplicationFunction( | ||
| applicationId -> | ||
| CompletableFuture.completedFuture( | ||
| applicationWithExceptions)) | ||
| .build(); | ||
|
|
||
| final HandlerRequest<EmptyRequestBody> oversizedRequest = | ||
| createRequest(archivedApplication.getApplicationId(), 10); | ||
|
|
||
| final ApplicationExceptionsInfoWithHistory response = | ||
| handler.handleRequest(oversizedRequest, testingRestfulGateway).get(); | ||
|
|
||
| assertThat(response.getExceptionHistory().getEntries()).hasSize(3); | ||
| } | ||
|
|
||
| @Test | ||
| void testExceptionWithoutJobId() throws Exception { | ||
| final RuntimeException rootCause = new RuntimeException("exception #0"); | ||
|
|
||
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.
just an observation, that in https://github.com/apache/flink/blob/master/flink-runtime/src/main/java/org/apache/flink/runtime/rest/handler/job/JobExceptionsHandler.java#L63 we also have same constant. maybe worth extracting if we revisit default in the future. however, it is just an observation (not a blocker).