backtype.storm
Class Config

java.lang.Object
  java.util.AbstractMap<K,V>
      java.util.HashMap<String,Object>
          backtype.storm.Config

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

public class Config
extends HashMap<String,Object>

Topology configs are specified as a plain old map. This class provides a convenient way to create a topology config map by providing setter methods for all the configs that can be set. It also makes it easier to do things like add serializations.

This class also provides constants for all the configurations possible on a Storm cluster and Storm topology. Each constant is paired with a schema that defines the validity criterion of the corresponding field. Default values for these configs can be found in defaults.yaml.

Note that you may put other configurations in any of the configs. Storm will ignore anything it doesn't recognize, but your topologies are free to make use of them by reading them in the prepare method of Bolts or the open method of Spouts.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

static String	DEV_ZOOKEEPER_PATH The path to use as the zookeeper dir when running a zookeeper server via "storm dev-zookeeper".
static Object	DEV_ZOOKEEPER_PATH_SCHEMA
static String	DRPC_CHILDOPTS Childopts for Storm DRPC Java process.
static Object	DRPC_CHILDOPTS_SCHEMA
static String	DRPC_INVOCATIONS_PORT This port on Storm DRPC is used by DRPC topologies to receive function invocations and send results back.
static Object	DRPC_INVOCATIONS_PORT_SCHEMA
static String	DRPC_PORT This port is used by Storm DRPC for receiving DPRC requests from clients.
static Object	DRPC_PORT_SCHEMA
static String	DRPC_QUEUE_SIZE DRPC thrift server queue size
static Object	DRPC_QUEUE_SIZE_SCHEMA
static String	DRPC_REQUEST_TIMEOUT_SECS The timeout on DRPC requests within the DRPC server.
static Object	DRPC_REQUEST_TIMEOUT_SECS_SCHEMA
static String	DRPC_SERVERS List of DRPC servers so that the DRPCSpout knows who to talk to.
static Object	DRPC_SERVERS_SCHEMA
static String	DRPC_WORKER_THREADS DRPC thrift server worker threads
static Object	DRPC_WORKER_THREADS_SCHEMA
static String	ISOLATION_SCHEDULER_MACHINES A map from topology name to the number of machines that should be dedicated for that topology.
static Object	ISOLATION_SCHEDULER_MACHINES_SCHEMA
static String	JAVA_LIBRARY_PATH This value is passed to spawned JVMs (e.g., Nimbus, Supervisor, and Workers) for the java.library.path value.
static Object	JAVA_LIBRARY_PATH_SCHEMA
static String	LOGVIEWER_APPENDER_NAME Appender name used by log viewer to determine log directory.
static Object	LOGVIEWER_APPENDER_NAME_SCHEMA
static String	LOGVIEWER_CHILDOPTS Childopts for log viewer java process.
static Object	LOGVIEWER_CHILDOPTS_SCHEMA
static String	LOGVIEWER_PORT HTTP UI port for log viewer
static Object	LOGVIEWER_PORT_SCHEMA
static String	NIMBUS_AUTHORIZER Class name for authorization plugin for Nimbus
static Object	NIMBUS_AUTHORIZER_SCHEMA
static String	NIMBUS_CHILDOPTS This parameter is used by the storm-deploy project to configure the jvm options for the nimbus daemon.
static Object	NIMBUS_CHILDOPTS_SCHEMA
static String	NIMBUS_CLEANUP_INBOX_FREQ_SECS How often nimbus should wake the cleanup thread to clean the inbox.
static Object	NIMBUS_CLEANUP_INBOX_FREQ_SECS_SCHEMA
static String	NIMBUS_FILE_COPY_EXPIRATION_SECS During upload/download with the master, how long an upload or download connection is idle before nimbus considers it dead and drops the connection.
static Object	NIMBUS_FILE_COPY_EXPIRATION_SECS_SCHEMA
static String	NIMBUS_HOST The host that the master server is running on.
static Object	NIMBUS_HOST_SCHEMA
static String	NIMBUS_INBOX_JAR_EXPIRATION_SECS The length of time a jar file lives in the inbox before being deleted by the cleanup thread.
static Object	NIMBUS_INBOX_JAR_EXPIRATION_SECS_SCHEMA
static String	NIMBUS_MONITOR_FREQ_SECS How often nimbus should wake up to check heartbeats and do reassignments.
static Object	NIMBUS_MONITOR_FREQ_SECS_SCHEMA
static String	NIMBUS_REASSIGN Whether or not nimbus should reassign tasks if it detects that a task goes down.
static Object	NIMBUS_REASSIGN_SCHEMA
static String	NIMBUS_SUPERVISOR_TIMEOUT_SECS How long before a supervisor can go without heartbeating before nimbus considers it dead and stops assigning new work to it.
static Object	NIMBUS_SUPERVISOR_TIMEOUT_SECS_SCHEMA
static String	NIMBUS_TASK_LAUNCH_SECS A special timeout used when a task is initially launched.
static Object	NIMBUS_TASK_LAUNCH_SECS_SCHEMA
static String	NIMBUS_TASK_TIMEOUT_SECS How long without heartbeating a task can go before nimbus will consider the task dead and reassign it to another location.
static Object	NIMBUS_TASK_TIMEOUT_SECS_SCHEMA
static String	NIMBUS_THRIFT_MAX_BUFFER_SIZE The maximum buffer size thrift should use when reading messages.
static Object	NIMBUS_THRIFT_MAX_BUFFER_SIZE_SCHEMA
static String	NIMBUS_THRIFT_PORT Which port the Thrift interface of Nimbus should run on.
static Object	NIMBUS_THRIFT_PORT_SCHEMA
static String	NIMBUS_TOPOLOGY_VALIDATOR A custom class that implements ITopologyValidator that is run whenever a topology is submitted.
static Object	NIMBUS_TOPOLOGY_VALIDATOR_SCHEMA
static String	STORM_CLUSTER_MODE The mode this Storm cluster is running in.
static Object	STORM_CLUSTER_MODE_SCHEMA
static String	STORM_ID The id assigned to a running topology.
static Object	STORM_ID_SCHEMA
static String	STORM_LOCAL_DIR A directory on the local filesystem used by Storm for any local filesystem usage it needs.
static Object	STORM_LOCAL_DIR_SCHEMA
static String	STORM_LOCAL_HOSTNAME The hostname the supervisors/workers should report to nimbus.
static Object	STORM_LOCAL_HOSTNAME_SCHEMA
static String	STORM_LOCAL_MODE_ZMQ Whether or not to use ZeroMQ for messaging in local mode.
static Object	STORM_LOCAL_MODE_ZMQ_SCHEMA
static String	STORM_MESSAGING_NETTY_BUFFER_SIZE Netty based messaging: The buffer size for send/recv buffer
static Object	STORM_MESSAGING_NETTY_BUFFER_SIZE_SCHEMA
static String	STORM_MESSAGING_NETTY_CLIENT_WORKER_THREADS Netty based messaging: The # of worker threads for the client.
static Object	STORM_MESSAGING_NETTY_CLIENT_WORKER_THREADS_SCHEMA
static String	STORM_MESSAGING_NETTY_MAX_RETRIES Netty based messaging: The max # of retries that a peer will perform when a remote is not accessible
static Object	STORM_MESSAGING_NETTY_MAX_RETRIES_SCHEMA
static String	STORM_MESSAGING_NETTY_MAX_SLEEP_MS Netty based messaging: The max # of milliseconds that a peer will wait.
static Object	STORM_MESSAGING_NETTY_MAX_SLEEP_MS_SCHEMA
static String	STORM_MESSAGING_NETTY_MIN_SLEEP_MS Netty based messaging: The min # of milliseconds that a peer will wait.
static Object	STORM_MESSAGING_NETTY_MIN_SLEEP_MS_SCHEMA
static String	STORM_MESSAGING_NETTY_SERVER_WORKER_THREADS Netty based messaging: The # of worker threads for the server.
static Object	STORM_MESSAGING_NETTY_SERVER_WORKER_THREADS_SCHEMA
static String	STORM_MESSAGING_TRANSPORT The transporter for communication among Storm tasks
static Object	STORM_MESSAGING_TRANSPORT_SCHEMA
static String	STORM_NETTY_FLUSH_CHECK_INTERVAL_MS We check with this interval that whether the Netty channel is writable and try to write pending messages
static Object	STORM_NETTY_FLUSH_CHECK_INTERVAL_MS_SCHEMA
static String	STORM_NETTY_MESSAGE_BATCH_SIZE If the Netty messaging layer is busy, the Netty client will try to batch message as more as possible up to the size of STORM_NETTY_MESSAGE_BATCH_SIZE bytes
static Object	STORM_NETTY_MESSAGE_BATCH_SIZE_SCHEMA
static String	STORM_SCHEDULER A global task scheduler used to assign topologies's tasks to supervisors' wokers.
static Object	STORM_SCHEDULER_SCHEMA
static String	STORM_THRIFT_TRANSPORT_PLUGIN The transport plug-in for Thrift client/server communication
static Object	STORM_THRIFT_TRANSPORT_PLUGIN_SCHEMA
static String	STORM_ZOOKEEPER_AUTH_PAYLOAD A string representing the payload for Zookeeper authentication.
static Object	STORM_ZOOKEEPER_AUTH_PAYLOAD_SCHEMA
static String	STORM_ZOOKEEPER_AUTH_SCHEME The Zookeeper authentication scheme to use, e.g.
static Object	STORM_ZOOKEEPER_AUTH_SCHEME_SCHEMA
static String	STORM_ZOOKEEPER_CONNECTION_TIMEOUT The connection timeout for clients to ZooKeeper.
static Object	STORM_ZOOKEEPER_CONNECTION_TIMEOUT_SCHEMA
static String	STORM_ZOOKEEPER_PORT The port Storm will use to connect to each of the ZooKeeper servers.
static Object	STORM_ZOOKEEPER_PORT_SCHEMA
static String	STORM_ZOOKEEPER_RETRY_INTERVAL The interval between retries of a Zookeeper operation.
static String	STORM_ZOOKEEPER_RETRY_INTERVAL_CEILING The ceiling of the interval between retries of a Zookeeper operation.
static Object	STORM_ZOOKEEPER_RETRY_INTERVAL_CEILING_SCHEMA
static Object	STORM_ZOOKEEPER_RETRY_INTERVAL_SCHEMA
static String	STORM_ZOOKEEPER_RETRY_TIMES The number of times to retry a Zookeeper operation.
static Object	STORM_ZOOKEEPER_RETRY_TIMES_SCHEMA
static String	STORM_ZOOKEEPER_ROOT The root location at which Storm stores data in ZooKeeper.
static Object	STORM_ZOOKEEPER_ROOT_SCHEMA
static String	STORM_ZOOKEEPER_SERVERS A list of hosts of ZooKeeper servers used to manage the cluster.
static Object	STORM_ZOOKEEPER_SERVERS_SCHEMA
static String	STORM_ZOOKEEPER_SESSION_TIMEOUT The session timeout for clients to ZooKeeper.
static Object	STORM_ZOOKEEPER_SESSION_TIMEOUT_SCHEMA
static String	SUPERVISOR_CHILDOPTS This parameter is used by the storm-deploy project to configure the jvm options for the supervisor daemon.
static Object	SUPERVISOR_CHILDOPTS_SCHEMA
static String	SUPERVISOR_ENABLE Whether or not the supervisor should launch workers assigned to it.
static Object	SUPERVISOR_ENABLE_SCHEMA
static String	SUPERVISOR_HEARTBEAT_FREQUENCY_SECS how often the supervisor sends a heartbeat to the master.
static Object	SUPERVISOR_HEARTBEAT_FREQUENCY_SECS_SCHEMA
static String	SUPERVISOR_MONITOR_FREQUENCY_SECS How often the supervisor checks the worker heartbeats to see if any of them need to be restarted.
static Object	SUPERVISOR_MONITOR_FREQUENCY_SECS_SCHEMA
static String	SUPERVISOR_SCHEDULER_META the metadata configed on the supervisor
static Object	SUPERVISOR_SCHEDULER_META_SCHEMA
static String	SUPERVISOR_SLOTS_PORTS A list of ports that can run workers on this supervisor.
static Object	SUPERVISOR_SLOTS_PORTS_SCHEMA
static String	SUPERVISOR_WORKER_START_TIMEOUT_SECS How long a worker can go without heartbeating during the initial launch before the supervisor tries to restart the worker process.
static Object	SUPERVISOR_WORKER_START_TIMEOUT_SECS_SCHEMA
static String	SUPERVISOR_WORKER_TIMEOUT_SECS How long a worker can go without heartbeating before the supervisor tries to restart the worker process.
static Object	SUPERVISOR_WORKER_TIMEOUT_SECS_SCHEMA
static String	TASK_HEARTBEAT_FREQUENCY_SECS How often a task should heartbeat its status to the master.
static Object	TASK_HEARTBEAT_FREQUENCY_SECS_SCHEMA
static String	TASK_REFRESH_POLL_SECS How often a task should sync its connections with other tasks (if a task is reassigned, the other tasks sending messages to it need to refresh their connections).
static Object	TASK_REFRESH_POLL_SECS_SCHEMA
static String	TOPOLOGY_ACKER_EXECUTORS How many executors to spawn for ackers.
static Object	TOPOLOGY_ACKER_EXECUTORS_SCHEMA
static String	TOPOLOGY_AUTO_TASK_HOOKS A list of task hooks that are automatically added to every spout and bolt in the topology.
static Object	TOPOLOGY_AUTO_TASK_HOOKS_SCHEMA
static String	TOPOLOGY_BUILTIN_METRICS_BUCKET_SIZE_SECS The time period that builtin metrics data in bucketed into.
static Object	TOPOLOGY_BUILTIN_METRICS_BUCKET_SIZE_SECS_SCHEMA
static String	TOPOLOGY_DEBUG When set to true, Storm will log every message that's emitted.
static Object	TOPOLOGY_DEBUG_SCHEMA
static String	TOPOLOGY_DISRUPTOR_WAIT_STRATEGY Configure the wait strategy used for internal queuing.
static Object	TOPOLOGY_DISRUPTOR_WAIT_STRATEGY_SCHEMA
static String	TOPOLOGY_ENABLE_MESSAGE_TIMEOUTS True if Storm should timeout messages or not.
static Object	TOPOLOGY_ENABLE_MESSAGE_TIMEOUTS_SCHEMA
static String	TOPOLOGY_ERROR_THROTTLE_INTERVAL_SECS The interval in seconds to use for determining whether to throttle error reported to Zookeeper.
static Object	TOPOLOGY_ERROR_THROTTLE_INTERVAL_SECS_SCHEMA
static String	TOPOLOGY_EXECUTOR_RECEIVE_BUFFER_SIZE The size of the Disruptor receive queue for each executor.
static Object	TOPOLOGY_EXECUTOR_RECEIVE_BUFFER_SIZE_SCHEMA
static String	TOPOLOGY_EXECUTOR_SEND_BUFFER_SIZE The size of the Disruptor send queue for each executor.
static Object	TOPOLOGY_EXECUTOR_SEND_BUFFER_SIZE_SCHEMA
static String	TOPOLOGY_FALL_BACK_ON_JAVA_SERIALIZATION Whether or not to use Java serialization in a topology.
static Object	TOPOLOGY_FALL_BACK_ON_JAVA_SERIALIZATION_SCHEMA
static String	TOPOLOGY_KRYO_DECORATORS A list of classes that customize storm's kryo instance during start-up.
static Object	TOPOLOGY_KRYO_DECORATORS_SCHEMA
static String	TOPOLOGY_KRYO_FACTORY Class that specifies how to create a Kryo instance for serialization.
static Object	TOPOLOGY_KRYO_FACTORY_SCHEMA
static String	TOPOLOGY_KRYO_REGISTER A list of serialization registrations for Kryo ( http://code.google.com/p/kryo/ ), the underlying serialization framework for Storm.
static Object	TOPOLOGY_KRYO_REGISTER_SCHEMA
static String	TOPOLOGY_MAX_ERROR_REPORT_PER_INTERVAL See doc for TOPOLOGY_ERROR_THROTTLE_INTERVAL_SECS
static Object	TOPOLOGY_MAX_ERROR_REPORT_PER_INTERVAL_SCHEMA
static String	TOPOLOGY_MAX_SPOUT_PENDING The maximum number of tuples that can be pending on a spout task at any given time.
static Object	TOPOLOGY_MAX_SPOUT_PENDING_SCHEMA
static String	TOPOLOGY_MAX_TASK_PARALLELISM The maximum parallelism allowed for a component in this topology.
static Object	TOPOLOGY_MAX_TASK_PARALLELISM_SCHEMA
static String	TOPOLOGY_MESSAGE_TIMEOUT_SECS The maximum amount of time given to the topology to fully process a message emitted by a spout.
static Object	TOPOLOGY_MESSAGE_TIMEOUT_SECS_SCHEMA
static String	TOPOLOGY_METRICS_CONSUMER_REGISTER
static Object	TOPOLOGY_METRICS_CONSUMER_REGISTER_SCHEMA
static String	TOPOLOGY_MULTILANG_SERIALIZER The serializer for communication between shell components and non-JVM processes
static Object	TOPOLOGY_MULTILANG_SERIALIZER_SCHEMA
static String	TOPOLOGY_NAME Name of the topology.
static Object	TOPOLOGY_NAME_SCHEMA
static String	TOPOLOGY_RECEIVER_BUFFER_SIZE The maximum number of messages to batch from the thread receiving off the network to the executor queues.
static Object	TOPOLOGY_RECEIVER_BUFFER_SIZE_SCHEMA
static String	TOPOLOGY_SHELLBOLT_MAX_PENDING Max pending tuples in one ShellBolt
static Object	TOPOLOGY_SHELLBOLT_MAX_PENDING_SCHEMA
static String	TOPOLOGY_SKIP_MISSING_KRYO_REGISTRATIONS Whether or not Storm should skip the loading of kryo registrations for which it does not know the class or have the serializer implementation.
static Object	TOPOLOGY_SKIP_MISSING_KRYO_REGISTRATIONS_SCHEMA
static String	TOPOLOGY_SLEEP_SPOUT_WAIT_STRATEGY_TIME_MS The amount of milliseconds the SleepEmptyEmitStrategy should sleep for.
static Object	TOPOLOGY_SLEEP_SPOUT_WAIT_STRATEGY_TIME_MS_SCHEMA
static String	TOPOLOGY_SPOUT_WAIT_STRATEGY A class that implements a strategy for what to do when a spout needs to wait.
static Object	TOPOLOGY_SPOUT_WAIT_STRATEGY_SCHEMA
static String	TOPOLOGY_STATE_SYNCHRONIZATION_TIMEOUT_SECS The maximum amount of time a component gives a source of state to synchronize before it requests synchronization again.
static Object	TOPOLOGY_STATE_SYNCHRONIZATION_TIMEOUT_SECS_SCHEMA
static String	TOPOLOGY_STATS_SAMPLE_RATE The percentage of tuples to sample to produce stats for a task.
static Object	TOPOLOGY_STATS_SAMPLE_RATE_SCHEMA
static String	TOPOLOGY_TASKS How many instances to create for a spout/bolt.
static Object	TOPOLOGY_TASKS_SCHEMA
static String	TOPOLOGY_TICK_TUPLE_FREQ_SECS How often a tick tuple from the "__system" component and "__tick" stream should be sent to tasks.
static Object	TOPOLOGY_TICK_TUPLE_FREQ_SECS_SCHEMA
static String	TOPOLOGY_TRANSACTIONAL_ID This config is available for TransactionalSpouts, and contains the id ( a String) for the transactional topology.
static Object	TOPOLOGY_TRANSACTIONAL_ID_SCHEMA
static String	TOPOLOGY_TRANSFER_BUFFER_SIZE The size of the Disruptor transfer queue for each worker.
static Object	TOPOLOGY_TRANSFER_BUFFER_SIZE_SCHEMA
static String	TOPOLOGY_TRIDENT_BATCH_EMIT_INTERVAL_MILLIS How often a batch can be emitted in a Trident topology.
static Object	TOPOLOGY_TRIDENT_BATCH_EMIT_INTERVAL_MILLIS_SCHEMA
static String	TOPOLOGY_TUPLE_SERIALIZER The serializer class for ListDelegate (tuple payload).
static Object	TOPOLOGY_TUPLE_SERIALIZER_SCHEMA
static String	TOPOLOGY_WORKER_CHILDOPTS Topology-specific options for the worker child process.
static Object	TOPOLOGY_WORKER_CHILDOPTS_SCHEMA
static String	TOPOLOGY_WORKER_SHARED_THREAD_POOL_SIZE The size of the shared thread pool for worker tasks to make use of.
static Object	TOPOLOGY_WORKER_SHARED_THREAD_POOL_SIZE_SCHEMA
static String	TOPOLOGY_WORKERS How many processes should be spawned around the cluster to execute this topology.
static Object	TOPOLOGY_WORKERS_SCHEMA
static String	TRANSACTIONAL_ZOOKEEPER_PORT The port to use to connect to the transactional zookeeper servers.
static Object	TRANSACTIONAL_ZOOKEEPER_PORT_SCHEMA
static String	TRANSACTIONAL_ZOOKEEPER_ROOT The root directory in ZooKeeper for metadata about TransactionalSpouts.
static Object	TRANSACTIONAL_ZOOKEEPER_ROOT_SCHEMA
static String	TRANSACTIONAL_ZOOKEEPER_SERVERS The list of zookeeper servers in which to keep the transactional state.
static Object	TRANSACTIONAL_ZOOKEEPER_SERVERS_SCHEMA
static String	UI_CHILDOPTS Childopts for Storm UI Java process.
static Object	UI_CHILDOPTS_SCHEMA
static String	UI_PORT Storm UI binds to this port.
static Object	UI_PORT_SCHEMA
static String	WORKER_CHILDOPTS The jvm opts provided to workers launched by this supervisor.
static Object	WORKER_CHILDOPTS_SCHEMA
static String	WORKER_HEARTBEAT_FREQUENCY_SECS How often this worker should heartbeat to the supervisor.
static Object	WORKER_HEARTBEAT_FREQUENCY_SECS_SCHEMA
static String	WORKER_RECEIVER_THREAD_COUNT control how many worker receiver threads we need per worker
static Object	WORKER_RECEIVER_THREAD_COUNT_SCHEMA
static String	ZMQ_HWM The high water for the ZeroMQ push sockets used for networking.
static Object	ZMQ_HWM_SCHEMA
static String	ZMQ_LINGER_MILLIS How long a connection should retry sending messages to a target host when the connection is closed.
static Object	ZMQ_LINGER_MILLIS_SCHEMA
static String	ZMQ_THREADS The number of threads that should be used by the zeromq context in each worker process.
static Object	ZMQ_THREADS_SCHEMA

Constructor Summary

Config()

Method Summary

void	registerDecorator(Class<? extends IKryoDecorator> klass)
static void	registerDecorator(Map conf, Class<? extends IKryoDecorator> klass)
void	registerMetricsConsumer(Class klass)
void	registerMetricsConsumer(Class klass, long parallelismHint)
void	registerMetricsConsumer(Class klass, Object argument, long parallelismHint)
void	registerSerialization(Class klass)
void	registerSerialization(Class klass, Class<? extends com.esotericsoftware.kryo.Serializer> serializerClass)
static void	registerSerialization(Map conf, Class klass)
static void	registerSerialization(Map conf, Class klass, Class<? extends com.esotericsoftware.kryo.Serializer> serializerClass)
void	setDebug(boolean isOn)
static void	setDebug(Map conf, boolean isOn)
void	setFallBackOnJavaSerialization(boolean fallback)
static void	setFallBackOnJavaSerialization(Map conf, boolean fallback)
void	setKryoFactory(Class<? extends IKryoFactory> klass)
static void	setKryoFactory(Map conf, Class<? extends IKryoFactory> klass)
void	setMaxSpoutPending(int max)
static void	setMaxSpoutPending(Map conf, int max)
void	setMaxTaskParallelism(int max)
static void	setMaxTaskParallelism(Map conf, int max)
void	setMessageTimeoutSecs(int secs)
static void	setMessageTimeoutSecs(Map conf, int secs)
void	setNumAckers(int numExecutors)
static void	setNumAckers(Map conf, int numExecutors)
void	setNumWorkers(int workers)
static void	setNumWorkers(Map conf, int workers)
void	setSkipMissingKryoRegistrations(boolean skip)
static void	setSkipMissingKryoRegistrations(Map conf, boolean skip)
void	setStatsSampleRate(double rate)
static void	setStatsSampleRate(Map conf, double rate)

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

STORM_MESSAGING_TRANSPORT

public static final String STORM_MESSAGING_TRANSPORT

The transporter for communication among Storm tasks

See Also:

Constant Field Values

STORM_MESSAGING_TRANSPORT_SCHEMA

public static final Object STORM_MESSAGING_TRANSPORT_SCHEMA

STORM_MESSAGING_NETTY_BUFFER_SIZE

public static final String STORM_MESSAGING_NETTY_BUFFER_SIZE

Netty based messaging: The buffer size for send/recv buffer

See Also:

Constant Field Values

STORM_MESSAGING_NETTY_BUFFER_SIZE_SCHEMA

public static final Object STORM_MESSAGING_NETTY_BUFFER_SIZE_SCHEMA

STORM_MESSAGING_NETTY_MAX_RETRIES

public static final String STORM_MESSAGING_NETTY_MAX_RETRIES

Netty based messaging: The max # of retries that a peer will perform when a remote is not accessible

See Also:

Constant Field Values

STORM_MESSAGING_NETTY_MAX_RETRIES_SCHEMA

public static final Object STORM_MESSAGING_NETTY_MAX_RETRIES_SCHEMA

STORM_MESSAGING_NETTY_MIN_SLEEP_MS

public static final String STORM_MESSAGING_NETTY_MIN_SLEEP_MS

Netty based messaging: The min # of milliseconds that a peer will wait.

See Also:

Constant Field Values

STORM_MESSAGING_NETTY_MIN_SLEEP_MS_SCHEMA

public static final Object STORM_MESSAGING_NETTY_MIN_SLEEP_MS_SCHEMA

STORM_MESSAGING_NETTY_MAX_SLEEP_MS

public static final String STORM_MESSAGING_NETTY_MAX_SLEEP_MS

Netty based messaging: The max # of milliseconds that a peer will wait.

See Also:

Constant Field Values

STORM_MESSAGING_NETTY_MAX_SLEEP_MS_SCHEMA

public static final Object STORM_MESSAGING_NETTY_MAX_SLEEP_MS_SCHEMA

STORM_MESSAGING_NETTY_SERVER_WORKER_THREADS

public static final String STORM_MESSAGING_NETTY_SERVER_WORKER_THREADS

Netty based messaging: The # of worker threads for the server.

See Also:

Constant Field Values

STORM_MESSAGING_NETTY_SERVER_WORKER_THREADS_SCHEMA

public static final Object STORM_MESSAGING_NETTY_SERVER_WORKER_THREADS_SCHEMA

STORM_MESSAGING_NETTY_CLIENT_WORKER_THREADS

public static final String STORM_MESSAGING_NETTY_CLIENT_WORKER_THREADS

Netty based messaging: The # of worker threads for the client.

See Also:

Constant Field Values

STORM_MESSAGING_NETTY_CLIENT_WORKER_THREADS_SCHEMA

public static final Object STORM_MESSAGING_NETTY_CLIENT_WORKER_THREADS_SCHEMA

STORM_NETTY_MESSAGE_BATCH_SIZE

public static final String STORM_NETTY_MESSAGE_BATCH_SIZE

If the Netty messaging layer is busy, the Netty client will try to batch message as more as possible up to the size of STORM_NETTY_MESSAGE_BATCH_SIZE bytes

See Also:

Constant Field Values

STORM_NETTY_MESSAGE_BATCH_SIZE_SCHEMA

public static final Object STORM_NETTY_MESSAGE_BATCH_SIZE_SCHEMA

STORM_NETTY_FLUSH_CHECK_INTERVAL_MS

public static final String STORM_NETTY_FLUSH_CHECK_INTERVAL_MS

We check with this interval that whether the Netty channel is writable and try to write pending messages

See Also:

Constant Field Values

STORM_NETTY_FLUSH_CHECK_INTERVAL_MS_SCHEMA

public static final Object STORM_NETTY_FLUSH_CHECK_INTERVAL_MS_SCHEMA

STORM_ZOOKEEPER_SERVERS

public static final String STORM_ZOOKEEPER_SERVERS

A list of hosts of ZooKeeper servers used to manage the cluster.

See Also:

Constant Field Values

STORM_ZOOKEEPER_SERVERS_SCHEMA

public static final Object STORM_ZOOKEEPER_SERVERS_SCHEMA

STORM_ZOOKEEPER_PORT

public static final String STORM_ZOOKEEPER_PORT

The port Storm will use to connect to each of the ZooKeeper servers.

See Also:

Constant Field Values

STORM_ZOOKEEPER_PORT_SCHEMA

public static final Object STORM_ZOOKEEPER_PORT_SCHEMA

STORM_LOCAL_DIR

public static final String STORM_LOCAL_DIR

A directory on the local filesystem used by Storm for any local filesystem usage it needs. The directory must exist and the Storm daemons must have permission to read/write from this location.

See Also:

Constant Field Values

STORM_LOCAL_DIR_SCHEMA

public static final Object STORM_LOCAL_DIR_SCHEMA

STORM_SCHEDULER

public static final String STORM_SCHEDULER

A global task scheduler used to assign topologies's tasks to supervisors' wokers. If this is not set, a default system scheduler will be used.

See Also:

Constant Field Values

STORM_SCHEDULER_SCHEMA

public static final Object STORM_SCHEDULER_SCHEMA

STORM_CLUSTER_MODE

public static final String STORM_CLUSTER_MODE

The mode this Storm cluster is running in. Either "distributed" or "local".

See Also:

Constant Field Values

STORM_CLUSTER_MODE_SCHEMA

public static final Object STORM_CLUSTER_MODE_SCHEMA

STORM_LOCAL_HOSTNAME

public static final String STORM_LOCAL_HOSTNAME

The hostname the supervisors/workers should report to nimbus. If unset, Storm will get the hostname to report by calling InetAddress.getLocalHost().getCanonicalHostName(). You should set this config when you dont have a DNS which supervisors/workers can utilize to find each other based on hostname got from calls to InetAddress.getLocalHost().getCanonicalHostName().

See Also:

Constant Field Values

STORM_LOCAL_HOSTNAME_SCHEMA

public static final Object STORM_LOCAL_HOSTNAME_SCHEMA

STORM_THRIFT_TRANSPORT_PLUGIN

public static final String STORM_THRIFT_TRANSPORT_PLUGIN

The transport plug-in for Thrift client/server communication

See Also:

Constant Field Values

STORM_THRIFT_TRANSPORT_PLUGIN_SCHEMA

public static final Object STORM_THRIFT_TRANSPORT_PLUGIN_SCHEMA

TOPOLOGY_TUPLE_SERIALIZER

public static final String TOPOLOGY_TUPLE_SERIALIZER

The serializer class for ListDelegate (tuple payload). The default serializer will be ListDelegateSerializer

See Also:

Constant Field Values

TOPOLOGY_TUPLE_SERIALIZER_SCHEMA

public static final Object TOPOLOGY_TUPLE_SERIALIZER_SCHEMA

STORM_LOCAL_MODE_ZMQ

public static final String STORM_LOCAL_MODE_ZMQ

Whether or not to use ZeroMQ for messaging in local mode. If this is set to false, then Storm will use a pure-Java messaging system. The purpose of this flag is to make it easy to run Storm in local mode by eliminating the need for native dependencies, which can be difficult to install. Defaults to false.

See Also:

Constant Field Values

STORM_LOCAL_MODE_ZMQ_SCHEMA

public static final Object STORM_LOCAL_MODE_ZMQ_SCHEMA

STORM_ZOOKEEPER_ROOT

public static final String STORM_ZOOKEEPER_ROOT

The root location at which Storm stores data in ZooKeeper.

See Also:

Constant Field Values

STORM_ZOOKEEPER_ROOT_SCHEMA

public static final Object STORM_ZOOKEEPER_ROOT_SCHEMA

STORM_ZOOKEEPER_SESSION_TIMEOUT

public static final String STORM_ZOOKEEPER_SESSION_TIMEOUT

The session timeout for clients to ZooKeeper.

See Also:

Constant Field Values

STORM_ZOOKEEPER_SESSION_TIMEOUT_SCHEMA

public static final Object STORM_ZOOKEEPER_SESSION_TIMEOUT_SCHEMA

STORM_ZOOKEEPER_CONNECTION_TIMEOUT

public static final String STORM_ZOOKEEPER_CONNECTION_TIMEOUT

The connection timeout for clients to ZooKeeper.

See Also:

Constant Field Values

STORM_ZOOKEEPER_CONNECTION_TIMEOUT_SCHEMA

public static final Object STORM_ZOOKEEPER_CONNECTION_TIMEOUT_SCHEMA

STORM_ZOOKEEPER_RETRY_TIMES

public static final String STORM_ZOOKEEPER_RETRY_TIMES

The number of times to retry a Zookeeper operation.

See Also:

Constant Field Values

STORM_ZOOKEEPER_RETRY_TIMES_SCHEMA

public static final Object STORM_ZOOKEEPER_RETRY_TIMES_SCHEMA

STORM_ZOOKEEPER_RETRY_INTERVAL

public static final String STORM_ZOOKEEPER_RETRY_INTERVAL

The interval between retries of a Zookeeper operation.

See Also:

Constant Field Values

STORM_ZOOKEEPER_RETRY_INTERVAL_SCHEMA

public static final Object STORM_ZOOKEEPER_RETRY_INTERVAL_SCHEMA

STORM_ZOOKEEPER_RETRY_INTERVAL_CEILING

public static final String STORM_ZOOKEEPER_RETRY_INTERVAL_CEILING

The ceiling of the interval between retries of a Zookeeper operation.

See Also:

Constant Field Values

STORM_ZOOKEEPER_RETRY_INTERVAL_CEILING_SCHEMA

public static final Object STORM_ZOOKEEPER_RETRY_INTERVAL_CEILING_SCHEMA

STORM_ZOOKEEPER_AUTH_SCHEME

public static final String STORM_ZOOKEEPER_AUTH_SCHEME

The Zookeeper authentication scheme to use, e.g. "digest". Defaults to no authentication.

See Also:

Constant Field Values

STORM_ZOOKEEPER_AUTH_SCHEME_SCHEMA

public static final Object STORM_ZOOKEEPER_AUTH_SCHEME_SCHEMA

STORM_ZOOKEEPER_AUTH_PAYLOAD

public static final String STORM_ZOOKEEPER_AUTH_PAYLOAD

A string representing the payload for Zookeeper authentication. It gets serialized using UTF-8 encoding during authentication.

See Also:

Constant Field Values

STORM_ZOOKEEPER_AUTH_PAYLOAD_SCHEMA

public static final Object STORM_ZOOKEEPER_AUTH_PAYLOAD_SCHEMA

STORM_ID

public static final String STORM_ID

The id assigned to a running topology. The id is the storm name with a unique nonce appended.

See Also:

Constant Field Values

STORM_ID_SCHEMA

public static final Object STORM_ID_SCHEMA

NIMBUS_HOST

public static final String NIMBUS_HOST

The host that the master server is running on.

See Also:

Constant Field Values

NIMBUS_HOST_SCHEMA

public static final Object NIMBUS_HOST_SCHEMA

NIMBUS_THRIFT_PORT

public static final String NIMBUS_THRIFT_PORT

Which port the Thrift interface of Nimbus should run on. Clients should connect to this port to upload jars and submit topologies.

See Also:

Constant Field Values

NIMBUS_THRIFT_PORT_SCHEMA

public static final Object NIMBUS_THRIFT_PORT_SCHEMA

NIMBUS_THRIFT_MAX_BUFFER_SIZE

public static final String NIMBUS_THRIFT_MAX_BUFFER_SIZE

The maximum buffer size thrift should use when reading messages.

See Also:

Constant Field Values

NIMBUS_THRIFT_MAX_BUFFER_SIZE_SCHEMA

public static final Object NIMBUS_THRIFT_MAX_BUFFER_SIZE_SCHEMA

NIMBUS_CHILDOPTS

public static final String NIMBUS_CHILDOPTS

This parameter is used by the storm-deploy project to configure the jvm options for the nimbus daemon.

See Also:

Constant Field Values

NIMBUS_CHILDOPTS_SCHEMA

public static final Object NIMBUS_CHILDOPTS_SCHEMA

NIMBUS_TASK_TIMEOUT_SECS

public static final String NIMBUS_TASK_TIMEOUT_SECS

How long without heartbeating a task can go before nimbus will consider the task dead and reassign it to another location.

See Also:

Constant Field Values

NIMBUS_TASK_TIMEOUT_SECS_SCHEMA

public static final Object NIMBUS_TASK_TIMEOUT_SECS_SCHEMA

NIMBUS_MONITOR_FREQ_SECS

public static final String NIMBUS_MONITOR_FREQ_SECS

How often nimbus should wake up to check heartbeats and do reassignments. Note that if a machine ever goes down Nimbus will immediately wake up and take action. This parameter is for checking for failures when there's no explicit event like that occuring.

See Also:

Constant Field Values

NIMBUS_MONITOR_FREQ_SECS_SCHEMA

public static final Object NIMBUS_MONITOR_FREQ_SECS_SCHEMA

NIMBUS_CLEANUP_INBOX_FREQ_SECS

public static final String NIMBUS_CLEANUP_INBOX_FREQ_SECS

How often nimbus should wake the cleanup thread to clean the inbox.

See Also:

NIMBUS_INBOX_JAR_EXPIRATION_SECS, Constant Field Values

NIMBUS_CLEANUP_INBOX_FREQ_SECS_SCHEMA

public static final Object NIMBUS_CLEANUP_INBOX_FREQ_SECS_SCHEMA

NIMBUS_INBOX_JAR_EXPIRATION_SECS

public static final String NIMBUS_INBOX_JAR_EXPIRATION_SECS

The length of time a jar file lives in the inbox before being deleted by the cleanup thread. Probably keep this value greater than or equal to NIMBUS_CLEANUP_INBOX_JAR_EXPIRATION_SECS. Note that the time it takes to delete an inbox jar file is going to be somewhat more than NIMBUS_CLEANUP_INBOX_JAR_EXPIRATION_SECS (depending on how often NIMBUS_CLEANUP_FREQ_SECS is set to).

See Also:

NIMBUS_CLEANUP_FREQ_SECS, Constant Field Values

NIMBUS_INBOX_JAR_EXPIRATION_SECS_SCHEMA

public static final Object NIMBUS_INBOX_JAR_EXPIRATION_SECS_SCHEMA

NIMBUS_SUPERVISOR_TIMEOUT_SECS

public static final String NIMBUS_SUPERVISOR_TIMEOUT_SECS

How long before a supervisor can go without heartbeating before nimbus considers it dead and stops assigning new work to it.

See Also:

Constant Field Values

NIMBUS_SUPERVISOR_TIMEOUT_SECS_SCHEMA

public static final Object NIMBUS_SUPERVISOR_TIMEOUT_SECS_SCHEMA

NIMBUS_TASK_LAUNCH_SECS

public static final String NIMBUS_TASK_LAUNCH_SECS

A special timeout used when a task is initially launched. During launch, this is the timeout used until the first heartbeat, overriding nimbus.task.timeout.secs.

A separate timeout exists for launch because there can be quite a bit of overhead to launching new JVM's and configuring them.

See Also:

Constant Field Values

NIMBUS_TASK_LAUNCH_SECS_SCHEMA

public static final Object NIMBUS_TASK_LAUNCH_SECS_SCHEMA

NIMBUS_REASSIGN

public static final String NIMBUS_REASSIGN

Whether or not nimbus should reassign tasks if it detects that a task goes down. Defaults to true, and it's not recommended to change this value.

See Also:

Constant Field Values

NIMBUS_REASSIGN_SCHEMA

public static final Object NIMBUS_REASSIGN_SCHEMA

NIMBUS_FILE_COPY_EXPIRATION_SECS

public static final String NIMBUS_FILE_COPY_EXPIRATION_SECS

During upload/download with the master, how long an upload or download connection is idle before nimbus considers it dead and drops the connection.

See Also:

Constant Field Values

NIMBUS_FILE_COPY_EXPIRATION_SECS_SCHEMA

public static final Object NIMBUS_FILE_COPY_EXPIRATION_SECS_SCHEMA

NIMBUS_TOPOLOGY_VALIDATOR

public static final String NIMBUS_TOPOLOGY_VALIDATOR

A custom class that implements ITopologyValidator that is run whenever a topology is submitted. Can be used to provide business-specific logic for whether topologies are allowed to run or not.

See Also:

Constant Field Values

NIMBUS_TOPOLOGY_VALIDATOR_SCHEMA

public static final Object NIMBUS_TOPOLOGY_VALIDATOR_SCHEMA

NIMBUS_AUTHORIZER

public static final String NIMBUS_AUTHORIZER

Class name for authorization plugin for Nimbus

See Also:

Constant Field Values

NIMBUS_AUTHORIZER_SCHEMA

public static final Object NIMBUS_AUTHORIZER_SCHEMA

UI_PORT

public static final String UI_PORT

Storm UI binds to this port.

See Also:

Constant Field Values

UI_PORT_SCHEMA

public static final Object UI_PORT_SCHEMA

LOGVIEWER_PORT

public static final String LOGVIEWER_PORT

HTTP UI port for log viewer

See Also:

Constant Field Values

LOGVIEWER_PORT_SCHEMA

public static final Object LOGVIEWER_PORT_SCHEMA

LOGVIEWER_CHILDOPTS

public static final String LOGVIEWER_CHILDOPTS

Childopts for log viewer java process.

See Also:

Constant Field Values

LOGVIEWER_CHILDOPTS_SCHEMA

public static final Object LOGVIEWER_CHILDOPTS_SCHEMA

LOGVIEWER_APPENDER_NAME

public static final String LOGVIEWER_APPENDER_NAME

Appender name used by log viewer to determine log directory.

See Also:

Constant Field Values

LOGVIEWER_APPENDER_NAME_SCHEMA

public static final Object LOGVIEWER_APPENDER_NAME_SCHEMA

UI_CHILDOPTS

public static final String UI_CHILDOPTS

Childopts for Storm UI Java process.

See Also:

Constant Field Values

UI_CHILDOPTS_SCHEMA

public static final Object UI_CHILDOPTS_SCHEMA

DRPC_SERVERS

public static final String DRPC_SERVERS

List of DRPC servers so that the DRPCSpout knows who to talk to.

See Also:

Constant Field Values

DRPC_SERVERS_SCHEMA

public static final Object DRPC_SERVERS_SCHEMA

DRPC_PORT

public static final String DRPC_PORT

This port is used by Storm DRPC for receiving DPRC requests from clients.

See Also:

Constant Field Values

DRPC_PORT_SCHEMA

public static final Object DRPC_PORT_SCHEMA

DRPC_WORKER_THREADS

public static final String DRPC_WORKER_THREADS

DRPC thrift server worker threads

See Also:

Constant Field Values

DRPC_WORKER_THREADS_SCHEMA

public static final Object DRPC_WORKER_THREADS_SCHEMA

DRPC_QUEUE_SIZE

public static final String DRPC_QUEUE_SIZE

DRPC thrift server queue size

See Also:

Constant Field Values

DRPC_QUEUE_SIZE_SCHEMA

public static final Object DRPC_QUEUE_SIZE_SCHEMA

DRPC_INVOCATIONS_PORT

public static final String DRPC_INVOCATIONS_PORT

This port on Storm DRPC is used by DRPC topologies to receive function invocations and send results back.

See Also:

Constant Field Values

DRPC_INVOCATIONS_PORT_SCHEMA

public static final Object DRPC_INVOCATIONS_PORT_SCHEMA

DRPC_REQUEST_TIMEOUT_SECS

public static final String DRPC_REQUEST_TIMEOUT_SECS

The timeout on DRPC requests within the DRPC server. Defaults to 10 minutes. Note that requests can also timeout based on the socket timeout on the DRPC client, and separately based on the topology message timeout for the topology implementing the DRPC function.

See Also:

Constant Field Values

DRPC_REQUEST_TIMEOUT_SECS_SCHEMA

public static final Object DRPC_REQUEST_TIMEOUT_SECS_SCHEMA

DRPC_CHILDOPTS

public static final String DRPC_CHILDOPTS

Childopts for Storm DRPC Java process.

See Also:

Constant Field Values

DRPC_CHILDOPTS_SCHEMA

public static final Object DRPC_CHILDOPTS_SCHEMA

SUPERVISOR_SCHEDULER_META

public static final String SUPERVISOR_SCHEDULER_META

the metadata configed on the supervisor

See Also:

Constant Field Values

SUPERVISOR_SCHEDULER_META_SCHEMA

public static final Object SUPERVISOR_SCHEDULER_META_SCHEMA

SUPERVISOR_SLOTS_PORTS

public static final String SUPERVISOR_SLOTS_PORTS

A list of ports that can run workers on this supervisor. Each worker uses one port, and the supervisor will only run one worker per port. Use this configuration to tune how many workers run on each machine.

See Also:

Constant Field Values

SUPERVISOR_SLOTS_PORTS_SCHEMA

public static final Object SUPERVISOR_SLOTS_PORTS_SCHEMA

SUPERVISOR_CHILDOPTS

public static final String SUPERVISOR_CHILDOPTS

This parameter is used by the storm-deploy project to configure the jvm options for the supervisor daemon.

See Also:

Constant Field Values

SUPERVISOR_CHILDOPTS_SCHEMA

public static final Object SUPERVISOR_CHILDOPTS_SCHEMA

SUPERVISOR_WORKER_TIMEOUT_SECS

public static final String SUPERVISOR_WORKER_TIMEOUT_SECS

How long a worker can go without heartbeating before the supervisor tries to restart the worker process.

See Also:

Constant Field Values

SUPERVISOR_WORKER_TIMEOUT_SECS_SCHEMA

public static final Object SUPERVISOR_WORKER_TIMEOUT_SECS_SCHEMA

SUPERVISOR_WORKER_START_TIMEOUT_SECS

public static final String SUPERVISOR_WORKER_START_TIMEOUT_SECS

How long a worker can go without heartbeating during the initial launch before the supervisor tries to restart the worker process. This value override supervisor.worker.timeout.secs during launch because there is additional overhead to starting and configuring the JVM on launch.

See Also:

Constant Field Values

SUPERVISOR_WORKER_START_TIMEOUT_SECS_SCHEMA

public static final Object SUPERVISOR_WORKER_START_TIMEOUT_SECS_SCHEMA

SUPERVISOR_ENABLE

public static final String SUPERVISOR_ENABLE

Whether or not the supervisor should launch workers assigned to it. Defaults to true -- and you should probably never change this value. This configuration is used in the Storm unit tests.

See Also:

Constant Field Values

SUPERVISOR_ENABLE_SCHEMA

public static final Object SUPERVISOR_ENABLE_SCHEMA

SUPERVISOR_HEARTBEAT_FREQUENCY_SECS

public static final String SUPERVISOR_HEARTBEAT_FREQUENCY_SECS

how often the supervisor sends a heartbeat to the master.

See Also:

Constant Field Values

SUPERVISOR_HEARTBEAT_FREQUENCY_SECS_SCHEMA

public static final Object SUPERVISOR_HEARTBEAT_FREQUENCY_SECS_SCHEMA

SUPERVISOR_MONITOR_FREQUENCY_SECS

public static final String SUPERVISOR_MONITOR_FREQUENCY_SECS

How often the supervisor checks the worker heartbeats to see if any of them need to be restarted.

See Also:

Constant Field Values

SUPERVISOR_MONITOR_FREQUENCY_SECS_SCHEMA

public static final Object SUPERVISOR_MONITOR_FREQUENCY_SECS_SCHEMA

WORKER_CHILDOPTS

public static final String WORKER_CHILDOPTS

The jvm opts provided to workers launched by this supervisor. All "%ID%" substrings are replaced with an identifier for this worker.

See Also:

Constant Field Values

WORKER_CHILDOPTS_SCHEMA

public static final Object WORKER_CHILDOPTS_SCHEMA

WORKER_RECEIVER_THREAD_COUNT

public static final String WORKER_RECEIVER_THREAD_COUNT

control how many worker receiver threads we need per worker

See Also:

Constant Field Values

WORKER_RECEIVER_THREAD_COUNT_SCHEMA

public static final Object WORKER_RECEIVER_THREAD_COUNT_SCHEMA

WORKER_HEARTBEAT_FREQUENCY_SECS

public static final String WORKER_HEARTBEAT_FREQUENCY_SECS

How often this worker should heartbeat to the supervisor.

See Also:

Constant Field Values

WORKER_HEARTBEAT_FREQUENCY_SECS_SCHEMA

public static final Object WORKER_HEARTBEAT_FREQUENCY_SECS_SCHEMA

TASK_HEARTBEAT_FREQUENCY_SECS

public static final String TASK_HEARTBEAT_FREQUENCY_SECS

How often a task should heartbeat its status to the master.

See Also:

Constant Field Values

TASK_HEARTBEAT_FREQUENCY_SECS_SCHEMA

public static final Object TASK_HEARTBEAT_FREQUENCY_SECS_SCHEMA

TASK_REFRESH_POLL_SECS

public static final String TASK_REFRESH_POLL_SECS

How often a task should sync its connections with other tasks (if a task is reassigned, the other tasks sending messages to it need to refresh their connections). In general though, when a reassignment happens other tasks will be notified almost immediately. This configuration is here just in case that notification doesn't come through.

See Also:

Constant Field Values

TASK_REFRESH_POLL_SECS_SCHEMA

public static final Object TASK_REFRESH_POLL_SECS_SCHEMA

TOPOLOGY_ENABLE_MESSAGE_TIMEOUTS

public static final String TOPOLOGY_ENABLE_MESSAGE_TIMEOUTS

True if Storm should timeout messages or not. Defaults to true. This is meant to be used in unit tests to prevent tuples from being accidentally timed out during the test.

See Also:

Constant Field Values

TOPOLOGY_ENABLE_MESSAGE_TIMEOUTS_SCHEMA

public static final Object TOPOLOGY_ENABLE_MESSAGE_TIMEOUTS_SCHEMA

TOPOLOGY_DEBUG

public static final String TOPOLOGY_DEBUG

When set to true, Storm will log every message that's emitted.

See Also:

Constant Field Values

TOPOLOGY_DEBUG_SCHEMA

public static final Object TOPOLOGY_DEBUG_SCHEMA

TOPOLOGY_MULTILANG_SERIALIZER

public static final String TOPOLOGY_MULTILANG_SERIALIZER

The serializer for communication between shell components and non-JVM processes

See Also:

Constant Field Values

TOPOLOGY_MULTILANG_SERIALIZER_SCHEMA

public static final Object TOPOLOGY_MULTILANG_SERIALIZER_SCHEMA

TOPOLOGY_WORKERS

public static final String TOPOLOGY_WORKERS

How many processes should be spawned around the cluster to execute this topology. Each process will execute some number of tasks as threads within them. This parameter should be used in conjunction with the parallelism hints on each component in the topology to tune the performance of a topology.

See Also:

Constant Field Values

TOPOLOGY_WORKERS_SCHEMA

public static final Object TOPOLOGY_WORKERS_SCHEMA

TOPOLOGY_TASKS

public static final String TOPOLOGY_TASKS

How many instances to create for a spout/bolt. A task runs on a thread with zero or more other tasks for the same spout/bolt. The number of tasks for a spout/bolt is always the same throughout the lifetime of a topology, but the number of executors (threads) for a spout/bolt can change over time. This allows a topology to scale to more or less resources without redeploying the topology or violating the constraints of Storm (such as a fields grouping guaranteeing that the same value goes to the same task).

See Also:

Constant Field Values

TOPOLOGY_TASKS_SCHEMA

public static final Object TOPOLOGY_TASKS_SCHEMA

TOPOLOGY_ACKER_EXECUTORS

public static final String TOPOLOGY_ACKER_EXECUTORS

How many executors to spawn for ackers.

If this is set to 0, then Storm will immediately ack tuples as soon as they come off the spout, effectively disabling reliability.

See Also:

Constant Field Values

TOPOLOGY_ACKER_EXECUTORS_SCHEMA

public static final Object TOPOLOGY_ACKER_EXECUTORS_SCHEMA

TOPOLOGY_MESSAGE_TIMEOUT_SECS

public static final String TOPOLOGY_MESSAGE_TIMEOUT_SECS

The maximum amount of time given to the topology to fully process a message emitted by a spout. If the message is not acked within this time frame, Storm will fail the message on the spout. Some spouts implementations will then replay the message at a later time.

See Also:

Constant Field Values

TOPOLOGY_MESSAGE_TIMEOUT_SECS_SCHEMA

public static final Object TOPOLOGY_MESSAGE_TIMEOUT_SECS_SCHEMA

TOPOLOGY_KRYO_REGISTER

public static final String TOPOLOGY_KRYO_REGISTER

A list of serialization registrations for Kryo ( http://code.google.com/p/kryo/ ), the underlying serialization framework for Storm. A serialization can either be the name of a class (in which case Kryo will automatically create a serializer for the class that saves all the object's fields), or an implementation of com.esotericsoftware.kryo.Serializer. See Kryo's documentation for more information about writing custom serializers.

See Also:

Constant Field Values

TOPOLOGY_KRYO_REGISTER_SCHEMA

public static final Object TOPOLOGY_KRYO_REGISTER_SCHEMA

TOPOLOGY_KRYO_DECORATORS

public static final String TOPOLOGY_KRYO_DECORATORS

A list of classes that customize storm's kryo instance during start-up. Each listed class name must implement IKryoDecorator. During start-up the listed class is instantiated with 0 arguments, then its 'decorate' method is called with storm's kryo instance as the only argument.

See Also:

Constant Field Values

TOPOLOGY_KRYO_DECORATORS_SCHEMA

public static final Object TOPOLOGY_KRYO_DECORATORS_SCHEMA

TOPOLOGY_KRYO_FACTORY

public static final String TOPOLOGY_KRYO_FACTORY

Class that specifies how to create a Kryo instance for serialization. Storm will then apply topology.kryo.register and topology.kryo.decorators on top of this. The default implementation implements topology.fall.back.on.java.serialization and turns references off.

See Also:

Constant Field Values

TOPOLOGY_KRYO_FACTORY_SCHEMA

public static final Object TOPOLOGY_KRYO_FACTORY_SCHEMA

TOPOLOGY_SKIP_MISSING_KRYO_REGISTRATIONS

public static final String TOPOLOGY_SKIP_MISSING_KRYO_REGISTRATIONS

Whether or not Storm should skip the loading of kryo registrations for which it does not know the class or have the serializer implementation. Otherwise, the task will fail to load and will throw an error at runtime. The use case of this is if you want to declare your serializations on the storm.yaml files on the cluster rather than every single time you submit a topology. Different applications may use different serializations and so a single application may not have the code for the other serializers used by other apps. By setting this config to true, Storm will ignore that it doesn't have those other serializations rather than throw an error.

See Also:

Constant Field Values

TOPOLOGY_SKIP_MISSING_KRYO_REGISTRATIONS_SCHEMA

public static final Object TOPOLOGY_SKIP_MISSING_KRYO_REGISTRATIONS_SCHEMA

TOPOLOGY_METRICS_CONSUMER_REGISTER

public static final String TOPOLOGY_METRICS_CONSUMER_REGISTER

See Also:

Constant Field Values

TOPOLOGY_METRICS_CONSUMER_REGISTER_SCHEMA

public static final Object TOPOLOGY_METRICS_CONSUMER_REGISTER_SCHEMA

TOPOLOGY_MAX_TASK_PARALLELISM

public static final String TOPOLOGY_MAX_TASK_PARALLELISM

The maximum parallelism allowed for a component in this topology. This configuration is typically used in testing to limit the number of threads spawned in local mode.

See Also:

Constant Field Values

TOPOLOGY_MAX_TASK_PARALLELISM_SCHEMA

public static final Object TOPOLOGY_MAX_TASK_PARALLELISM_SCHEMA

TOPOLOGY_MAX_SPOUT_PENDING

public static final String TOPOLOGY_MAX_SPOUT_PENDING

The maximum number of tuples that can be pending on a spout task at any given time. This config applies to individual tasks, not to spouts or topologies as a whole. A pending tuple is one that has been emitted from a spout but has not been acked or failed yet. Note that this config parameter has no effect for unreliable spouts that don't tag their tuples with a message id.

See Also:

Constant Field Values

TOPOLOGY_MAX_SPOUT_PENDING_SCHEMA

public static final Object TOPOLOGY_MAX_SPOUT_PENDING_SCHEMA

TOPOLOGY_SPOUT_WAIT_STRATEGY

public static final String TOPOLOGY_SPOUT_WAIT_STRATEGY

A class that implements a strategy for what to do when a spout needs to wait. Waiting is triggered in one of two conditions: 1. nextTuple emits no tuples 2. The spout has hit maxSpoutPending and can't emit any more tuples

See Also:

Constant Field Values

TOPOLOGY_SPOUT_WAIT_STRATEGY_SCHEMA

public static final Object TOPOLOGY_SPOUT_WAIT_STRATEGY_SCHEMA

TOPOLOGY_SLEEP_SPOUT_WAIT_STRATEGY_TIME_MS

public static final String TOPOLOGY_SLEEP_SPOUT_WAIT_STRATEGY_TIME_MS

The amount of milliseconds the SleepEmptyEmitStrategy should sleep for.

See Also:

Constant Field Values

TOPOLOGY_SLEEP_SPOUT_WAIT_STRATEGY_TIME_MS_SCHEMA

public static final Object TOPOLOGY_SLEEP_SPOUT_WAIT_STRATEGY_TIME_MS_SCHEMA

TOPOLOGY_STATE_SYNCHRONIZATION_TIMEOUT_SECS

public static final String TOPOLOGY_STATE_SYNCHRONIZATION_TIMEOUT_SECS

The maximum amount of time a component gives a source of state to synchronize before it requests synchronization again.

See Also:

Constant Field Values

TOPOLOGY_STATE_SYNCHRONIZATION_TIMEOUT_SECS_SCHEMA

public static final Object TOPOLOGY_STATE_SYNCHRONIZATION_TIMEOUT_SECS_SCHEMA

TOPOLOGY_STATS_SAMPLE_RATE

public static final String TOPOLOGY_STATS_SAMPLE_RATE

The percentage of tuples to sample to produce stats for a task.

See Also:

Constant Field Values

TOPOLOGY_STATS_SAMPLE_RATE_SCHEMA

public static final Object TOPOLOGY_STATS_SAMPLE_RATE_SCHEMA

TOPOLOGY_BUILTIN_METRICS_BUCKET_SIZE_SECS

public static final String TOPOLOGY_BUILTIN_METRICS_BUCKET_SIZE_SECS

The time period that builtin metrics data in bucketed into.

See Also:

Constant Field Values

TOPOLOGY_BUILTIN_METRICS_BUCKET_SIZE_SECS_SCHEMA

public static final Object TOPOLOGY_BUILTIN_METRICS_BUCKET_SIZE_SECS_SCHEMA

TOPOLOGY_FALL_BACK_ON_JAVA_SERIALIZATION

public static final String TOPOLOGY_FALL_BACK_ON_JAVA_SERIALIZATION

Whether or not to use Java serialization in a topology.

See Also:

Constant Field Values

TOPOLOGY_FALL_BACK_ON_JAVA_SERIALIZATION_SCHEMA

public static final Object TOPOLOGY_FALL_BACK_ON_JAVA_SERIALIZATION_SCHEMA

TOPOLOGY_WORKER_CHILDOPTS

public static final String TOPOLOGY_WORKER_CHILDOPTS

Topology-specific options for the worker child process. This is used in addition to WORKER_CHILDOPTS.

See Also:

Constant Field Values

TOPOLOGY_WORKER_CHILDOPTS_SCHEMA

public static final Object TOPOLOGY_WORKER_CHILDOPTS_SCHEMA

TOPOLOGY_TRANSACTIONAL_ID

public static final String TOPOLOGY_TRANSACTIONAL_ID

This config is available for TransactionalSpouts, and contains the id ( a String) for the transactional topology. This id is used to store the state of the transactional topology in Zookeeper.

See Also:

Constant Field Values

TOPOLOGY_TRANSACTIONAL_ID_SCHEMA

public static final Object TOPOLOGY_TRANSACTIONAL_ID_SCHEMA

TOPOLOGY_AUTO_TASK_HOOKS

public static final String TOPOLOGY_AUTO_TASK_HOOKS

A list of task hooks that are automatically added to every spout and bolt in the topology. An example of when you'd do this is to add a hook that integrates with your internal monitoring system. These hooks are instantiated using the zero-arg constructor.

See Also:

Constant Field Values

TOPOLOGY_AUTO_TASK_HOOKS_SCHEMA

public static final Object TOPOLOGY_AUTO_TASK_HOOKS_SCHEMA

TOPOLOGY_EXECUTOR_RECEIVE_BUFFER_SIZE

public static final String TOPOLOGY_EXECUTOR_RECEIVE_BUFFER_SIZE

The size of the Disruptor receive queue for each executor. Must be a power of 2.

See Also:

Constant Field Values

TOPOLOGY_EXECUTOR_RECEIVE_BUFFER_SIZE_SCHEMA

public static final Object TOPOLOGY_EXECUTOR_RECEIVE_BUFFER_SIZE_SCHEMA

TOPOLOGY_RECEIVER_BUFFER_SIZE

public static final String TOPOLOGY_RECEIVER_BUFFER_SIZE

The maximum number of messages to batch from the thread receiving off the network to the executor queues. Must be a power of 2.

See Also:

Constant Field Values

TOPOLOGY_RECEIVER_BUFFER_SIZE_SCHEMA

public static final Object TOPOLOGY_RECEIVER_BUFFER_SIZE_SCHEMA

TOPOLOGY_EXECUTOR_SEND_BUFFER_SIZE

public static final String TOPOLOGY_EXECUTOR_SEND_BUFFER_SIZE

The size of the Disruptor send queue for each executor. Must be a power of 2.

See Also:

Constant Field Values

TOPOLOGY_EXECUTOR_SEND_BUFFER_SIZE_SCHEMA

public static final Object TOPOLOGY_EXECUTOR_SEND_BUFFER_SIZE_SCHEMA

TOPOLOGY_TRANSFER_BUFFER_SIZE

public static final String TOPOLOGY_TRANSFER_BUFFER_SIZE

The size of the Disruptor transfer queue for each worker.

See Also:

Constant Field Values

TOPOLOGY_TRANSFER_BUFFER_SIZE_SCHEMA

public static final Object TOPOLOGY_TRANSFER_BUFFER_SIZE_SCHEMA

TOPOLOGY_TICK_TUPLE_FREQ_SECS

public static final String TOPOLOGY_TICK_TUPLE_FREQ_SECS

How often a tick tuple from the "__system" component and "__tick" stream should be sent to tasks. Meant to be used as a component-specific configuration.

See Also:

Constant Field Values

TOPOLOGY_TICK_TUPLE_FREQ_SECS_SCHEMA

public static final Object TOPOLOGY_TICK_TUPLE_FREQ_SECS_SCHEMA

TOPOLOGY_DISRUPTOR_WAIT_STRATEGY

public static final String TOPOLOGY_DISRUPTOR_WAIT_STRATEGY

Configure the wait strategy used for internal queuing. Can be used to tradeoff latency vs. throughput

See Also:

Constant Field Values

TOPOLOGY_DISRUPTOR_WAIT_STRATEGY_SCHEMA

public static final Object TOPOLOGY_DISRUPTOR_WAIT_STRATEGY_SCHEMA

TOPOLOGY_WORKER_SHARED_THREAD_POOL_SIZE

public static final String TOPOLOGY_WORKER_SHARED_THREAD_POOL_SIZE

The size of the shared thread pool for worker tasks to make use of. The thread pool can be accessed via the TopologyContext.

See Also:

Constant Field Values

TOPOLOGY_WORKER_SHARED_THREAD_POOL_SIZE_SCHEMA

public static final Object TOPOLOGY_WORKER_SHARED_THREAD_POOL_SIZE_SCHEMA

TOPOLOGY_ERROR_THROTTLE_INTERVAL_SECS

public static final String TOPOLOGY_ERROR_THROTTLE_INTERVAL_SECS

The interval in seconds to use for determining whether to throttle error reported to Zookeeper. For example, an interval of 10 seconds with topology.max.error.report.per.interval set to 5 will only allow 5 errors to be reported to Zookeeper per task for every 10 second interval of time.

See Also:

Constant Field Values

TOPOLOGY_ERROR_THROTTLE_INTERVAL_SECS_SCHEMA

public static final Object TOPOLOGY_ERROR_THROTTLE_INTERVAL_SECS_SCHEMA

TOPOLOGY_MAX_ERROR_REPORT_PER_INTERVAL

public static final String TOPOLOGY_MAX_ERROR_REPORT_PER_INTERVAL

See doc for TOPOLOGY_ERROR_THROTTLE_INTERVAL_SECS

See Also:

Constant Field Values

TOPOLOGY_MAX_ERROR_REPORT_PER_INTERVAL_SCHEMA

public static final Object TOPOLOGY_MAX_ERROR_REPORT_PER_INTERVAL_SCHEMA

TOPOLOGY_TRIDENT_BATCH_EMIT_INTERVAL_MILLIS

public static final String TOPOLOGY_TRIDENT_BATCH_EMIT_INTERVAL_MILLIS

How often a batch can be emitted in a Trident topology.

See Also:

Constant Field Values

TOPOLOGY_TRIDENT_BATCH_EMIT_INTERVAL_MILLIS_SCHEMA

public static final Object TOPOLOGY_TRIDENT_BATCH_EMIT_INTERVAL_MILLIS_SCHEMA

TOPOLOGY_NAME

public static final String TOPOLOGY_NAME

Name of the topology. This config is automatically set by Storm when the topology is submitted.

See Also:

Constant Field Values

TOPOLOGY_NAME_SCHEMA

public static final Object TOPOLOGY_NAME_SCHEMA

TOPOLOGY_SHELLBOLT_MAX_PENDING

public static final String TOPOLOGY_SHELLBOLT_MAX_PENDING

Max pending tuples in one ShellBolt

See Also:

Constant Field Values

TOPOLOGY_SHELLBOLT_MAX_PENDING_SCHEMA

public static final Object TOPOLOGY_SHELLBOLT_MAX_PENDING_SCHEMA

TRANSACTIONAL_ZOOKEEPER_ROOT

public static final String TRANSACTIONAL_ZOOKEEPER_ROOT

The root directory in ZooKeeper for metadata about TransactionalSpouts.

See Also:

Constant Field Values

TRANSACTIONAL_ZOOKEEPER_ROOT_SCHEMA

public static final Object TRANSACTIONAL_ZOOKEEPER_ROOT_SCHEMA

TRANSACTIONAL_ZOOKEEPER_SERVERS

public static final String TRANSACTIONAL_ZOOKEEPER_SERVERS

The list of zookeeper servers in which to keep the transactional state. If null (which is default), will use storm.zookeeper.servers

See Also:

Constant Field Values

TRANSACTIONAL_ZOOKEEPER_SERVERS_SCHEMA

public static final Object TRANSACTIONAL_ZOOKEEPER_SERVERS_SCHEMA

TRANSACTIONAL_ZOOKEEPER_PORT

public static final String TRANSACTIONAL_ZOOKEEPER_PORT

The port to use to connect to the transactional zookeeper servers. If null (which is default), will use storm.zookeeper.port

See Also:

Constant Field Values

TRANSACTIONAL_ZOOKEEPER_PORT_SCHEMA

public static final Object TRANSACTIONAL_ZOOKEEPER_PORT_SCHEMA

ZMQ_THREADS

public static final String ZMQ_THREADS

The number of threads that should be used by the zeromq context in each worker process.

See Also:

Constant Field Values

ZMQ_THREADS_SCHEMA

public static final Object ZMQ_THREADS_SCHEMA

ZMQ_LINGER_MILLIS

public static final String ZMQ_LINGER_MILLIS

How long a connection should retry sending messages to a target host when the connection is closed. This is an advanced configuration and can almost certainly be ignored.

See Also:

Constant Field Values

ZMQ_LINGER_MILLIS_SCHEMA

public static final Object ZMQ_LINGER_MILLIS_SCHEMA

ZMQ_HWM

public static final String ZMQ_HWM

The high water for the ZeroMQ push sockets used for networking. Use this config to prevent buffer explosion on the networking layer.

See Also:

Constant Field Values

ZMQ_HWM_SCHEMA

public static final Object ZMQ_HWM_SCHEMA

JAVA_LIBRARY_PATH

public static final String JAVA_LIBRARY_PATH

This value is passed to spawned JVMs (e.g., Nimbus, Supervisor, and Workers) for the java.library.path value. java.library.path tells the JVM where to look for native libraries. It is necessary to set this config correctly since Storm uses the ZeroMQ and JZMQ native libs.

See Also:

Constant Field Values

JAVA_LIBRARY_PATH_SCHEMA

public static final Object JAVA_LIBRARY_PATH_SCHEMA

DEV_ZOOKEEPER_PATH

public static final String DEV_ZOOKEEPER_PATH

The path to use as the zookeeper dir when running a zookeeper server via "storm dev-zookeeper". This zookeeper instance is only intended for development; it is not a production grade zookeeper setup.

See Also:

Constant Field Values

DEV_ZOOKEEPER_PATH_SCHEMA

public static final Object DEV_ZOOKEEPER_PATH_SCHEMA

ISOLATION_SCHEDULER_MACHINES

public static final String ISOLATION_SCHEDULER_MACHINES

A map from topology name to the number of machines that should be dedicated for that topology. Set storm.scheduler to backtype.storm.scheduler.IsolationScheduler to make use of the isolation scheduler.

See Also:

Constant Field Values

ISOLATION_SCHEDULER_MACHINES_SCHEMA

public static final Object ISOLATION_SCHEDULER_MACHINES_SCHEMA

Constructor Detail

Config

public Config()

Method Detail

setDebug

public static void setDebug(Map conf,
                            boolean isOn)

setDebug

public void setDebug(boolean isOn)

setNumWorkers

public static void setNumWorkers(Map conf,
                                 int workers)

setNumWorkers

public void setNumWorkers(int workers)

setNumAckers

public static void setNumAckers(Map conf,
                                int numExecutors)

setNumAckers

public void setNumAckers(int numExecutors)

setMessageTimeoutSecs

public static void setMessageTimeoutSecs(Map conf,
                                         int secs)

setMessageTimeoutSecs

public void setMessageTimeoutSecs(int secs)

registerSerialization

public static void registerSerialization(Map conf,
                                         Class klass)

registerSerialization

public void registerSerialization(Class klass)

registerSerialization

public static void registerSerialization(Map conf,
                                         Class klass,
                                         Class<? extends com.esotericsoftware.kryo.Serializer> serializerClass)

registerSerialization

public void registerSerialization(Class klass,
                                  Class<? extends com.esotericsoftware.kryo.Serializer> serializerClass)

registerMetricsConsumer

public void registerMetricsConsumer(Class klass,
                                    Object argument,
                                    long parallelismHint)

registerMetricsConsumer

public void registerMetricsConsumer(Class klass,
                                    long parallelismHint)

registerMetricsConsumer

public void registerMetricsConsumer(Class klass)

registerDecorator

public static void registerDecorator(Map conf,
                                     Class<? extends IKryoDecorator> klass)

registerDecorator

public void registerDecorator(Class<? extends IKryoDecorator> klass)

setKryoFactory

public static void setKryoFactory(Map conf,
                                  Class<? extends IKryoFactory> klass)

setKryoFactory

public void setKryoFactory(Class<? extends IKryoFactory> klass)

setSkipMissingKryoRegistrations

public static void setSkipMissingKryoRegistrations(Map conf,
                                                   boolean skip)

setSkipMissingKryoRegistrations

public void setSkipMissingKryoRegistrations(boolean skip)

setMaxTaskParallelism

public static void setMaxTaskParallelism(Map conf,
                                         int max)

setMaxTaskParallelism

public void setMaxTaskParallelism(int max)

setMaxSpoutPending

public static void setMaxSpoutPending(Map conf,
                                      int max)

setMaxSpoutPending

public void setMaxSpoutPending(int max)

setStatsSampleRate

public static void setStatsSampleRate(Map conf,
                                      double rate)

setStatsSampleRate

public void setStatsSampleRate(double rate)

setFallBackOnJavaSerialization

public static void setFallBackOnJavaSerialization(Map conf,
                                                  boolean fallback)

setFallBackOnJavaSerialization

public void setFallBackOnJavaSerialization(boolean fallback)