-
Notifications
You must be signed in to change notification settings - Fork 461
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Make Graceful Shutdown Run On Its Own Thread (#191)
* Initial start of fix for requested shutdown * Execute the requested shutdown in a separate thread. Fix for Issue #167 * Reworked some of the shutdown logic to make the relationships clearer. * Added/Updated Copyright Statements * Add Missing License Statements
- Loading branch information
Showing
26 changed files
with
1,317 additions
and
696 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
14 changes: 14 additions & 0 deletions
14
...om/amazonaws/services/kinesis/clientlibrary/interfaces/v2/IShutdownNotificationAware.java
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
14 changes: 14 additions & 0 deletions
14
src/main/java/com/amazonaws/services/kinesis/clientlibrary/lib/worker/ConsumerStates.java
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
33 changes: 33 additions & 0 deletions
33
...java/com/amazonaws/services/kinesis/clientlibrary/lib/worker/GracefulShutdownContext.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| /* | ||
| * Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * | ||
| * Licensed under the Amazon Software License (the "License"). | ||
| * You may not use this file except in compliance with the License. | ||
| * A copy of the License is located at | ||
| * | ||
| * http://aws.amazon.com/asl/ | ||
| * | ||
| * or in the "license" file accompanying this file. This file 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 com.amazonaws.services.kinesis.clientlibrary.lib.worker; | ||
|
|
||
| import lombok.Data; | ||
|
|
||
| import java.util.concurrent.CountDownLatch; | ||
|
|
||
| @Data | ||
| class GracefulShutdownContext { | ||
| private final CountDownLatch shutdownCompleteLatch; | ||
| private final CountDownLatch notificationCompleteLatch; | ||
| private final Worker worker; | ||
|
|
||
| static GracefulShutdownContext SHUTDOWN_ALREADY_COMPLETED = new GracefulShutdownContext(null, null, null); | ||
|
|
||
| boolean isShutdownAlreadyCompleted() { | ||
| return shutdownCompleteLatch == null && notificationCompleteLatch == null && worker == null; | ||
| } | ||
|
|
||
| } |
163 changes: 163 additions & 0 deletions
163
.../com/amazonaws/services/kinesis/clientlibrary/lib/worker/GracefulShutdownCoordinator.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| /* | ||
| * Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * | ||
| * Licensed under the Amazon Software License (the "License"). | ||
| * You may not use this file except in compliance with the License. | ||
| * A copy of the License is located at | ||
| * | ||
| * http://aws.amazon.com/asl/ | ||
| * | ||
| * or in the "license" file accompanying this file. This file 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 com.amazonaws.services.kinesis.clientlibrary.lib.worker; | ||
|
|
||
| import java.util.concurrent.Callable; | ||
| import java.util.concurrent.Future; | ||
| import java.util.concurrent.FutureTask; | ||
| import java.util.concurrent.TimeUnit; | ||
|
|
||
| import org.apache.commons.logging.Log; | ||
| import org.apache.commons.logging.LogFactory; | ||
|
|
||
| class GracefulShutdownCoordinator { | ||
|
|
||
| Future<Boolean> startGracefulShutdown(Callable<Boolean> shutdownCallable) { | ||
| FutureTask<Boolean> task = new FutureTask<>(shutdownCallable); | ||
| Thread shutdownThread = new Thread(task, "RequestedShutdownThread"); | ||
| shutdownThread.start(); | ||
| return task; | ||
|
|
||
| } | ||
|
|
||
| Callable<Boolean> createGracefulShutdownCallable(Callable<GracefulShutdownContext> startWorkerShutdown) { | ||
| return new GracefulShutdownCallable(startWorkerShutdown); | ||
| } | ||
|
|
||
| static class GracefulShutdownCallable implements Callable<Boolean> { | ||
|
|
||
| private static final Log log = LogFactory.getLog(GracefulShutdownCallable.class); | ||
|
|
||
| private final Callable<GracefulShutdownContext> startWorkerShutdown; | ||
|
|
||
| GracefulShutdownCallable(Callable<GracefulShutdownContext> startWorkerShutdown) { | ||
| this.startWorkerShutdown = startWorkerShutdown; | ||
| } | ||
|
|
||
| private boolean isWorkerShutdownComplete(GracefulShutdownContext context) { | ||
| return context.getWorker().isShutdownComplete() || context.getWorker().getShardInfoShardConsumerMap().isEmpty(); | ||
| } | ||
|
|
||
| private String awaitingLogMessage(GracefulShutdownContext context) { | ||
| long awaitingNotification = context.getNotificationCompleteLatch().getCount(); | ||
| long awaitingFinalShutdown = context.getShutdownCompleteLatch().getCount(); | ||
|
|
||
| return String.format( | ||
| "Waiting for %d record process to complete shutdown notification, and %d record processor to complete final shutdown ", | ||
| awaitingNotification, awaitingFinalShutdown); | ||
| } | ||
|
|
||
| private String awaitingFinalShutdownMessage(GracefulShutdownContext context) { | ||
| long outstanding = context.getShutdownCompleteLatch().getCount(); | ||
| return String.format("Waiting for %d record processors to complete final shutdown", outstanding); | ||
| } | ||
|
|
||
| private boolean waitForRecordProcessors(GracefulShutdownContext context) { | ||
|
|
||
| // | ||
| // Awaiting for all ShardConsumer/RecordProcessors to be notified that a shutdown has been requested. | ||
| // There is the possibility of a race condition where a lease is terminated after the shutdown request | ||
| // notification is started, but before the ShardConsumer is sent the notification. In this case the | ||
| // ShardConsumer would start the lease loss shutdown, and may never call the notification methods. | ||
| // | ||
| try { | ||
| while (!context.getNotificationCompleteLatch().await(1, TimeUnit.SECONDS)) { | ||
| if (Thread.interrupted()) { | ||
| throw new InterruptedException(); | ||
| } | ||
| log.info(awaitingLogMessage(context)); | ||
| if (workerShutdownWithRemaining(context.getShutdownCompleteLatch().getCount(), context)) { | ||
| return false; | ||
| } | ||
| } | ||
| } catch (InterruptedException ie) { | ||
| log.warn("Interrupted while waiting for notification complete, terminating shutdown. " | ||
| + awaitingLogMessage(context)); | ||
| return false; | ||
| } | ||
|
|
||
| if (Thread.interrupted()) { | ||
| log.warn("Interrupted before worker shutdown, terminating shutdown"); | ||
| return false; | ||
| } | ||
|
|
||
| // | ||
| // Once all record processors have been notified of the shutdown it is safe to allow the worker to | ||
| // start its shutdown behavior. Once shutdown starts it will stop renewer, and drop any remaining leases. | ||
| // | ||
| context.getWorker().shutdown(); | ||
|
|
||
| if (Thread.interrupted()) { | ||
| log.warn("Interrupted after worker shutdown, terminating shutdown"); | ||
| return false; | ||
| } | ||
|
|
||
| // | ||
| // Want to wait for all the remaining ShardConsumers/RecordProcessor's to complete their final shutdown | ||
| // processing. This should really be a no-op since as part of the notification completion the lease for | ||
| // ShardConsumer is terminated. | ||
| // | ||
| try { | ||
| while (!context.getShutdownCompleteLatch().await(1, TimeUnit.SECONDS)) { | ||
| if (Thread.interrupted()) { | ||
| throw new InterruptedException(); | ||
| } | ||
| log.info(awaitingFinalShutdownMessage(context)); | ||
| if (workerShutdownWithRemaining(context.getShutdownCompleteLatch().getCount(), context)) { | ||
| return false; | ||
| } | ||
| } | ||
| } catch (InterruptedException ie) { | ||
| log.warn("Interrupted while waiting for shutdown completion, terminating shutdown. " | ||
| + awaitingFinalShutdownMessage(context)); | ||
| return false; | ||
| } | ||
| return true; | ||
| } | ||
|
|
||
| /** | ||
| * This checks to see if the worker has already hit it's shutdown target, while there is outstanding record | ||
| * processors. This maybe a little racy due to when the value of outstanding is retrieved. In general though the | ||
| * latch should be decremented before the shutdown completion. | ||
| * | ||
| * @param outstanding | ||
| * the number of record processor still awaiting shutdown. | ||
| */ | ||
| private boolean workerShutdownWithRemaining(long outstanding, GracefulShutdownContext context) { | ||
| if (isWorkerShutdownComplete(context)) { | ||
| if (outstanding != 0) { | ||
| log.info("Shutdown completed, but shutdownCompleteLatch still had outstanding " + outstanding | ||
| + " with a current value of " + context.getShutdownCompleteLatch().getCount() + ". shutdownComplete: " | ||
| + context.getWorker().isShutdownComplete() + " -- Consumer Map: " | ||
| + context.getWorker().getShardInfoShardConsumerMap().size()); | ||
| return true; | ||
| } | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| @Override | ||
| public Boolean call() throws Exception { | ||
| GracefulShutdownContext context; | ||
| try { | ||
| context = startWorkerShutdown.call(); | ||
| } catch (Exception ex) { | ||
| log.warn("Caught exception while requesting initial worker shutdown.", ex); | ||
| throw ex; | ||
| } | ||
| return context.isShutdownAlreadyCompleted() || waitForRecordProcessors(context); | ||
| } | ||
| } | ||
| } |
14 changes: 14 additions & 0 deletions
14
...java/com/amazonaws/services/kinesis/clientlibrary/lib/worker/NoOpShardPrioritization.java
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
14 changes: 14 additions & 0 deletions
14
.../amazonaws/services/kinesis/clientlibrary/lib/worker/ParentsFirstShardPrioritization.java
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
14 changes: 14 additions & 0 deletions
14
...mazonaws/services/kinesis/clientlibrary/lib/worker/ShardConsumerShutdownNotification.java
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
14 changes: 14 additions & 0 deletions
14
...ain/java/com/amazonaws/services/kinesis/clientlibrary/lib/worker/ShardPrioritization.java
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
Oops, something went wrong.