public class Config extends Config
This class also provides constants for all the configurations possible on a Storm cluster and Storm topology. 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.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
STORM_ZOOKEEPER_CONNECTION_TIMEOUT
The connection timeout for clients to ZooKeeper.
|
static java.lang.String |
STORM_ZOOKEEPER_PORT
The port Storm will use to connect to each of the ZooKeeper servers.
|
static java.lang.String |
STORM_ZOOKEEPER_RETRY_INTERVAL
The interval between retries of a Zookeeper operation.
|
static java.lang.String |
STORM_ZOOKEEPER_RETRY_TIMES
The number of times to retry a Zookeeper operation.
|
static java.lang.String |
STORM_ZOOKEEPER_SERVERS
A list of hosts of ZooKeeper servers used to manage the cluster.
|
static java.lang.String |
STORM_ZOOKEEPER_SESSION_TIMEOUT
The session timeout for clients to ZooKeeper.
|
static java.lang.String |
STORMCOMPAT_TOPOLOGY_AUTO_TASK_HOOKS
---- DO NOT USE -----
This variable is used to rewrite the TOPOLOGY_AUTO_TASK_HOOKS variable.
|
static java.lang.String |
TOPOLOGY_ACKER_EXECUTORS
How many executors to spawn for ackers.
|
static java.lang.String |
TOPOLOGY_AUTO_TASK_HOOKS
A list of task hooks that are automatically added to every spout and bolt in the topology.
|
static java.lang.String |
TOPOLOGY_CAP_TICKET
Cap ticket (if filed) for the topology.
|
static java.lang.String |
TOPOLOGY_DEBUG
When set to true, Storm will log every message that's emitted.
|
static java.lang.String |
TOPOLOGY_ENABLE_MESSAGE_TIMEOUTS
True if Storm should timeout messages or not.
|
static java.lang.String |
TOPOLOGY_ERROR_THROTTLE_INTERVAL_SECS
The interval in seconds to use for determining whether to throttle error reported to Zookeeper.
|
static java.lang.String |
TOPOLOGY_FALL_BACK_ON_JAVA_SERIALIZATION
Whether or not to use Java serialization in a topology.
|
static java.lang.String |
TOPOLOGY_KRYO_DECORATORS
A list of classes that customize storm's kryo instance during start-up.
|
static java.lang.String |
TOPOLOGY_KRYO_FACTORY
Class that specifies how to create a Kryo instance for serialization.
|
static java.lang.String |
TOPOLOGY_KRYO_REGISTER
A list of serialization registrations for Kryo ( http://code.google.com/p/kryo/ ),
the underlying serialization framework for Storm.
|
static java.lang.String |
TOPOLOGY_MAX_ERROR_REPORT_PER_INTERVAL
See doc for TOPOLOGY_ERROR_THROTTLE_INTERVAL_SECS.
|
static java.lang.String |
TOPOLOGY_MAX_SPOUT_PENDING
The maximum number of tuples that can be pending on a spout task at any given time.
|
static java.lang.String |
TOPOLOGY_MAX_TASK_PARALLELISM
The maximum parallelism allowed for a component in this topology.
|
static java.lang.String |
TOPOLOGY_MESSAGE_TIMEOUT_SECS
The maximum amount of time given to the topology to fully process a message
emitted by a spout.
|
static java.lang.String |
TOPOLOGY_METRICS_CONSUMER_REGISTER |
static java.lang.String |
TOPOLOGY_NAME
Name of the topology.
|
static java.lang.String |
TOPOLOGY_OPTIMIZE
Whether or not the master should optimize topologies by running multiple
tasks in a single thread where appropriate.
|
static java.lang.String |
TOPOLOGY_PROJECT_NAME
Project name of the topology, to help us with tagging which topologies are part of which
project.
|
static java.lang.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 java.lang.String |
TOPOLOGY_SLEEP_SPOUT_WAIT_STRATEGY_TIME_MS
The amount of milliseconds the SleepEmptyEmitStrategy should sleep for.
|
static java.lang.String |
TOPOLOGY_SPOUT_WAIT_STRATEGY
A class that implements a strategy for what to do when a spout needs to wait.
|
static java.lang.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 java.lang.String |
TOPOLOGY_STATS_SAMPLE_RATE
The percentage of tuples to sample to produce stats for a task.
|
static java.lang.String |
TOPOLOGY_TASKS
How many instances to create for a spout/bolt.
|
static java.lang.String |
TOPOLOGY_TEAM_EMAIL
Email of the team which owns this topology.
|
static java.lang.String |
TOPOLOGY_TEAM_NAME
Name of the team which owns this topology.
|
static java.lang.String |
TOPOLOGY_TICK_TUPLE_FREQ_SECS
How often a tick tuple from the "__system" component and "__tick" stream should be sent
to tasks.
|
static java.lang.String |
TOPOLOGY_TRANSACTIONAL_ID
This config is available for TransactionalSpouts, and contains the id ( a String) for
the transactional topology.
|
static java.lang.String |
TOPOLOGY_WORKER_CHILDOPTS
Topology-specific options for the worker child process.
|
static java.lang.String |
TOPOLOGY_WORKERS
This currently gets translated to TOPOLOGY_STMGRS.
|
static java.lang.String |
TRANSACTIONAL_ZOOKEEPER_PORT
The port to use to connect to the transactional zookeeper servers.
|
static java.lang.String |
TRANSACTIONAL_ZOOKEEPER_ROOT
The root directory in ZooKeeper for metadata about TransactionalSpouts.
|
static java.lang.String |
TRANSACTIONAL_ZOOKEEPER_SERVERS
The list of zookeeper servers in which to keep the transactional state.
|
TOPOLOGY_ADDITIONAL_CLASSPATH, TOPOLOGY_COMPONENT_JVMOPTS, TOPOLOGY_COMPONENT_PARALLELISM, TOPOLOGY_COMPONENT_RAMMAP, TOPOLOGY_CONTAINER_CPU_REQUESTED, TOPOLOGY_CONTAINER_DISK_REQUESTED, TOPOLOGY_CONTAINER_MAX_CPU_HINT, TOPOLOGY_CONTAINER_MAX_DISK_HINT, TOPOLOGY_CONTAINER_MAX_RAM_HINT, TOPOLOGY_CONTAINER_PADDING_PERCENTAGE, TOPOLOGY_CONTAINER_RAM_REQUESTED, TOPOLOGY_ENABLE_ACKING, TOPOLOGY_SERIALIZER_CLASSNAME, TOPOLOGY_STMGRS, TOPOLOGY_UPDATE_DEACTIVATE_WAIT_SECS, TOPOLOGY_UPDATE_REACTIVATE_WAIT_SECS
Constructor and Description |
---|
Config() |
Modifier and Type | Method and Description |
---|---|
void |
registerDecorator(java.lang.Class<? extends IKryoDecorator> klass) |
static void |
registerDecorator(java.util.Map conf,
java.lang.Class<? extends IKryoDecorator> klass) |
void |
registerMetricsConsumer(java.lang.Class klass) |
void |
registerMetricsConsumer(java.lang.Class klass,
long parallelismHint) |
void |
registerMetricsConsumer(java.lang.Class klass,
java.lang.Object argument,
long parallelismHint) |
void |
registerSerialization(java.lang.Class klass) |
void |
registerSerialization(java.lang.Class klass,
java.lang.Class<? extends com.esotericsoftware.kryo.Serializer> serializerClass) |
static void |
registerSerialization(java.util.Map conf,
java.lang.Class klass) |
static void |
registerSerialization(java.util.Map conf,
java.lang.Class klass,
java.lang.Class<? extends com.esotericsoftware.kryo.Serializer> serializerClass) |
void |
setDebug(boolean isOn) |
static void |
setDebug(java.util.Map conf,
boolean isOn) |
void |
setFallBackOnJavaSerialization(boolean fallback) |
static void |
setFallBackOnJavaSerialization(java.util.Map conf,
boolean fallback) |
void |
setKryoFactory(java.lang.Class<? extends IKryoFactory> klass) |
static void |
setKryoFactory(java.util.Map conf,
java.lang.Class<? extends IKryoFactory> klass) |
void |
setMaxSpoutPending(int max) |
static void |
setMaxSpoutPending(java.util.Map conf,
int max) |
void |
setMaxTaskParallelism(int max) |
static void |
setMaxTaskParallelism(java.util.Map conf,
int max) |
void |
setMessageTimeoutSecs(int secs) |
static void |
setMessageTimeoutSecs(java.util.Map conf,
int secs) |
void |
setNumAckers(int numExecutors) |
static void |
setNumAckers(java.util.Map conf,
int numExecutors) |
void |
setNumWorkers(int workers) |
static void |
setNumWorkers(java.util.Map conf,
int workers) |
void |
setOptimize(boolean isOn)
Deprecated.
we don't have optimization
|
void |
setSkipMissingKryoRegistrations(boolean skip) |
static void |
setSkipMissingKryoRegistrations(java.util.Map conf,
boolean skip) |
void |
setStatsSampleRate(double rate) |
static void |
setStatsSampleRate(java.util.Map conf,
double rate) |
static void |
setTeamEmail(java.util.Map conf,
java.lang.String teamEmail) |
void |
setTeamEmail(java.lang.String teamEmail) |
static void |
setTeamName(java.util.Map conf,
java.lang.String teamName) |
void |
setTeamName(java.lang.String teamName) |
static void |
setTopologyCapTicket(java.util.Map conf,
java.lang.String ticket) |
void |
setTopologyCapTicket(java.lang.String ticket) |
static void |
setTopologyProjectName(java.util.Map conf,
java.lang.String project) |
void |
setTopologyProjectName(java.lang.String project) |
addClasspath, getApiVars, getAutoTaskHooks, getAutoTaskHooks, setAutoTaskHooks, setAutoTaskHooks, setComponentJvmOptions, setComponentJvmOptions, setComponentParallelism, setComponentParallelism, setComponentRam, setComponentRam, setComponentRam, setComponentRamMap, setComponentRamMap, setContainerCpuRequested, setContainerCpuRequested, setContainerDiskRequested, setContainerDiskRequested, setContainerDiskRequested, setContainerMaxCpuHint, setContainerMaxCpuHint, setContainerMaxDiskHint, setContainerMaxDiskHint, setContainerMaxRamHint, setContainerMaxRamHint, setContainerPaddingPercentage, setContainerPaddingPercentage, setContainerRamRequested, setContainerRamRequested, setContainerRamRequested, setDebug, setEnableAcking, setEnableAcking, setMaxSpoutPending, setMessageTimeoutSecs, setNumStmgrs, setNumStmgrs, setSerializationClassName, setSerializationClassName, setTeamEmail, setTeamName, setTickTupleFrequency, setTickTupleFrequency, setTopologyCapTicket, setTopologyProjectName, setUpdateDeactivateWaitDuration, setUpdateReactivateWaitDuration
clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values
public static final java.lang.String TOPOLOGY_ENABLE_MESSAGE_TIMEOUTS
public static final java.lang.String TOPOLOGY_OPTIMIZE
public static final java.lang.String TOPOLOGY_TASKS
public static final java.lang.String TOPOLOGY_KRYO_REGISTER
See Kryo's documentation for more information about writing custom serializers. Same in Heron.
public static final java.lang.String TOPOLOGY_KRYO_DECORATORS
public static final java.lang.String TOPOLOGY_KRYO_FACTORY
public static final java.lang.String TOPOLOGY_SKIP_MISSING_KRYO_REGISTRATIONS
public static final java.lang.String TOPOLOGY_STATE_SYNCHRONIZATION_TIMEOUT_SECS
public static final java.lang.String TOPOLOGY_FALL_BACK_ON_JAVA_SERIALIZATION
public static final java.lang.String TOPOLOGY_WORKER_CHILDOPTS
public static final java.lang.String TOPOLOGY_TRANSACTIONAL_ID
public static final java.lang.String TOPOLOGY_TICK_TUPLE_FREQ_SECS
public static final java.lang.String TOPOLOGY_ERROR_THROTTLE_INTERVAL_SECS
public static final java.lang.String TOPOLOGY_MAX_ERROR_REPORT_PER_INTERVAL
public static final java.lang.String TOPOLOGY_DEBUG
public static final java.lang.String TOPOLOGY_WORKERS
public static final java.lang.String TOPOLOGY_ACKER_EXECUTORS
If this is set to 0, then Storm will immediately ack tuples as soon as they come off the spout, effectively disabling reliability. In Heron any values of > 0 means to enable acking.
public static final java.lang.String TOPOLOGY_MESSAGE_TIMEOUT_SECS
public static final java.lang.String TOPOLOGY_METRICS_CONSUMER_REGISTER
public static final java.lang.String TOPOLOGY_MAX_TASK_PARALLELISM
public static final java.lang.String TOPOLOGY_MAX_SPOUT_PENDING
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. This has same meaning in Heron.
public static final java.lang.String TOPOLOGY_SPOUT_WAIT_STRATEGY
1. nextTuple emits no tuples 2. The spout has hit maxSpoutPending and can't emit any more tuples This is not yet implemented in Heron.
public static final java.lang.String TOPOLOGY_SLEEP_SPOUT_WAIT_STRATEGY_TIME_MS
public static final java.lang.String TOPOLOGY_STATS_SAMPLE_RATE
public static final java.lang.String TOPOLOGY_AUTO_TASK_HOOKS
public static final java.lang.String TOPOLOGY_NAME
public static final java.lang.String TOPOLOGY_TEAM_NAME
public static final java.lang.String TOPOLOGY_TEAM_EMAIL
public static final java.lang.String TOPOLOGY_CAP_TICKET
public static final java.lang.String TOPOLOGY_PROJECT_NAME
public static final java.lang.String STORM_ZOOKEEPER_SERVERS
public static final java.lang.String STORM_ZOOKEEPER_PORT
public static final java.lang.String TRANSACTIONAL_ZOOKEEPER_ROOT
public static final java.lang.String STORM_ZOOKEEPER_SESSION_TIMEOUT
public static final java.lang.String STORM_ZOOKEEPER_CONNECTION_TIMEOUT
public static final java.lang.String STORM_ZOOKEEPER_RETRY_TIMES
public static final java.lang.String STORM_ZOOKEEPER_RETRY_INTERVAL
public static final java.lang.String TRANSACTIONAL_ZOOKEEPER_SERVERS
public static final java.lang.String TRANSACTIONAL_ZOOKEEPER_PORT
public static final java.lang.String STORMCOMPAT_TOPOLOGY_AUTO_TASK_HOOKS
public static void setDebug(java.util.Map conf, boolean isOn)
public static void setTeamName(java.util.Map conf, java.lang.String teamName)
public static void setTeamEmail(java.util.Map conf, java.lang.String teamEmail)
public static void setTopologyCapTicket(java.util.Map conf, java.lang.String ticket)
public static void setTopologyProjectName(java.util.Map conf, java.lang.String project)
public static void setNumWorkers(java.util.Map conf, int workers)
public static void setNumAckers(java.util.Map conf, int numExecutors)
public static void setMessageTimeoutSecs(java.util.Map conf, int secs)
public static void registerSerialization(java.util.Map conf, java.lang.Class klass)
public static void registerSerialization(java.util.Map conf, java.lang.Class klass, java.lang.Class<? extends com.esotericsoftware.kryo.Serializer> serializerClass)
public static void registerDecorator(java.util.Map conf, java.lang.Class<? extends IKryoDecorator> klass)
public static void setKryoFactory(java.util.Map conf, java.lang.Class<? extends IKryoFactory> klass)
public static void setSkipMissingKryoRegistrations(java.util.Map conf, boolean skip)
public static void setMaxTaskParallelism(java.util.Map conf, int max)
public static void setMaxSpoutPending(java.util.Map conf, int max)
public static void setStatsSampleRate(java.util.Map conf, double rate)
public static void setFallBackOnJavaSerialization(java.util.Map conf, boolean fallback)
public void setTeamName(java.lang.String teamName)
setTeamName
in class Config
public void setTeamEmail(java.lang.String teamEmail)
setTeamEmail
in class Config
public void setTopologyCapTicket(java.lang.String ticket)
setTopologyCapTicket
in class Config
public void setTopologyProjectName(java.lang.String project)
setTopologyProjectName
in class Config
@Deprecated public void setOptimize(boolean isOn)
isOn
- public void setNumWorkers(int workers)
public void setNumAckers(int numExecutors)
public void setMessageTimeoutSecs(int secs)
setMessageTimeoutSecs
in class Config
public void registerSerialization(java.lang.Class klass)
public void registerSerialization(java.lang.Class klass, java.lang.Class<? extends com.esotericsoftware.kryo.Serializer> serializerClass)
public void registerMetricsConsumer(java.lang.Class klass, java.lang.Object argument, long parallelismHint)
public void registerMetricsConsumer(java.lang.Class klass, long parallelismHint)
public void registerMetricsConsumer(java.lang.Class klass)
public void registerDecorator(java.lang.Class<? extends IKryoDecorator> klass)
public void setKryoFactory(java.lang.Class<? extends IKryoFactory> klass)
public void setSkipMissingKryoRegistrations(boolean skip)
public void setMaxTaskParallelism(int max)
public void setMaxSpoutPending(int max)
setMaxSpoutPending
in class Config
public void setStatsSampleRate(double rate)
public void setFallBackOnJavaSerialization(boolean fallback)