samza-core/src/main/java/org/apache/samza/util/ShutdownUtil.java

/*
 * 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
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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.samza.util;

import java.util.List;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.google.common.util.concurrent.ThreadFactoryBuilder;


/**
 * Shutdown related utils
 */
public class ShutdownUtil {
  private static final Logger LOG = LoggerFactory.getLogger(ShutdownUtil.class);

  /**
   * A helper to facilitate shutting down a set of resources in parallel to enforce a bounded shutdown time.
   * The helper function instantiates an {@link ExecutorService} to execute a list of shutdown tasks, and will
   * await the termination for given timeout. If shutdown remains unfinished in the end, the whole thread dump
   * will be printed to help debugging.
   *
   * The shutdown is performed with best-effort. Depending on the implementation of the shutdown function, resource
   * leak might be possible.
   *
   * @param shutdownTasks the list of shutdown tasks that need to be executed in parallel
   * @param message message that will show in the thread name and the thread dump
   * @param timeoutMs timeout in ms
   * @return true if all tasks terminate in the end
   */
  public static boolean boundedShutdown(List<Runnable> shutdownTasks, String message, long timeoutMs) {
    ExecutorService shutdownExecutorService = Executors.newCachedThreadPool(
        new ThreadFactoryBuilder().setNameFormat(message + "-%d").setDaemon(true).build());
    shutdownTasks.forEach(shutdownExecutorService::submit);
    shutdownExecutorService.shutdown();
    try {
      shutdownExecutorService.awaitTermination(timeoutMs, TimeUnit.MILLISECONDS);
    } catch (InterruptedException e) {
      LOG.error("Shutdown was interrupted for " + message, e);
    }

    if (shutdownExecutorService.isTerminated()) {
      LOG.info("Shutdown complete for {}", message);
      return true;
    } else {
      LOG.error("Shutdown function for {} remains unfinished after timeout ({} ms) or interruption", message, timeoutMs);
      ThreadUtil.logThreadDump(message);
      shutdownExecutorService.shutdownNow();
      return false;
    }
  }
}