org.apache.twill.internal

Class AbstractTwillController

java.lang.Object

org.apache.twill.internal.AbstractExecutionServiceController

org.apache.twill.internal.AbstractZKServiceController

org.apache.twill.internal.AbstractTwillController

All Implemented Interfaces:

com.google.common.util.concurrent.Service, ServiceController, TwillController

public abstract class AbstractTwillController
extends AbstractZKServiceController
implements TwillController

A abstract base class for TwillController implementation that uses Zookeeper to controller a running twill application.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.twill.api.ServiceController

ServiceController.TerminationStatus

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Field Summary

Fields inherited from class org.apache.twill.internal.AbstractZKServiceController

zkClient

Constructor Summary

Constructors

Constructor and Description
AbstractTwillController(String appName, RunId runId, ZKClient zkClient, boolean logCollectionEnabled, Iterable<LogHandler> logHandlers)

Method Summary

Modifier and Type	Method and Description
void	addLogHandler(LogHandler handler) Adds a LogHandler for receiving application log.
com.google.common.util.concurrent.ListenableFuture<Integer>	changeInstances(String runnable, int newCount) Changes the number of running instances of a given runnable.
ServiceDiscovered	discoverService(String serviceName) Discovers the set of Discoverable endpoints that provides service for the given service name.
protected void	doShutDown() Called during shutdown.
protected void	doStartUp() Called during startup.
protected void	resetLogHandler() Reset the log handler to poll from the beginning of Kafka.
Future<String[]>	resetLogLevels(String... loggerNames) Reset the log levels of all runnables.
Future<String[]>	resetRunnableLogLevels(String runnableName, String... loggerNames) Reset the log levels of the given runnable.
com.google.common.util.concurrent.ListenableFuture<String>	restartAllInstances(String runnableName) Restart all instances of a particular TwillRunnable.
com.google.common.util.concurrent.ListenableFuture<Set<String>>	restartInstances(Map<String,? extends Set<Integer>> runnableToInstanceIds) Restart instances of some TwillRunnable.
com.google.common.util.concurrent.ListenableFuture<String>	restartInstances(String runnable, int instanceId, int... moreInstanceIds) Restart instances of some TwillRunnable.
com.google.common.util.concurrent.ListenableFuture<String>	restartInstances(String runnable, Set<Integer> instanceIds) Restart instances of some TwillRunnable.
Future<Map<String,LogEntry.Level>>	updateLogLevels(Map<String,LogEntry.Level> logLevels) Update the log levels for requested logger names for Twill applications running in a container.
Future<Map<String,LogEntry.Level>>	updateLogLevels(String runnableName, Map<String,LogEntry.Level> runnableLogLevels) Update the log levels for requested logger names for a TwillRunnable.

Methods inherited from class org.apache.twill.internal.AbstractZKServiceController

forceShutDown, getInstancePath, getStopMessageFuture, instanceNodeFailed, instanceNodeUpdated, sendCommand, sendCommand, sendMessage, shutDown, startUp, watchInstanceNode

Methods inherited from class org.apache.twill.internal.AbstractExecutionServiceController

addListener, awaitTerminated, awaitTerminated, executor, getRunId, getTerminationStatus, isRunning, onRunning, onTerminated, setTerminationStatus, start, startAndWait, state, stop, stopAndWait, terminate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.twill.api.TwillController

getResourceReport

Methods inherited from interface org.apache.twill.api.ServiceController

awaitTerminated, awaitTerminated, getRunId, getTerminationStatus, kill, onRunning, onTerminated, sendCommand, sendCommand, terminate

Methods inherited from interface com.google.common.util.concurrent.Service

awaitRunning, awaitRunning, failureCause, startAsync, stopAsync

Constructor Detail

AbstractTwillController

public AbstractTwillController(String appName,
                               RunId runId,
                               ZKClient zkClient,
                               boolean logCollectionEnabled,
                               Iterable<LogHandler> logHandlers)

Method Detail

doStartUp

protected void doStartUp()

Description copied from class: AbstractZKServiceController

Called during startup. Executed in the startup thread.

Specified by:

doStartUp in class AbstractZKServiceController

doShutDown

protected void doShutDown()

Description copied from class: AbstractZKServiceController

Called during shutdown. Executed in the shutdown thread.

Specified by:

doShutDown in class AbstractZKServiceController

addLogHandler

public final void addLogHandler(LogHandler handler)

Description copied from interface: TwillController

Adds a LogHandler for receiving application log.

Specified by:

addLogHandler in interface TwillController

Parameters:

handler - The handler to add.

discoverService

public final ServiceDiscovered discoverService(String serviceName)

Description copied from interface: TwillController

Discovers the set of Discoverable endpoints that provides service for the given service name.

Specified by:

discoverService in interface TwillController

Parameters:

serviceName - Name of the service to discovery.

Returns:

A ServiceDiscovered object representing the result.

changeInstances

public final com.google.common.util.concurrent.ListenableFuture<Integer> changeInstances(String runnable,
                                                                                         int newCount)

Description copied from interface: TwillController

Changes the number of running instances of a given runnable.

Specified by:

changeInstances in interface TwillController

Parameters:

runnable - The name of the runnable.

newCount - Number of instances for the given runnable.

Returns:

A Future that will be completed when the number running instances has been successfully changed. The future will carry the new count as the result. If there is any error while changing instances, it'll be reflected in the future.

restartAllInstances

public final com.google.common.util.concurrent.ListenableFuture<String> restartAllInstances(String runnableName)

Description copied from interface: TwillController

Restart all instances of a particular TwillRunnable.

Specified by:

restartAllInstances in interface TwillController

Parameters:

runnableName - The name of the runnable to restart.

Returns:

A Future that will be completed when the restart operation has been done.

restartInstances

public final com.google.common.util.concurrent.ListenableFuture<Set<String>> restartInstances(Map<String,? extends Set<Integer>> runnableToInstanceIds)

Description copied from interface: TwillController

Restart instances of some TwillRunnable.

Specified by:

restartInstances in interface TwillController

Parameters:

runnableToInstanceIds - A map of runnable ID to list of instance IDs to be restarted.

Returns:

A Future that will be completed when the restart operation has been done.

restartInstances

public com.google.common.util.concurrent.ListenableFuture<String> restartInstances(String runnable,
                                                                                   int instanceId,
                                                                                   int... moreInstanceIds)

Description copied from interface: TwillController

Restart instances of some TwillRunnable.

Specified by:

restartInstances in interface TwillController

Parameters:

runnable - The name of the runnable to restart.

instanceId - The main instance id to be restarted.

moreInstanceIds - The optional instance ids.

Returns:

A Future that will be completed when the restart operation has been done.

restartInstances

public com.google.common.util.concurrent.ListenableFuture<String> restartInstances(String runnable,
                                                                                   Set<Integer> instanceIds)

Description copied from interface: TwillController

Restart instances of some TwillRunnable.

Specified by:

restartInstances in interface TwillController

Parameters:

runnable - The name of the runnable to restart.

instanceIds - Instances to be restarted

Returns:

A Future that will be completed when the restart operation has been done.

updateLogLevels

public Future<Map<String,LogEntry.Level>> updateLogLevels(Map<String,LogEntry.Level> logLevels)

Description copied from interface: TwillController

Update the log levels for requested logger names for Twill applications running in a container. The log level for a logger name can be null except for the root logger, which will reset the log level for the specified logger.

Specified by:

updateLogLevels in interface TwillController

Parameters:

logLevels - The Map contains the requested logger names and log levels that need to be updated.

Returns:

A Future that will be completed when the log level update has been done. It will carry the Map of log levels as the result.

updateLogLevels

public Future<Map<String,LogEntry.Level>> updateLogLevels(String runnableName,
                                                          Map<String,LogEntry.Level> runnableLogLevels)

Description copied from interface: TwillController

Update the log levels for requested logger names for a TwillRunnable. The log level for a logger name can be null except for the root logger, which will reset the log level for the specified logger.

Specified by:

updateLogLevels in interface TwillController

Parameters:

runnableName - The name of the runnable to update the log level.

runnableLogLevels - The Map contains the requested logger name and log level that need to be updated.

Returns:

A Future that will be completed when the log level update has been done. It will carry the Map of log levels as the result.

resetLogLevels

public Future<String[]> resetLogLevels(String... loggerNames)

Description copied from interface: TwillController

Reset the log levels of all runnables. The log levels will be the same as when the runnables start up.

Specified by:

resetLogLevels in interface TwillController

Parameters:

loggerNames - The optional logger names to be reset for all runnables, if not provided, all log levels will be reset.

Returns:

A Future that will be completed when the set log level operation has been done. The future result is the logger names provided in the parameter.

resetRunnableLogLevels

public Future<String[]> resetRunnableLogLevels(String runnableName,
                                               String... loggerNames)

Description copied from interface: TwillController

Reset the log levels of the given runnable. The log levels will be same as when the runnable starts up.

Specified by:

resetRunnableLogLevels in interface TwillController

loggerNames - The optional logger names to be reset for the runnable, if not provided, all log levels will be reset.

Returns:

A Future that will be completed when the set log level operation has been done. The future result is the logger names provided in the parameter.

resetLogHandler

protected final void resetLogHandler()

Reset the log handler to poll from the beginning of Kafka.