http://git-wip-us.apache.org/repos/asf/storm/blob/1d09012e/_site/documentation/Common-patterns.html ---------------------------------------------------------------------- diff --git a/_site/documentation/Common-patterns.html b/_site/documentation/Common-patterns.html new file mode 100644 index 0000000..0b9aa4d --- /dev/null +++ b/_site/documentation/Common-patterns.html @@ -0,0 +1,235 @@ +<!DOCTYPE html> +<html> + <head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + + <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon"> + <link rel="icon" href="/favicon.ico" type="image/x-icon"> + + <title>Common Topology Patterns</title> + + <!-- Bootstrap core CSS --> + <link href="/assets/css/bootstrap.min.css" rel="stylesheet"> + <!-- Bootstrap theme --> + <link href="/assets/css/bootstrap-theme.min.css" rel="stylesheet"> + + <!-- Custom styles for this template --> + <link rel="stylesheet" href="http://fortawesome.github.io/Font-Awesome/assets/font-awesome/css/font-awesome.css";> + <link href="/css/style.css" rel="stylesheet"> + <link href="/assets/css/owl.theme.css" rel="stylesheet"> + <link href="/assets/css/owl.carousel.css" rel="stylesheet"> + <script type="text/javascript" src="/assets/js/jquery.min.js"></script> + <script type="text/javascript" src="/assets/js/bootstrap.min.js"></script> + <script type="text/javascript" src="/assets/js/owl.carousel.min.js"></script> + <script type="text/javascript" src="/assets/js/storm.js"></script> + <!-- Just for debugging purposes. Don't actually copy these 2 lines! --> + <!--[if lt IE 9]><script src="../../assets/js/ie8-responsive-file-warning.js"></script><![endif]--> + + <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js";></script> + <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script> + <![endif]--> + </head> + + + <body> + <header> + <div class="container-fluid"> + <div class="row"> + <div class="col-md-10"> + <a href="/index.html"><img src="/images/logo.png" class="logo" /></a> + </div> + <div class="col-md-2"> + <a href="/downloads.html" class="btn-std btn-block btn-download">Download</a> + </div> + </div> + </div> +</header> +<!--Header End--> +<!--Navigation Begin--> +<div class="navbar" role="banner"> + <div class="container-fluid"> + <div class="navbar-header"> + <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bs-navbar-collapse"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + </div> + <nav class="collapse navbar-collapse bs-navbar-collapse" role="navigation"> + <ul class="nav navbar-nav"> + <li><a href="/index.html" id="home">Home</a></li> + <li><a href="/getting-help.html" id="getting-help">Getting Help</a></li> + <li><a href="/about/integrates.html" id="project-info">Project Information</a></li> + <li><a href="/documentation.html" id="documentation">Documentation</a></li> + <li><a href="/talksAndVideos.html">Talks and Slideshows</a></li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" id="contribute">Contribute <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="/contribute/Contributing-to-Storm.html">Getting Started</a></li> + <li><a href="/contribute/BYLAWS.html">ByLaws</a></li> + </ul> + </li> + <li><a href="/2015/06/15/storm0100-beta-released.html" id="news">News</a></li> + </ul> + </nav> + </div> +</div> + + + + <div class="container-fluid"> + <h1 class="page-title">Common Topology Patterns</h1> + <div class="row"> + <div class="col-md-12"> + <!-- Documentation --> + +<p class="post-meta"></p> + +<p>This page lists a variety of common patterns in Storm topologies.</p> + +<ol> +<li>Streaming joins</li> +<li>Batching</li> +<li>BasicBolt</li> +<li>In-memory caching + fields grouping combo</li> +<li>Streaming top N</li> +<li>TimeCacheMap for efficiently keeping a cache of things that have been recently updated</li> +<li>CoordinatedBolt and KeyedFairBolt for Distributed RPC</li> +</ol> + +<h3 id="joins">Joins</h3> + +<p>A streaming join combines two or more data streams together based on some common field. Whereas a normal database join has finite input and clear semantics for a join, a streaming join has infinite input and unclear semantics for what a join should be.</p> + +<p>The join type you need will vary per application. Some applications join all tuples for two streams over a finite window of time, whereas other applications expect exactly one tuple for each side of the join for each join field. Other applications may do the join completely differently. The common pattern among all these join types is partitioning multiple input streams in the same way. This is easily accomplished in Storm by using a fields grouping on the same fields for many input streams to the joiner bolt. For example:</p> +<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="n">builder</span><span class="o">.</span><span class="na">setBolt</span><span class="o">(</span><span class="s">"join"</span><span class="o">,</span> <span class="k">new</span> <span class="nf">MyJoiner</span><span class="o">(),</span> <span class="n">parallelism</span><span class="o">)</span> + <span class="o">.</span><span class="na">fieldsGrouping</span><span class="o">(</span><span class="s">"1"</span><span class="o">,</span> <span class="k">new</span> <span class="nf">Fields</span><span class="o">(</span><span class="s">"joinfield1"</span><span class="o">,</span> <span class="s">"joinfield2"</span><span class="o">))</span> + <span class="o">.</span><span class="na">fieldsGrouping</span><span class="o">(</span><span class="s">"2"</span><span class="o">,</span> <span class="k">new</span> <span class="nf">Fields</span><span class="o">(</span><span class="s">"joinfield1"</span><span class="o">,</span> <span class="s">"joinfield2"</span><span class="o">))</span> + <span class="o">.</span><span class="na">fieldsGrouping</span><span class="o">(</span><span class="s">"3"</span><span class="o">,</span> <span class="k">new</span> <span class="nf">Fields</span><span class="o">(</span><span class="s">"joinfield1"</span><span class="o">,</span> <span class="s">"joinfield2"</span><span class="o">));</span> +</code></pre></div> +<p>The different streams don't have to have the same field names, of course.</p> + +<h3 id="batching">Batching</h3> + +<p>Oftentimes for efficiency reasons or otherwise, you want to process a group of tuples in batch rather than individually. For example, you may want to batch updates to a database or do a streaming aggregation of some sort.</p> + +<p>If you want reliability in your data processing, the right way to do this is to hold on to tuples in an instance variable while the bolt waits to do the batching. Once you do the batch operation, you then ack all the tuples you were holding onto.</p> + +<p>If the bolt emits tuples, then you may want to use multi-anchoring to ensure reliability. It all depends on the specific application. See <a href="Guaranteeing-message-processing.html">Guaranteeing message processing</a> for more details on how reliability works.</p> + +<h3 id="basicbolt">BasicBolt</h3> + +<p>Many bolts follow a similar pattern of reading an input tuple, emitting zero or more tuples based on that input tuple, and then acking that input tuple immediately at the end of the execute method. Bolts that match this pattern are things like functions and filters. This is such a common pattern that Storm exposes an interface called <a href="/javadoc/apidocs/backtype/storm/topology/IBasicBolt.html">IBasicBolt</a> that automates this pattern for you. See <a href="Guaranteeing-message-processing.html">Guaranteeing message processing</a> for more information.</p> + +<h3 id="in-memory-caching-+-fields-grouping-combo">In-memory caching + fields grouping combo</h3> + +<p>It's common to keep caches in-memory in Storm bolts. Caching becomes particularly powerful when you combine it with a fields grouping. For example, suppose you have a bolt that expands short URLs (like bit.ly, t.co, etc.) into long URLs. You can increase performance by keeping an LRU cache of short URL to long URL expansions to avoid doing the same HTTP requests over and over. Suppose component "urls" emits short URLS, and component "expand" expands short URLs into long URLs and keeps a cache internally. Consider the difference between the two following snippets of code:</p> +<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="n">builder</span><span class="o">.</span><span class="na">setBolt</span><span class="o">(</span><span class="s">"expand"</span><span class="o">,</span> <span class="k">new</span> <span class="nf">ExpandUrl</span><span class="o">(),</span> <span class="n">parallelism</span><span class="o">)</span> + <span class="o">.</span><span class="na">shuffleGrouping</span><span class="o">(</span><span class="mi">1</span><span class="o">);</span> +</code></pre></div><div class="highlight"><pre><code class="language-java" data-lang="java"><span class="n">builder</span><span class="o">.</span><span class="na">setBolt</span><span class="o">(</span><span class="s">"expand"</span><span class="o">,</span> <span class="k">new</span> <span class="nf">ExpandUrl</span><span class="o">(),</span> <span class="n">parallelism</span><span class="o">)</span> + <span class="o">.</span><span class="na">fieldsGrouping</span><span class="o">(</span><span class="s">"urls"</span><span class="o">,</span> <span class="k">new</span> <span class="nf">Fields</span><span class="o">(</span><span class="s">"url"</span><span class="o">));</span> +</code></pre></div> +<p>The second approach will have vastly more effective caches, since the same URL will always go to the same task. This avoids having duplication across any of the caches in the tasks and makes it much more likely that a short URL will hit the cache.</p> + +<h3 id="streaming-top-n">Streaming top N</h3> + +<p>A common continuous computation done on Storm is a "streaming top N" of some sort. Suppose you have a bolt that emits tuples of the form ["value", "count"] and you want a bolt that emits the top N tuples based on count. The simplest way to do this is to have a bolt that does a global grouping on the stream and maintains a list in memory of the top N items.</p> + +<p>This approach obviously doesn't scale to large streams since the entire stream has to go through one task. A better way to do the computation is to do many top N's in parallel across partitions of the stream, and then merge those top N's together to get the global top N. The pattern looks like this:</p> +<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="n">builder</span><span class="o">.</span><span class="na">setBolt</span><span class="o">(</span><span class="s">"rank"</span><span class="o">,</span> <span class="k">new</span> <span class="nf">RankObjects</span><span class="o">(),</span> <span class="n">parallelism</span><span class="o">)</span> + <span class="o">.</span><span class="na">fieldsGrouping</span><span class="o">(</span><span class="s">"objects"</span><span class="o">,</span> <span class="k">new</span> <span class="nf">Fields</span><span class="o">(</span><span class="s">"value"</span><span class="o">));</span> +<span class="n">builder</span><span class="o">.</span><span class="na">setBolt</span><span class="o">(</span><span class="s">"merge"</span><span class="o">,</span> <span class="k">new</span> <span class="nf">MergeObjects</span><span class="o">())</span> + <span class="o">.</span><span class="na">globalGrouping</span><span class="o">(</span><span class="s">"rank"</span><span class="o">);</span> +</code></pre></div> +<p>This pattern works because of the fields grouping done by the first bolt which gives the partitioning you need for this to be semantically correct. You can see an example of this pattern in storm-starter <a href="https://github.com/apache/storm/blob/master/examples/storm-starter/src/jvm/storm/starter/RollingTopWords.java";>here</a>.</p> + +<p>If however you have a known skew in the data being processed it can be advantageous to use partialKeyGrouping instead of fieldsGrouping. This will distribute the load for each key between two downstream bolts instead of a single one.</p> +<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="n">builder</span><span class="o">.</span><span class="na">setBolt</span><span class="o">(</span><span class="s">"count"</span><span class="o">,</span> <span class="k">new</span> <span class="nf">CountObjects</span><span class="o">(),</span> <span class="n">parallelism</span><span class="o">)</span> + <span class="o">.</span><span class="na">partialKeyGrouping</span><span class="o">(</span><span class="s">"objects"</span><span class="o">,</span> <span class="k">new</span> <span class="nf">Fields</span><span class="o">(</span><span class="s">"value"</span><span class="o">));</span> +<span class="n">builder</span><span class="o">.</span><span class="na">setBolt</span><span class="o">(</span><span class="s">"rank"</span> <span class="k">new</span> <span class="nf">AggregateCountsAndRank</span><span class="o">(),</span> <span class="n">parallelism</span><span class="o">)</span> + <span class="o">.</span><span class="na">fieldsGrouping</span><span class="o">(</span><span class="s">"count"</span><span class="o">,</span> <span class="k">new</span> <span class="nf">Fields</span><span class="o">(</span><span class="s">"key"</span><span class="o">))</span> +<span class="n">builder</span><span class="o">.</span><span class="na">setBolt</span><span class="o">(</span><span class="s">"merge"</span><span class="o">,</span> <span class="k">new</span> <span class="nf">MergeRanksObjects</span><span class="o">())</span> + <span class="o">.</span><span class="na">globalGrouping</span><span class="o">(</span><span class="s">"rank"</span><span class="o">);</span> +</code></pre></div> +<p>The topology needs an extra layer of processing to aggregate the partial counts from the upstream bolts but this only processes aggregated values now so the bolt it is not subject to the load caused by the skewed data. You can see an example of this pattern in storm-starter <a href="https://github.com/apache/storm/blob/master/examples/storm-starter/src/jvm/storm/starter/SkewedRollingTopWords.java";>here</a>.</p> + +<h3 id="timecachemap-for-efficiently-keeping-a-cache-of-things-that-have-been-recently-updated">TimeCacheMap for efficiently keeping a cache of things that have been recently updated</h3> + +<p>You sometimes want to keep a cache in memory of items that have been recently "active" and have items that have been inactive for some time be automatically expires. <a href="/javadoc/apidocs/backtype/storm/utils/TimeCacheMap.html">TimeCacheMap</a> is an efficient data structure for doing this and provides hooks so you can insert callbacks whenever an item is expired.</p> + +<h3 id="coordinatedbolt-and-keyedfairbolt-for-distributed-rpc">CoordinatedBolt and KeyedFairBolt for Distributed RPC</h3> + +<p>When building distributed RPC applications on top of Storm, there are two common patterns that are usually needed. These are encapsulated by <a href="/javadoc/apidocs/backtype/storm/task/CoordinatedBolt.html">CoordinatedBolt</a> and <a href="/javadoc/apidocs/backtype/storm/task/KeyedFairBolt.html">KeyedFairBolt</a> which are part of the "standard library" that ships with the Storm codebase.</p> + +<p><code>CoordinatedBolt</code> wraps the bolt containing your logic and figures out when your bolt has received all the tuples for any given request. It makes heavy use of direct streams to do this.</p> + +<p><code>KeyedFairBolt</code> also wraps the bolt containing your logic and makes sure your topology processes multiple DRPC invocations at the same time, instead of doing them serially one at a time.</p> + +<p>See <a href="Distributed-RPC.html">Distributed RPC</a> for more details.</p> + + + + </div> + </div> + </div> +<footer> + <div class="container-fluid"> + <div class="row"> + <div class="col-md-3"> + <div class="footer-widget"> + <h5>Meetups</h5> + <ul class="latest-news"> + <li><a href="http://www.meetup.com/Apache-Storm-Apache-Kafka/";>Sunnyvale, CA</a> <span class="small">(10 May 2015)</span></li> + <li><a href="http://www.meetup.com/Apache-Storm-Kafka-Users/";>Seatle, WA</a> <span class="small">(27 Jun 2015)</span></li> + </ul> + </div> + </div> + <div class="col-md-3"> + <div class="footer-widget"> + <h5>About Storm</h5> + <p>Storm integrates with any queueing system and any database system. Storm's spout abstraction makes it easy to integrate a new queuing system. Likewise, integrating Storm with database systems is easy.</p> + </div> + </div> + <div class="col-md-3"> + <div class="footer-widget"> + <h5>First Look</h5> + <ul class="footer-list"> + <li><a href="/documentation/Rationale.html">Rationale</a></li> + <li><a href="/tutorial.html">Tutorial</a></li> + <li><a href="/documentation/Setting-up-development-environment.html">Setting up development environment</a></li> + <li><a href="/documentation/Creating-a-new-Storm-project.html">Creating a new Storm project</a></li> + </ul> + </div> + </div> + <div class="col-md-3"> + <div class="footer-widget"> + <h5>Documentation</h5> + <ul class="footer-list"> + <li><a href="/doc-index.html">Index</a></li> + <li><a href="/documentation.html">Manual</a></li> + <li><a href="https://storm.apache.org/javadoc/apidocs/index.html";>Javadoc</a></li> + <li><a href="/documentation/FAQ.html">FAQ</a></li> + </ul> + </div> + </div> + </div> + <hr/> + <div class="row"> + <div class="col-md-12"> + <p align="center">Copyright © 2015 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved. Apache Storm, Apache, the Apache feather logo, and the Apache Storm project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p> + </div> + </div> + </div> +</footer> +<!--Footer End--> +<!-- Scroll to top --> +<span class="totop"><a href="#"><i class="fa fa-angle-up"></i></a></span> + +</body> + +</html> +
http://git-wip-us.apache.org/repos/asf/storm/blob/1d09012e/_site/documentation/Concepts.html ---------------------------------------------------------------------- diff --git a/_site/documentation/Concepts.html b/_site/documentation/Concepts.html new file mode 100644 index 0000000..42311b4 --- /dev/null +++ b/_site/documentation/Concepts.html @@ -0,0 +1,281 @@ +<!DOCTYPE html> +<html> + <head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + + <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon"> + <link rel="icon" href="/favicon.ico" type="image/x-icon"> + + <title>Concepts</title> + + <!-- Bootstrap core CSS --> + <link href="/assets/css/bootstrap.min.css" rel="stylesheet"> + <!-- Bootstrap theme --> + <link href="/assets/css/bootstrap-theme.min.css" rel="stylesheet"> + + <!-- Custom styles for this template --> + <link rel="stylesheet" href="http://fortawesome.github.io/Font-Awesome/assets/font-awesome/css/font-awesome.css";> + <link href="/css/style.css" rel="stylesheet"> + <link href="/assets/css/owl.theme.css" rel="stylesheet"> + <link href="/assets/css/owl.carousel.css" rel="stylesheet"> + <script type="text/javascript" src="/assets/js/jquery.min.js"></script> + <script type="text/javascript" src="/assets/js/bootstrap.min.js"></script> + <script type="text/javascript" src="/assets/js/owl.carousel.min.js"></script> + <script type="text/javascript" src="/assets/js/storm.js"></script> + <!-- Just for debugging purposes. Don't actually copy these 2 lines! --> + <!--[if lt IE 9]><script src="../../assets/js/ie8-responsive-file-warning.js"></script><![endif]--> + + <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js";></script> + <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script> + <![endif]--> + </head> + + + <body> + <header> + <div class="container-fluid"> + <div class="row"> + <div class="col-md-10"> + <a href="/index.html"><img src="/images/logo.png" class="logo" /></a> + </div> + <div class="col-md-2"> + <a href="/downloads.html" class="btn-std btn-block btn-download">Download</a> + </div> + </div> + </div> +</header> +<!--Header End--> +<!--Navigation Begin--> +<div class="navbar" role="banner"> + <div class="container-fluid"> + <div class="navbar-header"> + <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bs-navbar-collapse"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + </div> + <nav class="collapse navbar-collapse bs-navbar-collapse" role="navigation"> + <ul class="nav navbar-nav"> + <li><a href="/index.html" id="home">Home</a></li> + <li><a href="/getting-help.html" id="getting-help">Getting Help</a></li> + <li><a href="/about/integrates.html" id="project-info">Project Information</a></li> + <li><a href="/documentation.html" id="documentation">Documentation</a></li> + <li><a href="/talksAndVideos.html">Talks and Slideshows</a></li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" id="contribute">Contribute <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="/contribute/Contributing-to-Storm.html">Getting Started</a></li> + <li><a href="/contribute/BYLAWS.html">ByLaws</a></li> + </ul> + </li> + <li><a href="/2015/06/15/storm0100-beta-released.html" id="news">News</a></li> + </ul> + </nav> + </div> +</div> + + + + <div class="container-fluid"> + <h1 class="page-title">Concepts</h1> + <div class="row"> + <div class="col-md-12"> + <!-- Documentation --> + +<p class="post-meta"></p> + +<p>This page lists the main concepts of Storm and links to resources where you can find more information. The concepts discussed are:</p> + +<ol> +<li>Topologies</li> +<li>Streams</li> +<li>Spouts</li> +<li>Bolts</li> +<li>Stream groupings</li> +<li>Reliability</li> +<li>Tasks</li> +<li>Workers</li> +</ol> + +<h3 id="topologies">Topologies</h3> + +<p>The logic for a realtime application is packaged into a Storm topology. A Storm topology is analogous to a MapReduce job. One key difference is that a MapReduce job eventually finishes, whereas a topology runs forever (or until you kill it, of course). A topology is a graph of spouts and bolts that are connected with stream groupings. These concepts are described below.</p> + +<p><strong>Resources:</strong></p> + +<ul> +<li><a href="/javadoc/apidocs/backtype/storm/topology/TopologyBuilder.html">TopologyBuilder</a>: use this class to construct topologies in Java</li> +<li><a href="Running-topologies-on-a-production-cluster.html">Running topologies on a production cluster</a></li> +<li><a href="Local-mode.html">Local mode</a>: Read this to learn how to develop and test topologies in local mode.</li> +</ul> + +<h3 id="streams">Streams</h3> + +<p>The stream is the core abstraction in Storm. A stream is an unbounded sequence of tuples that is processed and created in parallel in a distributed fashion. Streams are defined with a schema that names the fields in the stream's tuples. By default, tuples can contain integers, longs, shorts, bytes, strings, doubles, floats, booleans, and byte arrays. You can also define your own serializers so that custom types can be used natively within tuples.</p> + +<p>Every stream is given an id when declared. Since single-stream spouts and bolts are so common, <a href="/javadoc/apidocs/backtype/storm/topology/OutputFieldsDeclarer.html">OutputFieldsDeclarer</a> has convenience methods for declaring a single stream without specifying an id. In this case, the stream is given the default id of "default".</p> + +<p><strong>Resources:</strong></p> + +<ul> +<li><a href="/javadoc/apidocs/backtype/storm/tuple/Tuple.html">Tuple</a>: streams are composed of tuples</li> +<li><a href="/javadoc/apidocs/backtype/storm/topology/OutputFieldsDeclarer.html">OutputFieldsDeclarer</a>: used to declare streams and their schemas</li> +<li><a href="Serialization.html">Serialization</a>: Information about Storm's dynamic typing of tuples and declaring custom serializations</li> +<li><a href="/javadoc/apidocs/backtype/storm/serialization/ISerialization.html">ISerialization</a>: custom serializers must implement this interface</li> +<li><a href="/javadoc/apidocs/backtype/storm/Config.html#TOPOLOGY_SERIALIZATIONS">CONFIG.TOPOLOGY_SERIALIZATIONS</a>: custom serializers can be registered using this configuration</li> +</ul> + +<h3 id="spouts">Spouts</h3> + +<p>A spout is a source of streams in a topology. Generally spouts will read tuples from an external source and emit them into the topology (e.g. a Kestrel queue or the Twitter API). Spouts can either be <strong>reliable</strong> or <strong>unreliable</strong>. A reliable spout is capable of replaying a tuple if it failed to be processed by Storm, whereas an unreliable spout forgets about the tuple as soon as it is emitted.</p> + +<p>Spouts can emit more than one stream. To do so, declare multiple streams using the <code>declareStream</code> method of <a href="/javadoc/apidocs/backtype/storm/topology/OutputFieldsDeclarer.html">OutputFieldsDeclarer</a> and specify the stream to emit to when using the <code>emit</code> method on <a href="/javadoc/apidocs/backtype/storm/spout/SpoutOutputCollector.html">SpoutOutputCollector</a>.</p> + +<p>The main method on spouts is <code>nextTuple</code>. <code>nextTuple</code> either emits a new tuple into the topology or simply returns if there are no new tuples to emit. It is imperative that <code>nextTuple</code> does not block for any spout implementation, because Storm calls all the spout methods on the same thread.</p> + +<p>The other main methods on spouts are <code>ack</code> and <code>fail</code>. These are called when Storm detects that a tuple emitted from the spout either successfully completed through the topology or failed to be completed. <code>ack</code> and <code>fail</code> are only called for reliable spouts. See <a href="/javadoc/apidocs/backtype/storm/spout/ISpout.html">the Javadoc</a> for more information.</p> + +<p><strong>Resources:</strong></p> + +<ul> +<li><a href="/javadoc/apidocs/backtype/storm/topology/IRichSpout.html">IRichSpout</a>: this is the interface that spouts must implement.</li> +<li><a href="Guaranteeing-message-processing.html">Guaranteeing message processing</a></li> +</ul> + +<h3 id="bolts">Bolts</h3> + +<p>All processing in topologies is done in bolts. Bolts can do anything from filtering, functions, aggregations, joins, talking to databases, and more. </p> + +<p>Bolts can do simple stream transformations. Doing complex stream transformations often requires multiple steps and thus multiple bolts. For example, transforming a stream of tweets into a stream of trending images requires at least two steps: a bolt to do a rolling count of retweets for each image, and one or more bolts to stream out the top X images (you can do this particular stream transformation in a more scalable way with three bolts than with two). </p> + +<p>Bolts can emit more than one stream. To do so, declare multiple streams using the <code>declareStream</code> method of <a href="/javadoc/apidocs/backtype/storm/topology/OutputFieldsDeclarer.html">OutputFieldsDeclarer</a> and specify the stream to emit to when using the <code>emit</code> method on <a href="/javadoc/apidocs/backtype/storm/task/OutputCollector.html">OutputCollector</a>.</p> + +<p>When you declare a bolt's input streams, you always subscribe to specific streams of another component. If you want to subscribe to all the streams of another component, you have to subscribe to each one individually. <a href="/javadoc/apidocs/backtype/storm/topology/InputDeclarer.html">InputDeclarer</a> has syntactic sugar for subscribing to streams declared on the default stream id. Saying <code>declarer.shuffleGrouping("1")</code> subscribes to the default stream on component "1" and is equivalent to <code>declarer.shuffleGrouping("1", DEFAULT_STREAM_ID)</code>.</p> + +<p>The main method in bolts is the <code>execute</code> method which takes in as input a new tuple. Bolts emit new tuples using the <a href="/javadoc/apidocs/backtype/storm/task/OutputCollector.html">OutputCollector</a> object. Bolts must call the <code>ack</code> method on the <code>OutputCollector</code> for every tuple they process so that Storm knows when tuples are completed (and can eventually determine that its safe to ack the original spout tuples). For the common case of processing an input tuple, emitting 0 or more tuples based on that tuple, and then acking the input tuple, Storm provides an <a href="/javadoc/apidocs/backtype/storm/topology/IBasicBolt.html">IBasicBolt</a> interface which does the acking automatically.</p> + +<p>Please note that <a href="/javadoc/apidocs/backtype/storm/task/OutputCollector.html">OutputCollector</a> is not thread-safe, and all emits, acks, and fails must happen on the same thread. Please refer <a href="Troubleshooting.html">Troubleshooting</a> for more details.</p> + +<p><strong>Resources:</strong></p> + +<ul> +<li><a href="/javadoc/apidocs/backtype/storm/topology/IRichBolt.html">IRichBolt</a>: this is general interface for bolts.</li> +<li><a href="/javadoc/apidocs/backtype/storm/topology/IBasicBolt.html">IBasicBolt</a>: this is a convenience interface for defining bolts that do filtering or simple functions.</li> +<li><a href="/javadoc/apidocs/backtype/storm/task/OutputCollector.html">OutputCollector</a>: bolts emit tuples to their output streams using an instance of this class</li> +<li><a href="Guaranteeing-message-processing.html">Guaranteeing message processing</a></li> +</ul> + +<h3 id="stream-groupings">Stream groupings</h3> + +<p>Part of defining a topology is specifying for each bolt which streams it should receive as input. A stream grouping defines how that stream should be partitioned among the bolt's tasks.</p> + +<p>There are eight built-in stream groupings in Storm, and you can implement a custom stream grouping by implementing the <a href="/javadoc/apidocs/backtype/storm/grouping/CustomStreamGrouping.html">CustomStreamGrouping</a> interface:</p> + +<ol> +<li><strong>Shuffle grouping</strong>: Tuples are randomly distributed across the bolt's tasks in a way such that each bolt is guaranteed to get an equal number of tuples.</li> +<li><strong>Fields grouping</strong>: The stream is partitioned by the fields specified in the grouping. For example, if the stream is grouped by the "user-id" field, tuples with the same "user-id" will always go to the same task, but tuples with different "user-id"'s may go to different tasks.</li> +<li><strong>Partial Key grouping</strong>: The stream is partitioned by the fields specified in the grouping, like the Fields grouping, but are load balanced between two downstream bolts, which provides better utilization of resources when the incoming data is skewed. <a href="https://melmeric.files.wordpress.com/2014/11/the-power-of-both-choices-practical-load-balancing-for-distributed-stream-processing-engines.pdf";>This paper</a> provides a good explanation of how it works and the advantages it provides.</li> +<li><strong>All grouping</strong>: The stream is replicated across all the bolt's tasks. Use this grouping with care.</li> +<li><strong>Global grouping</strong>: The entire stream goes to a single one of the bolt's tasks. Specifically, it goes to the task with the lowest id.</li> +<li><strong>None grouping</strong>: This grouping specifies that you don't care how the stream is grouped. Currently, none groupings are equivalent to shuffle groupings. Eventually though, Storm will push down bolts with none groupings to execute in the same thread as the bolt or spout they subscribe from (when possible).</li> +<li><strong>Direct grouping</strong>: This is a special kind of grouping. A stream grouped this way means that the <strong>producer</strong> of the tuple decides which task of the consumer will receive this tuple. Direct groupings can only be declared on streams that have been declared as direct streams. Tuples emitted to a direct stream must be emitted using one of the <a href="https://storm.apache.org/javadoc/apidocs/backtype/storm/task/OutputCollector.html#emitDirect-int-java.util.Collection-java.util.List-";>emitDirect</a> methods. A bolt can get the task ids of its consumers by either using the provided <a href="/javadoc/apidocs/backtype/storm/task/TopologyContext.html">TopologyContext</a> or by keeping track of the output of the <code>emit</code> method in <a href="/javadoc/apidocs/backtype/storm/task/OutputCollector.html">OutputCollector</a> (which returns the task ids that the tuple was sent to).</li> +<li><strong>Local or shuffle grouping</strong>: If the target bolt has one or more tasks in the same worker process, tuples will be shuffled to just those in-process tasks. Otherwise, this acts like a normal shuffle grouping.</li> +</ol> + +<p><strong>Resources:</strong></p> + +<ul> +<li><a href="/javadoc/apidocs/backtype/storm/topology/TopologyBuilder.html">TopologyBuilder</a>: use this class to define topologies</li> +<li><a href="/javadoc/apidocs/backtype/storm/topology/InputDeclarer.html">InputDeclarer</a>: this object is returned whenever <code>setBolt</code> is called on <code>TopologyBuilder</code> and is used for declaring a bolt's input streams and how those streams should be grouped</li> +<li><a href="/javadoc/apidocs/backtype/storm/task/CoordinatedBolt.html">CoordinatedBolt</a>: this bolt is useful for distributed RPC topologies and makes heavy use of direct streams and direct groupings</li> +</ul> + +<h3 id="reliability">Reliability</h3> + +<p>Storm guarantees that every spout tuple will be fully processed by the topology. It does this by tracking the tree of tuples triggered by every spout tuple and determining when that tree of tuples has been successfully completed. Every topology has a "message timeout" associated with it. If Storm fails to detect that a spout tuple has been completed within that timeout, then it fails the tuple and replays it later. </p> + +<p>To take advantage of Storm's reliability capabilities, you must tell Storm when new edges in a tuple tree are being created and tell Storm whenever you've finished processing an individual tuple. These are done using the <a href="/javadoc/apidocs/backtype/storm/task/OutputCollector.html">OutputCollector</a> object that bolts use to emit tuples. Anchoring is done in the <code>emit</code> method, and you declare that you're finished with a tuple using the <code>ack</code> method.</p> + +<p>This is all explained in much more detail in <a href="Guaranteeing-message-processing.html">Guaranteeing message processing</a>. </p> + +<h3 id="tasks">Tasks</h3> + +<p>Each spout or bolt executes as many tasks across the cluster. Each task corresponds to one thread of execution, and stream groupings define how to send tuples from one set of tasks to another set of tasks. You set the parallelism for each spout or bolt in the <code>setSpout</code> and <code>setBolt</code> methods of <a href="/javadoc/apidocs/backtype/storm/topology/TopologyBuilder.html">TopologyBuilder</a>.</p> + +<h3 id="workers">Workers</h3> + +<p>Topologies execute across one or more worker processes. Each worker process is a physical JVM and executes a subset of all the tasks for the topology. For example, if the combined parallelism of the topology is 300 and 50 workers are allocated, then each worker will execute 6 tasks (as threads within the worker). Storm tries to spread the tasks evenly across all the workers.</p> + +<p><strong>Resources:</strong></p> + +<ul> +<li><a href="/javadoc/apidocs/backtype/storm/Config.html#TOPOLOGY_WORKERS">Config.TOPOLOGY_WORKERS</a>: this config sets the number of workers to allocate for executing the topology</li> +</ul> + + + + </div> + </div> + </div> +<footer> + <div class="container-fluid"> + <div class="row"> + <div class="col-md-3"> + <div class="footer-widget"> + <h5>Meetups</h5> + <ul class="latest-news"> + <li><a href="http://www.meetup.com/Apache-Storm-Apache-Kafka/";>Sunnyvale, CA</a> <span class="small">(10 May 2015)</span></li> + <li><a href="http://www.meetup.com/Apache-Storm-Kafka-Users/";>Seatle, WA</a> <span class="small">(27 Jun 2015)</span></li> + </ul> + </div> + </div> + <div class="col-md-3"> + <div class="footer-widget"> + <h5>About Storm</h5> + <p>Storm integrates with any queueing system and any database system. Storm's spout abstraction makes it easy to integrate a new queuing system. Likewise, integrating Storm with database systems is easy.</p> + </div> + </div> + <div class="col-md-3"> + <div class="footer-widget"> + <h5>First Look</h5> + <ul class="footer-list"> + <li><a href="/documentation/Rationale.html">Rationale</a></li> + <li><a href="/tutorial.html">Tutorial</a></li> + <li><a href="/documentation/Setting-up-development-environment.html">Setting up development environment</a></li> + <li><a href="/documentation/Creating-a-new-Storm-project.html">Creating a new Storm project</a></li> + </ul> + </div> + </div> + <div class="col-md-3"> + <div class="footer-widget"> + <h5>Documentation</h5> + <ul class="footer-list"> + <li><a href="/doc-index.html">Index</a></li> + <li><a href="/documentation.html">Manual</a></li> + <li><a href="https://storm.apache.org/javadoc/apidocs/index.html";>Javadoc</a></li> + <li><a href="/documentation/FAQ.html">FAQ</a></li> + </ul> + </div> + </div> + </div> + <hr/> + <div class="row"> + <div class="col-md-12"> + <p align="center">Copyright © 2015 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved. Apache Storm, Apache, the Apache feather logo, and the Apache Storm project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p> + </div> + </div> + </div> +</footer> +<!--Footer End--> +<!-- Scroll to top --> +<span class="totop"><a href="#"><i class="fa fa-angle-up"></i></a></span> + +</body> + +</html> + http://git-wip-us.apache.org/repos/asf/storm/blob/1d09012e/_site/documentation/Configuration.html ---------------------------------------------------------------------- diff --git a/_site/documentation/Configuration.html b/_site/documentation/Configuration.html new file mode 100644 index 0000000..7e2bcb0 --- /dev/null +++ b/_site/documentation/Configuration.html @@ -0,0 +1,185 @@ +<!DOCTYPE html> +<html> + <head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + + <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon"> + <link rel="icon" href="/favicon.ico" type="image/x-icon"> + + <title>Configuration</title> + + <!-- Bootstrap core CSS --> + <link href="/assets/css/bootstrap.min.css" rel="stylesheet"> + <!-- Bootstrap theme --> + <link href="/assets/css/bootstrap-theme.min.css" rel="stylesheet"> + + <!-- Custom styles for this template --> + <link rel="stylesheet" href="http://fortawesome.github.io/Font-Awesome/assets/font-awesome/css/font-awesome.css";> + <link href="/css/style.css" rel="stylesheet"> + <link href="/assets/css/owl.theme.css" rel="stylesheet"> + <link href="/assets/css/owl.carousel.css" rel="stylesheet"> + <script type="text/javascript" src="/assets/js/jquery.min.js"></script> + <script type="text/javascript" src="/assets/js/bootstrap.min.js"></script> + <script type="text/javascript" src="/assets/js/owl.carousel.min.js"></script> + <script type="text/javascript" src="/assets/js/storm.js"></script> + <!-- Just for debugging purposes. Don't actually copy these 2 lines! --> + <!--[if lt IE 9]><script src="../../assets/js/ie8-responsive-file-warning.js"></script><![endif]--> + + <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js";></script> + <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script> + <![endif]--> + </head> + + + <body> + <header> + <div class="container-fluid"> + <div class="row"> + <div class="col-md-10"> + <a href="/index.html"><img src="/images/logo.png" class="logo" /></a> + </div> + <div class="col-md-2"> + <a href="/downloads.html" class="btn-std btn-block btn-download">Download</a> + </div> + </div> + </div> +</header> +<!--Header End--> +<!--Navigation Begin--> +<div class="navbar" role="banner"> + <div class="container-fluid"> + <div class="navbar-header"> + <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bs-navbar-collapse"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + </div> + <nav class="collapse navbar-collapse bs-navbar-collapse" role="navigation"> + <ul class="nav navbar-nav"> + <li><a href="/index.html" id="home">Home</a></li> + <li><a href="/getting-help.html" id="getting-help">Getting Help</a></li> + <li><a href="/about/integrates.html" id="project-info">Project Information</a></li> + <li><a href="/documentation.html" id="documentation">Documentation</a></li> + <li><a href="/talksAndVideos.html">Talks and Slideshows</a></li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" id="contribute">Contribute <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="/contribute/Contributing-to-Storm.html">Getting Started</a></li> + <li><a href="/contribute/BYLAWS.html">ByLaws</a></li> + </ul> + </li> + <li><a href="/2015/06/15/storm0100-beta-released.html" id="news">News</a></li> + </ul> + </nav> + </div> +</div> + + + + <div class="container-fluid"> + <h1 class="page-title">Configuration</h1> + <div class="row"> + <div class="col-md-12"> + <!-- Documentation --> + +<p class="post-meta"></p> + +<p>Storm has a variety of configurations for tweaking the behavior of nimbus, supervisors, and running topologies. Some configurations are system configurations and cannot be modified on a topology by topology basis, whereas other configurations can be modified per topology. </p> + +<p>Every configuration has a default value defined in <a href="https://github.com/apache/storm/blob/master/conf/defaults.yaml";>defaults.yaml</a> in the Storm codebase. You can override these configurations by defining a storm.yaml in the classpath of Nimbus and the supervisors. Finally, you can define a topology-specific configuration that you submit along with your topology when using <a href="/javadoc/apidocs/backtype/storm/StormSubmitter.html">StormSubmitter</a>. However, the topology-specific configuration can only override configs prefixed with "TOPOLOGY".</p> + +<p>Storm 0.7.0 and onwards lets you override configuration on a per-bolt/per-spout basis. The only configurations that can be overriden this way are:</p> + +<ol> +<li>"topology.debug"</li> +<li>"topology.max.spout.pending"</li> +<li>"topology.max.task.parallelism"</li> +<li>"topology.kryo.register": This works a little bit differently than the other ones, since the serializations will be available to all components in the topology. More details on <a href="Serialization.html">Serialization</a>. </li> +</ol> + +<p>The Java API lets you specify component specific configurations in two ways:</p> + +<ol> +<li><em>Internally:</em> Override <code>getComponentConfiguration</code> in any spout or bolt and return the component-specific configuration map.</li> +<li><em>Externally:</em> <code>setSpout</code> and <code>setBolt</code> in <code>TopologyBuilder</code> return an object with methods <code>addConfiguration</code> and <code>addConfigurations</code> that can be used to override the configurations for the component.</li> +</ol> + +<p>The preference order for configuration values is defaults.yaml < storm.yaml < topology specific configuration < internal component specific configuration < external component specific configuration. </p> + +<p><strong>Resources:</strong></p> + +<ul> +<li><a href="/javadoc/apidocs/backtype/storm/Config.html">Config</a>: a listing of all configurations as well as a helper class for creating topology specific configurations</li> +<li><a href="https://github.com/apache/storm/blob/master/conf/defaults.yaml";>defaults.yaml</a>: the default values for all configurations</li> +<li><a href="Setting-up-a-Storm-cluster.html">Setting up a Storm cluster</a>: explains how to create and configure a Storm cluster</li> +<li><a href="Running-topologies-on-a-production-cluster.html">Running topologies on a production cluster</a>: lists useful configurations when running topologies on a cluster</li> +<li><a href="Local-mode.html">Local mode</a>: lists useful configurations when using local mode</li> +</ul> + + + + </div> + </div> + </div> +<footer> + <div class="container-fluid"> + <div class="row"> + <div class="col-md-3"> + <div class="footer-widget"> + <h5>Meetups</h5> + <ul class="latest-news"> + <li><a href="http://www.meetup.com/Apache-Storm-Apache-Kafka/";>Sunnyvale, CA</a> <span class="small">(10 May 2015)</span></li> + <li><a href="http://www.meetup.com/Apache-Storm-Kafka-Users/";>Seatle, WA</a> <span class="small">(27 Jun 2015)</span></li> + </ul> + </div> + </div> + <div class="col-md-3"> + <div class="footer-widget"> + <h5>About Storm</h5> + <p>Storm integrates with any queueing system and any database system. Storm's spout abstraction makes it easy to integrate a new queuing system. Likewise, integrating Storm with database systems is easy.</p> + </div> + </div> + <div class="col-md-3"> + <div class="footer-widget"> + <h5>First Look</h5> + <ul class="footer-list"> + <li><a href="/documentation/Rationale.html">Rationale</a></li> + <li><a href="/tutorial.html">Tutorial</a></li> + <li><a href="/documentation/Setting-up-development-environment.html">Setting up development environment</a></li> + <li><a href="/documentation/Creating-a-new-Storm-project.html">Creating a new Storm project</a></li> + </ul> + </div> + </div> + <div class="col-md-3"> + <div class="footer-widget"> + <h5>Documentation</h5> + <ul class="footer-list"> + <li><a href="/doc-index.html">Index</a></li> + <li><a href="/documentation.html">Manual</a></li> + <li><a href="https://storm.apache.org/javadoc/apidocs/index.html";>Javadoc</a></li> + <li><a href="/documentation/FAQ.html">FAQ</a></li> + </ul> + </div> + </div> + </div> + <hr/> + <div class="row"> + <div class="col-md-12"> + <p align="center">Copyright © 2015 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved. Apache Storm, Apache, the Apache feather logo, and the Apache Storm project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p> + </div> + </div> + </div> +</footer> +<!--Footer End--> +<!-- Scroll to top --> +<span class="totop"><a href="#"><i class="fa fa-angle-up"></i></a></span> + +</body> + +</html> + http://git-wip-us.apache.org/repos/asf/storm/blob/1d09012e/_site/documentation/Creating-a-new-Storm-project.html ---------------------------------------------------------------------- diff --git a/_site/documentation/Creating-a-new-Storm-project.html b/_site/documentation/Creating-a-new-Storm-project.html new file mode 100644 index 0000000..91c14c4 --- /dev/null +++ b/_site/documentation/Creating-a-new-Storm-project.html @@ -0,0 +1,176 @@ +<!DOCTYPE html> +<html> + <head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + + <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon"> + <link rel="icon" href="/favicon.ico" type="image/x-icon"> + + <title>Creating a New Storm Project</title> + + <!-- Bootstrap core CSS --> + <link href="/assets/css/bootstrap.min.css" rel="stylesheet"> + <!-- Bootstrap theme --> + <link href="/assets/css/bootstrap-theme.min.css" rel="stylesheet"> + + <!-- Custom styles for this template --> + <link rel="stylesheet" href="http://fortawesome.github.io/Font-Awesome/assets/font-awesome/css/font-awesome.css";> + <link href="/css/style.css" rel="stylesheet"> + <link href="/assets/css/owl.theme.css" rel="stylesheet"> + <link href="/assets/css/owl.carousel.css" rel="stylesheet"> + <script type="text/javascript" src="/assets/js/jquery.min.js"></script> + <script type="text/javascript" src="/assets/js/bootstrap.min.js"></script> + <script type="text/javascript" src="/assets/js/owl.carousel.min.js"></script> + <script type="text/javascript" src="/assets/js/storm.js"></script> + <!-- Just for debugging purposes. Don't actually copy these 2 lines! --> + <!--[if lt IE 9]><script src="../../assets/js/ie8-responsive-file-warning.js"></script><![endif]--> + + <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js";></script> + <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script> + <![endif]--> + </head> + + + <body> + <header> + <div class="container-fluid"> + <div class="row"> + <div class="col-md-10"> + <a href="/index.html"><img src="/images/logo.png" class="logo" /></a> + </div> + <div class="col-md-2"> + <a href="/downloads.html" class="btn-std btn-block btn-download">Download</a> + </div> + </div> + </div> +</header> +<!--Header End--> +<!--Navigation Begin--> +<div class="navbar" role="banner"> + <div class="container-fluid"> + <div class="navbar-header"> + <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bs-navbar-collapse"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + </div> + <nav class="collapse navbar-collapse bs-navbar-collapse" role="navigation"> + <ul class="nav navbar-nav"> + <li><a href="/index.html" id="home">Home</a></li> + <li><a href="/getting-help.html" id="getting-help">Getting Help</a></li> + <li><a href="/about/integrates.html" id="project-info">Project Information</a></li> + <li><a href="/documentation.html" id="documentation">Documentation</a></li> + <li><a href="/talksAndVideos.html">Talks and Slideshows</a></li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" id="contribute">Contribute <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="/contribute/Contributing-to-Storm.html">Getting Started</a></li> + <li><a href="/contribute/BYLAWS.html">ByLaws</a></li> + </ul> + </li> + <li><a href="/2015/06/15/storm0100-beta-released.html" id="news">News</a></li> + </ul> + </nav> + </div> +</div> + + + + <div class="container-fluid"> + <h1 class="page-title">Creating a New Storm Project</h1> + <div class="row"> + <div class="col-md-12"> + <!-- Documentation --> + +<p class="post-meta"></p> + +<p>This page outlines how to set up a Storm project for development. The steps are:</p> + +<ol> +<li>Add Storm jars to classpath</li> +<li>If using multilang, add multilang dir to classpath</li> +</ol> + +<p>Follow along to see how to set up the <a href="https://github.com/apache/storm/blob/master/examples/storm-starter";>storm-starter</a> project in Eclipse.</p> + +<h3 id="add-storm-jars-to-classpath">Add Storm jars to classpath</h3> + +<p>You'll need the Storm jars on your classpath to develop Storm topologies. Using <a href="Maven.html">Maven</a> is highly recommended. <a href="https://github.com/apache/storm/blob/master/examples/storm-starter/pom.xml";>Here's an example</a> of how to setup your pom.xml for a Storm project. If you don't want to use Maven, you can include the jars from the Storm release on your classpath.</p> + +<p>To set up the classpath in Eclipse, create a new Java project, include <code>src/jvm/</code> as a source path, and make sure all the jars in <code>lib/</code> and <code>lib/dev/</code> are in the <code>Referenced Libraries</code> section of the project.</p> + +<h3 id="if-using-multilang,-add-multilang-dir-to-classpath">If using multilang, add multilang dir to classpath</h3> + +<p>If you implement spouts or bolts in languages other than Java, then those implementations should be under the <code>multilang/resources/</code> directory of the project. For Storm to find these files in local mode, the <code>resources/</code> dir needs to be on the classpath. You can do this in Eclipse by adding <code>multilang/</code> as a source folder. You may also need to add multilang/resources as a source directory.</p> + +<p>For more information on writing topologies in other languages, see <a href="Using-non-JVM-languages-with-Storm.html">Using non-JVM languages with Storm</a>.</p> + +<p>To test that everything is working in Eclipse, you should now be able to <code>Run</code> the <code>WordCountTopology.java</code> file. You will see messages being emitted at the console for 10 seconds.</p> + + + + </div> + </div> + </div> +<footer> + <div class="container-fluid"> + <div class="row"> + <div class="col-md-3"> + <div class="footer-widget"> + <h5>Meetups</h5> + <ul class="latest-news"> + <li><a href="http://www.meetup.com/Apache-Storm-Apache-Kafka/";>Sunnyvale, CA</a> <span class="small">(10 May 2015)</span></li> + <li><a href="http://www.meetup.com/Apache-Storm-Kafka-Users/";>Seatle, WA</a> <span class="small">(27 Jun 2015)</span></li> + </ul> + </div> + </div> + <div class="col-md-3"> + <div class="footer-widget"> + <h5>About Storm</h5> + <p>Storm integrates with any queueing system and any database system. Storm's spout abstraction makes it easy to integrate a new queuing system. Likewise, integrating Storm with database systems is easy.</p> + </div> + </div> + <div class="col-md-3"> + <div class="footer-widget"> + <h5>First Look</h5> + <ul class="footer-list"> + <li><a href="/documentation/Rationale.html">Rationale</a></li> + <li><a href="/tutorial.html">Tutorial</a></li> + <li><a href="/documentation/Setting-up-development-environment.html">Setting up development environment</a></li> + <li><a href="/documentation/Creating-a-new-Storm-project.html">Creating a new Storm project</a></li> + </ul> + </div> + </div> + <div class="col-md-3"> + <div class="footer-widget"> + <h5>Documentation</h5> + <ul class="footer-list"> + <li><a href="/doc-index.html">Index</a></li> + <li><a href="/documentation.html">Manual</a></li> + <li><a href="https://storm.apache.org/javadoc/apidocs/index.html";>Javadoc</a></li> + <li><a href="/documentation/FAQ.html">FAQ</a></li> + </ul> + </div> + </div> + </div> + <hr/> + <div class="row"> + <div class="col-md-12"> + <p align="center">Copyright © 2015 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved. Apache Storm, Apache, the Apache feather logo, and the Apache Storm project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p> + </div> + </div> + </div> +</footer> +<!--Footer End--> +<!-- Scroll to top --> +<span class="totop"><a href="#"><i class="fa fa-angle-up"></i></a></span> + +</body> + +</html> + http://git-wip-us.apache.org/repos/asf/storm/blob/1d09012e/_site/documentation/DSLs-and-multilang-adapters.html ---------------------------------------------------------------------- diff --git a/_site/documentation/DSLs-and-multilang-adapters.html b/_site/documentation/DSLs-and-multilang-adapters.html new file mode 100644 index 0000000..25be8a3 --- /dev/null +++ b/_site/documentation/DSLs-and-multilang-adapters.html @@ -0,0 +1,161 @@ +<!DOCTYPE html> +<html> + <head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + + <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon"> + <link rel="icon" href="/favicon.ico" type="image/x-icon"> + + <title>Storm DSLs and Multi-Lang Adapters</title> + + <!-- Bootstrap core CSS --> + <link href="/assets/css/bootstrap.min.css" rel="stylesheet"> + <!-- Bootstrap theme --> + <link href="/assets/css/bootstrap-theme.min.css" rel="stylesheet"> + + <!-- Custom styles for this template --> + <link rel="stylesheet" href="http://fortawesome.github.io/Font-Awesome/assets/font-awesome/css/font-awesome.css";> + <link href="/css/style.css" rel="stylesheet"> + <link href="/assets/css/owl.theme.css" rel="stylesheet"> + <link href="/assets/css/owl.carousel.css" rel="stylesheet"> + <script type="text/javascript" src="/assets/js/jquery.min.js"></script> + <script type="text/javascript" src="/assets/js/bootstrap.min.js"></script> + <script type="text/javascript" src="/assets/js/owl.carousel.min.js"></script> + <script type="text/javascript" src="/assets/js/storm.js"></script> + <!-- Just for debugging purposes. Don't actually copy these 2 lines! --> + <!--[if lt IE 9]><script src="../../assets/js/ie8-responsive-file-warning.js"></script><![endif]--> + + <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js";></script> + <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script> + <![endif]--> + </head> + + + <body> + <header> + <div class="container-fluid"> + <div class="row"> + <div class="col-md-10"> + <a href="/index.html"><img src="/images/logo.png" class="logo" /></a> + </div> + <div class="col-md-2"> + <a href="/downloads.html" class="btn-std btn-block btn-download">Download</a> + </div> + </div> + </div> +</header> +<!--Header End--> +<!--Navigation Begin--> +<div class="navbar" role="banner"> + <div class="container-fluid"> + <div class="navbar-header"> + <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bs-navbar-collapse"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + </div> + <nav class="collapse navbar-collapse bs-navbar-collapse" role="navigation"> + <ul class="nav navbar-nav"> + <li><a href="/index.html" id="home">Home</a></li> + <li><a href="/getting-help.html" id="getting-help">Getting Help</a></li> + <li><a href="/about/integrates.html" id="project-info">Project Information</a></li> + <li><a href="/documentation.html" id="documentation">Documentation</a></li> + <li><a href="/talksAndVideos.html">Talks and Slideshows</a></li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" id="contribute">Contribute <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="/contribute/Contributing-to-Storm.html">Getting Started</a></li> + <li><a href="/contribute/BYLAWS.html">ByLaws</a></li> + </ul> + </li> + <li><a href="/2015/06/15/storm0100-beta-released.html" id="news">News</a></li> + </ul> + </nav> + </div> +</div> + + + + <div class="container-fluid"> + <h1 class="page-title">Storm DSLs and Multi-Lang Adapters</h1> + <div class="row"> + <div class="col-md-12"> + <!-- Documentation --> + +<p class="post-meta"></p> + +<ul> +<li><a href="https://github.com/velvia/ScalaStorm";>Scala DSL</a></li> +<li><a href="https://github.com/colinsurprenant/redstorm";>JRuby DSL</a></li> +<li><a href="Clojure-DSL.html">Clojure DSL</a></li> +<li><a href="https://github.com/tomdz/storm-esper";>Storm/Esper integration</a>: Streaming SQL on top of Storm</li> +<li><a href="https://github.com/dan-blanchard/io-storm";>io-storm</a>: Perl multilang adapter</li> +</ul> + + + + </div> + </div> + </div> +<footer> + <div class="container-fluid"> + <div class="row"> + <div class="col-md-3"> + <div class="footer-widget"> + <h5>Meetups</h5> + <ul class="latest-news"> + <li><a href="http://www.meetup.com/Apache-Storm-Apache-Kafka/";>Sunnyvale, CA</a> <span class="small">(10 May 2015)</span></li> + <li><a href="http://www.meetup.com/Apache-Storm-Kafka-Users/";>Seatle, WA</a> <span class="small">(27 Jun 2015)</span></li> + </ul> + </div> + </div> + <div class="col-md-3"> + <div class="footer-widget"> + <h5>About Storm</h5> + <p>Storm integrates with any queueing system and any database system. Storm's spout abstraction makes it easy to integrate a new queuing system. Likewise, integrating Storm with database systems is easy.</p> + </div> + </div> + <div class="col-md-3"> + <div class="footer-widget"> + <h5>First Look</h5> + <ul class="footer-list"> + <li><a href="/documentation/Rationale.html">Rationale</a></li> + <li><a href="/tutorial.html">Tutorial</a></li> + <li><a href="/documentation/Setting-up-development-environment.html">Setting up development environment</a></li> + <li><a href="/documentation/Creating-a-new-Storm-project.html">Creating a new Storm project</a></li> + </ul> + </div> + </div> + <div class="col-md-3"> + <div class="footer-widget"> + <h5>Documentation</h5> + <ul class="footer-list"> + <li><a href="/doc-index.html">Index</a></li> + <li><a href="/documentation.html">Manual</a></li> + <li><a href="https://storm.apache.org/javadoc/apidocs/index.html";>Javadoc</a></li> + <li><a href="/documentation/FAQ.html">FAQ</a></li> + </ul> + </div> + </div> + </div> + <hr/> + <div class="row"> + <div class="col-md-12"> + <p align="center">Copyright © 2015 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved. Apache Storm, Apache, the Apache feather logo, and the Apache Storm project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p> + </div> + </div> + </div> +</footer> +<!--Footer End--> +<!-- Scroll to top --> +<span class="totop"><a href="#"><i class="fa fa-angle-up"></i></a></span> + +</body> + +</html> + http://git-wip-us.apache.org/repos/asf/storm/blob/1d09012e/_site/documentation/Defining-a-non-jvm-language-dsl-for-storm.html ---------------------------------------------------------------------- diff --git a/_site/documentation/Defining-a-non-jvm-language-dsl-for-storm.html b/_site/documentation/Defining-a-non-jvm-language-dsl-for-storm.html new file mode 100644 index 0000000..5fcece1 --- /dev/null +++ b/_site/documentation/Defining-a-non-jvm-language-dsl-for-storm.html @@ -0,0 +1,175 @@ +<!DOCTYPE html> +<html> + <head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + + <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon"> + <link rel="icon" href="/favicon.ico" type="image/x-icon"> + + <title>Defining a Non-JVM DSL for Storm</title> + + <!-- Bootstrap core CSS --> + <link href="/assets/css/bootstrap.min.css" rel="stylesheet"> + <!-- Bootstrap theme --> + <link href="/assets/css/bootstrap-theme.min.css" rel="stylesheet"> + + <!-- Custom styles for this template --> + <link rel="stylesheet" href="http://fortawesome.github.io/Font-Awesome/assets/font-awesome/css/font-awesome.css";> + <link href="/css/style.css" rel="stylesheet"> + <link href="/assets/css/owl.theme.css" rel="stylesheet"> + <link href="/assets/css/owl.carousel.css" rel="stylesheet"> + <script type="text/javascript" src="/assets/js/jquery.min.js"></script> + <script type="text/javascript" src="/assets/js/bootstrap.min.js"></script> + <script type="text/javascript" src="/assets/js/owl.carousel.min.js"></script> + <script type="text/javascript" src="/assets/js/storm.js"></script> + <!-- Just for debugging purposes. Don't actually copy these 2 lines! --> + <!--[if lt IE 9]><script src="../../assets/js/ie8-responsive-file-warning.js"></script><![endif]--> + + <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js";></script> + <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script> + <![endif]--> + </head> + + + <body> + <header> + <div class="container-fluid"> + <div class="row"> + <div class="col-md-10"> + <a href="/index.html"><img src="/images/logo.png" class="logo" /></a> + </div> + <div class="col-md-2"> + <a href="/downloads.html" class="btn-std btn-block btn-download">Download</a> + </div> + </div> + </div> +</header> +<!--Header End--> +<!--Navigation Begin--> +<div class="navbar" role="banner"> + <div class="container-fluid"> + <div class="navbar-header"> + <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bs-navbar-collapse"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + </div> + <nav class="collapse navbar-collapse bs-navbar-collapse" role="navigation"> + <ul class="nav navbar-nav"> + <li><a href="/index.html" id="home">Home</a></li> + <li><a href="/getting-help.html" id="getting-help">Getting Help</a></li> + <li><a href="/about/integrates.html" id="project-info">Project Information</a></li> + <li><a href="/documentation.html" id="documentation">Documentation</a></li> + <li><a href="/talksAndVideos.html">Talks and Slideshows</a></li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" id="contribute">Contribute <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="/contribute/Contributing-to-Storm.html">Getting Started</a></li> + <li><a href="/contribute/BYLAWS.html">ByLaws</a></li> + </ul> + </li> + <li><a href="/2015/06/15/storm0100-beta-released.html" id="news">News</a></li> + </ul> + </nav> + </div> +</div> + + + + <div class="container-fluid"> + <h1 class="page-title">Defining a Non-JVM DSL for Storm</h1> + <div class="row"> + <div class="col-md-12"> + <!-- Documentation --> + +<p class="post-meta"></p> + +<p>The right place to start to learn how to make a non-JVM DSL for Storm is <a href="https://github.com/apache/storm/blob/master/storm-core/src/storm.thrift";>storm-core/src/storm.thrift</a>. Since Storm topologies are just Thrift structures, and Nimbus is a Thrift daemon, you can create and submit topologies in any language.</p> + +<p>When you create the Thrift structs for spouts and bolts, the code for the spout or bolt is specified in the ComponentObject struct:</p> +<div class="highlight"><pre><code class="language-text" data-lang="text">union ComponentObject { + 1: binary serialized_java; + 2: ShellComponent shell; + 3: JavaObject java_object; +} +</code></pre></div> +<p>For a Python DSL, you would want to make use of "2" and "3". ShellComponent lets you specify a script to run that component (e.g., your python code). And JavaObject lets you specify native java spouts and bolts for the component (and Storm will use reflection to create that spout or bolt).</p> + +<p>There's a "storm shell" command that will help with submitting a topology. Its usage is like this:</p> +<div class="highlight"><pre><code class="language-text" data-lang="text">storm shell resources/ python topology.py arg1 arg2 +</code></pre></div> +<p>storm shell will then package resources/ into a jar, upload the jar to Nimbus, and call your topology.py script like this:</p> +<div class="highlight"><pre><code class="language-text" data-lang="text">python topology.py arg1 arg2 {nimbus-host} {nimbus-port} {uploaded-jar-location} +</code></pre></div> +<p>Then you can connect to Nimbus using the Thrift API and submit the topology, passing {uploaded-jar-location} into the submitTopology method. For reference, here's the submitTopology definition:</p> +<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="kt">void</span> <span class="nf">submitTopology</span><span class="o">(</span><span class="mi">1</span><span class="o">:</span> <span class="n">string</span> <span class="n">name</span><span class="o">,</span> <span class="mi">2</span><span class="o">:</span> <span class="n">string</span> <span class="n">uploadedJarLocation</span><span class="o">,</span> <span class="mi">3</span><span class="o">:</span> <span class="n">string</span> <span class="n">jsonConf</span><span class="o">,</span> <span class="mi">4</span><span class="o">:</span> <span class="n">StormTopology</span> <span class="n">topology</span><span class="o">)</span> <span class="kd">throws</span> <span class="o">(</span><span class="mi">1</span><span class="o">:</span> <span class="n">AlreadyAliveException</span> <span class="n">e</span><span class="o">,</span> <span class="mi">2</span><span class="o">:</span> <span class="n">InvalidTop ologyException</span> <span class="n">ite</span><span class="o">);</span> +</code></pre></div> +<p>Finally, one of the key things to do in a non-JVM DSL is make it easy to define the entire topology in one file (the bolts, spouts, and the definition of the topology).</p> + + + + </div> + </div> + </div> +<footer> + <div class="container-fluid"> + <div class="row"> + <div class="col-md-3"> + <div class="footer-widget"> + <h5>Meetups</h5> + <ul class="latest-news"> + <li><a href="http://www.meetup.com/Apache-Storm-Apache-Kafka/";>Sunnyvale, CA</a> <span class="small">(10 May 2015)</span></li> + <li><a href="http://www.meetup.com/Apache-Storm-Kafka-Users/";>Seatle, WA</a> <span class="small">(27 Jun 2015)</span></li> + </ul> + </div> + </div> + <div class="col-md-3"> + <div class="footer-widget"> + <h5>About Storm</h5> + <p>Storm integrates with any queueing system and any database system. Storm's spout abstraction makes it easy to integrate a new queuing system. Likewise, integrating Storm with database systems is easy.</p> + </div> + </div> + <div class="col-md-3"> + <div class="footer-widget"> + <h5>First Look</h5> + <ul class="footer-list"> + <li><a href="/documentation/Rationale.html">Rationale</a></li> + <li><a href="/tutorial.html">Tutorial</a></li> + <li><a href="/documentation/Setting-up-development-environment.html">Setting up development environment</a></li> + <li><a href="/documentation/Creating-a-new-Storm-project.html">Creating a new Storm project</a></li> + </ul> + </div> + </div> + <div class="col-md-3"> + <div class="footer-widget"> + <h5>Documentation</h5> + <ul class="footer-list"> + <li><a href="/doc-index.html">Index</a></li> + <li><a href="/documentation.html">Manual</a></li> + <li><a href="https://storm.apache.org/javadoc/apidocs/index.html";>Javadoc</a></li> + <li><a href="/documentation/FAQ.html">FAQ</a></li> + </ul> + </div> + </div> + </div> + <hr/> + <div class="row"> + <div class="col-md-12"> + <p align="center">Copyright © 2015 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved. Apache Storm, Apache, the Apache feather logo, and the Apache Storm project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p> + </div> + </div> + </div> +</footer> +<!--Footer End--> +<!-- Scroll to top --> +<span class="totop"><a href="#"><i class="fa fa-angle-up"></i></a></span> + +</body> + +</html> +
