Provide a way to terminate unfinished requests after graceful shutdown #5941
+732
−87
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
Motivation:
Unfinished requests even after graceful shutdown period are forcivily
closed with `ClosedSessionException`. As `ClosedSessionException`
indicates that the connection was unexpectedly disconnected,
`ClosedSessionException` is not suitable for graceful shutdown.
In this PR, I propose to add `ShuttingDownException` to terminate
unfinished requests when a server stops.
Modifications:
- Introduce `GracefulShutdown` to customize graceful shutdown behavior.
- Users can specify a error function to create an exception to
unfinished terminate requests.
- Fixed `HttpServerHandler` to send error responses using the error
function of `GracefulShutdown`
- Fixed `Server` to send error respones first and then close the
connnections.
- Deprecation) `ServerConfig.gracefulShutdownQuietPeriod()` and
`ServerConfig.gracefulShutdownTimeout()` have been deprecated in favor
of `ServerConfig.gracefulShutdown()`.
Result:
You can now use `GracefulShutdown` to terminate unfinished requests when
a server stops.
```java
GracefulShutdown gracefulShutdown =
GracefulShutdown
.builder()
.quietPeriod(Duration.ofSeconds(10))
.timeout(Duration.ofSeconds(15))
.shutdownErrorFunction((ctx, req) -> {
return new ServerStopException();
})
.build();
Server
.builder()
.gracefulShutdown(gracefulShutdown);
```
trustin
reviewed
Oct 23, 2024
Comment on lines
+47
to
+58
| /** | ||
| * Returns the quiet period to wait for active requests to go end before shutting down. | ||
| * {@link Duration#ZERO} means the server will stop right away without waiting. | ||
| */ | ||
| Duration quietPeriod(); | ||
|
|
||
| /** | ||
| * Returns the amount of time to wait before shutting down the server regardless of active requests. | ||
| * This should be set to a time greater than {@code quietPeriod} to ensure the server shuts down even | ||
| * if there is a stuck request. | ||
| */ | ||
| Duration timeout(); |
There was a problem hiding this comment.
Should we make this even more flexible rather than just letting a user configure the quiet period and timeout? For example:
interface GracefulShutdown {
...
// Armeria core passes its GracefulShutdownHandler to this method.
void startGracefulShutdown(GracefulShutdownHandler handler);
}
// A GracefulShutdown implementation calls back Armeria core via this handler.
interface GracefulShutdownHandler {
void gracefulShutdownStarted(...);
void quietPeriodComplete(...);
void gracefulShutdownComplete(...);
@Nullable
Throwable toException(ctx, req);
}
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.
Motivation:
Unfinished requests even after graceful shutdown period are forcibly closed with
ClosedSessionException. AsClosedSessionExceptionindicates that the connection was unexpectedly disconnected,ClosedSessionExceptionis not suitable for graceful shutdown.In this PR, I propose to add
ShuttingDownExceptionto terminate unfinished requests when a server stops.Modifications:
GracefulShutdownto customize graceful shutdown behavior.HttpServerHandlerto send error responses using the error function ofGracefulShutdownServerto send error respones first and then close the connnections.ServerConfig.gracefulShutdownQuietPeriod()andServerConfig.gracefulShutdownTimeout()have been deprecated in favor ofServerConfig.gracefulShutdown().Result:
You can now use
GracefulShutdownto terminate unfinished requests when a server stops.