You are viewing a plain text version of this content. The canonical link for it is here.
Posted to s4-commits@incubator.apache.org by mm...@apache.org on 2013/02/27 19:15:47 UTC
svn commit: r1450926 - in /incubator/s4/site/doc/0.6.0: ./
application_dependencies/ configuration/ dev_tips/ event_dispatch/
fault_tolerance/ metrics/ overview/ walkthrough/
Author: mmorel
Date: Wed Feb 27 19:15:47 2013
New Revision: 1450926
URL: http://svn.apache.org/r1450926
Log:
fixed display for markdown generated documents
Modified:
incubator/s4/site/doc/0.6.0/application_dependencies/index.html
incubator/s4/site/doc/0.6.0/configuration/index.html
incubator/s4/site/doc/0.6.0/dev_tips/index.html
incubator/s4/site/doc/0.6.0/event_dispatch/index.html
incubator/s4/site/doc/0.6.0/fault_tolerance/index.html
incubator/s4/site/doc/0.6.0/index.html
incubator/s4/site/doc/0.6.0/metrics/index.html
incubator/s4/site/doc/0.6.0/overview/index.html
incubator/s4/site/doc/0.6.0/walkthrough/index.html
Modified: incubator/s4/site/doc/0.6.0/application_dependencies/index.html
URL: http://svn.apache.org/viewvc/incubator/s4/site/doc/0.6.0/application_dependencies/index.html?rev=1450926&r1=1450925&r2=1450926&view=diff
==============================================================================
--- incubator/s4/site/doc/0.6.0/application_dependencies/index.html (original)
+++ incubator/s4/site/doc/0.6.0/application_dependencies/index.html Wed Feb 27 19:15:47 2013
@@ -1,17 +1,16 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
- <head>
- <title>S4: Adding application dependencies</title>
- <meta content='text/html; charset=utf-8' http-equiv='Content-Type' />
- <meta content='A general-purpose distributed stream computing platform' name='description' />
- <link href='/style/screen.css' media='screen' rel='stylesheet' type='text/css' />
- <link href='/style/print.css' media='print' rel='stylesheet' type='text/css' />
- <!--[if lt IE 9]>
- <link href='/style/ie.css' media='screen' rel='stylesheet' type='text/css' />
- <![endif]-->
- <link href='/style/style.css' rel='stylesheet' type='text/css' />
- <link href='/style/nav.css' rel='stylesheet' type='text/css' />
- <script type='text/javascript'>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>S4: Adding application dependencies</title>
+<meta content="A general-purpose distributed stream computing platform" name="description">
+<link href="../../../style/screen.css" media="screen" rel="stylesheet" type="text/css">
+<link href="../../../style/print.css" media="print" rel="stylesheet" type="text/css">
+<!--[if lt IE 9]>
+ <link href="../../../style/ie.css" media="screen" rel="stylesheet" type="text/css">
+ <![endif]--><link href="../../../style/style.css" rel="stylesheet" type="text/css">
+<link href="../../../style/nav.css" rel="stylesheet" type="text/css">
+<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-19490961-1']);
_gaq.push(['_setDomainName', '.s4.io']);
@@ -21,45 +20,44 @@
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
- </script>
- <link href='/style/coderay.css' rel='stylesheet' type='text/css' />
- <link href='/style/pygmentize.css' rel='stylesheet' type='text/css' />
- </head>
- <body>
- <div id='header'>
- <div class='container'>
- <div id='logo'>
- <a href='/'>
- <img src='/images/s4_test.png' />
- </a>
+ </script><link href="../../../style/coderay.css" rel="stylesheet" type="text/css">
+<link href="../../../style/pygmentize.css" rel="stylesheet" type="text/css">
+</head>
+<body>
+ <div id="header">
+ <div class="container">
+ <div id="logo">
+ <a href="../../../">
+ <img src="../../../images/s4_test.png"></a>
</div>
- <div id='navbar'><ul id='nav'>
- <li>
- <a href='/'>home</a>
+ <div id="navbar"><ul id="nav">
+<li>
+ <a href="../../../">home</a>
</li>
<li>
- <a href='https://cwiki.apache.org/confluence/display/S4/S4+Wiki'>doc [0.5]</a>
+ <a href="https://cwiki.apache.org/confluence/display/S4/S4+Wiki">doc [0.5]</a>
</li>
<li>
- <a href='http://git-wip-us.apache.org/repos/asf?p=incubator-s4.git' onClick="_gaq.push(['_trackEvent', 'External', 'Apache Git', 'http://github.com/s4']);">code</a>
+ <a href="http://git-wip-us.apache.org/repos/asf?p=incubator-s4.git" onclick="_gaq.push(['_trackEvent', 'External', 'Apache Git', 'http://github.com/s4']);">code</a>
</li>
<li>
- <a href='http://people.apache.org/~mmorel/apache-s4-0.5.0-incubating-doc/javadoc/'>API</a>
+ <a href="http://people.apache.org/~mmorel/apache-s4-0.5.0-incubating-doc/javadoc/">API</a>
</li>
<li>
- <a href='/contrib'>get involved</a>
+ <a href="../../../contrib">get involved</a>
</li>
<li>
- <a href='/team'>team</a>
+ <a href="../../../team">team</a>
</li>
<li>
- <a href='/download'>download</a>
+ <a href="../../../download">download</a>
</li>
</ul></div>
</div>
</div>
- <div id='wrapper'>
- <div class='container' id='container'><blockquote>
+ <div id="wrapper">
+ <div class="container" id="container">
+<blockquote>
<p>Make sure you have already read the <a href="../walkthrough">walkthrough</a></p>
</blockquote>
@@ -97,7 +95,8 @@
<li>
<p>If you use an IDE such as eclipse, you may update your projectâs classpath with: <code>./gradlew eclipse</code></p>
</li>
-</ul><p>A good source for finding dependencies is for instance <a href="http://search.maven.org/">http://search.maven.org/</a> where you also get the syntax for gradle scripts (see grails syntax).</p>
+</ul>
+<p>A good source for finding dependencies is for instance <a href="http://search.maven.org/">http://search.maven.org/</a> where you also get the syntax for gradle scripts (see grails syntax).</p>
<blockquote>
<p>The application dependencies will be automatically included in the s4r archive that you create and publish.</p>
@@ -111,11 +110,13 @@
<li>publish them to your local maven repository, see <a href="%5Bhttp://maven.apache.org/guides/mini/guide-3rd-party-jars-local.html">http://maven.apache.org/guides/mini/guide-3rd-party-jars-local.html</a>
</li>
<li>add them to the <em>lib</em> directory</li>
-</ul><p>In both cases you still have to declare them as compile-time dependencies.</p></div>
+</ul>
+<p>In both cases you still have to declare them as compile-time dependencies.</p>
+</div>
</div>
- <div id='footer'>
- <div class='container'>
- <span class='copyright'>Apache S4 - Copyright 2013 The Apache Software Foundation</span>
+ <div id="footer">
+ <div class="container">
+ <span class="copyright">Apache S4 - Copyright 2013 The Apache Software Foundation</span>
</div>
</div>
</body>
Modified: incubator/s4/site/doc/0.6.0/configuration/index.html
URL: http://svn.apache.org/viewvc/incubator/s4/site/doc/0.6.0/configuration/index.html?rev=1450926&r1=1450925&r2=1450926&view=diff
==============================================================================
--- incubator/s4/site/doc/0.6.0/configuration/index.html (original)
+++ incubator/s4/site/doc/0.6.0/configuration/index.html Wed Feb 27 19:15:47 2013
@@ -1,17 +1,16 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
- <head>
- <title>S4: Configuration</title>
- <meta content='text/html; charset=utf-8' http-equiv='Content-Type' />
- <meta content='A general-purpose distributed stream computing platform' name='description' />
- <link href='/style/screen.css' media='screen' rel='stylesheet' type='text/css' />
- <link href='/style/print.css' media='print' rel='stylesheet' type='text/css' />
- <!--[if lt IE 9]>
- <link href='/style/ie.css' media='screen' rel='stylesheet' type='text/css' />
- <![endif]-->
- <link href='/style/style.css' rel='stylesheet' type='text/css' />
- <link href='/style/nav.css' rel='stylesheet' type='text/css' />
- <script type='text/javascript'>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>S4: Configuration</title>
+<meta content="A general-purpose distributed stream computing platform" name="description">
+<link href="../../../style/screen.css" media="screen" rel="stylesheet" type="text/css">
+<link href="../../../style/print.css" media="print" rel="stylesheet" type="text/css">
+<!--[if lt IE 9]>
+ <link href="../../../style/ie.css" media="screen" rel="stylesheet" type="text/css">
+ <![endif]--><link href="../../../style/style.css" rel="stylesheet" type="text/css">
+<link href="../../../style/nav.css" rel="stylesheet" type="text/css">
+<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-19490961-1']);
_gaq.push(['_setDomainName', '.s4.io']);
@@ -21,45 +20,44 @@
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
- </script>
- <link href='/style/coderay.css' rel='stylesheet' type='text/css' />
- <link href='/style/pygmentize.css' rel='stylesheet' type='text/css' />
- </head>
- <body>
- <div id='header'>
- <div class='container'>
- <div id='logo'>
- <a href='/'>
- <img src='/images/s4_test.png' />
- </a>
+ </script><link href="../../../style/coderay.css" rel="stylesheet" type="text/css">
+<link href="../../../style/pygmentize.css" rel="stylesheet" type="text/css">
+</head>
+<body>
+ <div id="header">
+ <div class="container">
+ <div id="logo">
+ <a href="../../../">
+ <img src="../../../images/s4_test.png"></a>
</div>
- <div id='navbar'><ul id='nav'>
- <li>
- <a href='/'>home</a>
+ <div id="navbar"><ul id="nav">
+<li>
+ <a href="../../../">home</a>
</li>
<li>
- <a href='https://cwiki.apache.org/confluence/display/S4/S4+Wiki'>doc [0.5]</a>
+ <a href="https://cwiki.apache.org/confluence/display/S4/S4+Wiki">doc [0.5]</a>
</li>
<li>
- <a href='http://git-wip-us.apache.org/repos/asf?p=incubator-s4.git' onClick="_gaq.push(['_trackEvent', 'External', 'Apache Git', 'http://github.com/s4']);">code</a>
+ <a href="http://git-wip-us.apache.org/repos/asf?p=incubator-s4.git" onclick="_gaq.push(['_trackEvent', 'External', 'Apache Git', 'http://github.com/s4']);">code</a>
</li>
<li>
- <a href='http://people.apache.org/~mmorel/apache-s4-0.5.0-incubating-doc/javadoc/'>API</a>
+ <a href="http://people.apache.org/~mmorel/apache-s4-0.5.0-incubating-doc/javadoc/">API</a>
</li>
<li>
- <a href='/contrib'>get involved</a>
+ <a href="../../../contrib">get involved</a>
</li>
<li>
- <a href='/team'>team</a>
+ <a href="../../../team">team</a>
</li>
<li>
- <a href='/download'>download</a>
+ <a href="../../../download">download</a>
</li>
</ul></div>
</div>
</div>
- <div id='wrapper'>
- <div class='container' id='container'><blockquote>
+ <div id="wrapper">
+ <div class="container" id="container">
+<blockquote>
<p>How to configure S4 clusters and applications</p>
</blockquote>
@@ -88,7 +86,8 @@
<code>s4</code> will give you a list of available commands.</li>
<li>
<code>./s4 <command> -help</code> will provide detailed documentation for each of these commands.</li>
-</ul><h1 id="cluster-configuration">Cluster configuration</h1>
+</ul>
+<h1 id="cluster-configuration">Cluster configuration</h1>
<p>Before starting S4 nodes, you must define a logical cluster by specifying:</p>
@@ -101,7 +100,8 @@
<li>those ports are used for inter node communication.</li>
</ul>
</li>
-</ul><p>The cluster configuration is maintained in Zookeeper, and can be set using S4 tools:</p>
+</ul>
+<p>The cluster configuration is maintained in Zookeeper, and can be set using S4 tools:</p>
<pre><code>./s4 newCluster -c=cluster1 -nbTasks=2 -flp=12000
</code></pre>
@@ -124,16 +124,18 @@
<li>the communication and core components are loaded, bound and initialized</li>
<li>the application configuration and code, as specified in the configuration of the deployed applciation, is downloaded</li>
<li>the application is initialized and started</li>
-</ol><p>This figure illustrates the separation between the bootstrap code, the S4 platform code, and application code in an S4 node:</p>
+</ol>
+<p>This figure illustrates the separation between the bootstrap code, the S4 platform code, and application code in an S4 node:</p>
-<p><img src="/images/doc/0.6.0/s4_node_layers.png" alt="image"></p>
+<p><img src="../../../images/doc/0.6.0/s4_node_layers.png" alt="image"></p>
<p>Therefore, for starting an S4 node on a given host, you only need to specify:</p>
<ul>
<li>the connection string to the cluster management system (Zookeeper) <code>localhost:2181</code> by default</li>
<li>the name of the logical cluster to which this node will belong</li>
-</ul><p>Example:
+</ul>
+<p>Example:
<code>./s4 node -c=cluster1 -zk=host.domain.com</code></p>
<h1 id="application-configuration">Application configuration</h1>
@@ -148,7 +150,8 @@
<li>which specific modules to use</li>
<li>where to fetch these modules</li>
<li>string configuration parameters - that can be used by the application and the modules</li>
-</ul><h2 id="modules-configuration">Modules configuration</h2>
+</ul>
+<h2 id="modules-configuration">Modules configuration</h2>
<p>S4 follows a modular design and uses<a href="http://code.google.com/p/google-guice/">Guice</a> for defining modules and injecting dependencies.</p>
@@ -190,13 +193,15 @@
<ul>
<li>injecting them in the application class (primitive types, enums and class literals are automatically converted), for instance:</li>
-</ul><pre><code class="language-java"><span class="nd">@Inject</span>
+</ul>
+<pre><code class="language-java"><span class="nd">@Inject</span>
<span class="nd">@Named</span><span class="o">(</span><span class="s">"thePortNumber"</span><span class="o">)</span>
<span class="kt">int</span> <span class="n">port</span></code></pre>
<ul>
<li>specifying the parameter value at node startup (using -p inline with the node command, or with the â@â syntax)</li>
-</ul><p>S4 uses an internal Guice module that automatically injects configuration parameters passed through the deploy command to matching <code>@Named</code> parameters.</p>
+</ul>
+<p>S4 uses an internal Guice module that automatically injects configuration parameters passed through the deploy command to matching <code>@Named</code> parameters.</p>
<p>Both application and platform parameters can be overriden. For instance, specifying a custom storage path for the file system based checkpointing mechanism would be passing the <code>s4.checkpointing.filesystem.storageRootPath</code> parameter:</p>
@@ -220,11 +225,12 @@ With contents of the referenced file lik
<h2 id="logging">Logging</h2>
-<p>S4 uses <a href="http://logback.qos.ch/">logback</a>, and <a href="https://git-wip-us.apache.org/repos/asf?p=incubator-s4.git;a=blob_plain;f=subprojects/s4-core/src/main/resources/logback.xml;h=ea8c85a104b475f1b9dea641656e76eb3b6a9d4c;hb=piper">here</a> is the default configuration file. You may tweak this configuration by adding your own logback.xml file in the <code>lib/</code> directory (for a binary release) or in the <code>subprojects/s4-tools/build/install/s4-tools/lib/</code> directory (for a source release or checkout from git).</p></div>
+<p>S4 uses <a href="http://logback.qos.ch/">logback</a>, and <a href="https://git-wip-us.apache.org/repos/asf?p=incubator-s4.git;a=blob_plain;f=subprojects/s4-core/src/main/resources/logback.xml;h=ea8c85a104b475f1b9dea641656e76eb3b6a9d4c;hb=piper">here</a> is the default configuration file. You may tweak this configuration by adding your own logback.xml file in the <code>lib/</code> directory (for a binary release) or in the <code>subprojects/s4-tools/build/install/s4-tools/lib/</code> directory (for a source release or checkout from git).</p>
+</div>
</div>
- <div id='footer'>
- <div class='container'>
- <span class='copyright'>Apache S4 - Copyright 2013 The Apache Software Foundation</span>
+ <div id="footer">
+ <div class="container">
+ <span class="copyright">Apache S4 - Copyright 2013 The Apache Software Foundation</span>
</div>
</div>
</body>
Modified: incubator/s4/site/doc/0.6.0/dev_tips/index.html
URL: http://svn.apache.org/viewvc/incubator/s4/site/doc/0.6.0/dev_tips/index.html?rev=1450926&r1=1450925&r2=1450926&view=diff
==============================================================================
--- incubator/s4/site/doc/0.6.0/dev_tips/index.html (original)
+++ incubator/s4/site/doc/0.6.0/dev_tips/index.html Wed Feb 27 19:15:47 2013
@@ -1,17 +1,16 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
- <head>
- <title>S4: Development tips</title>
- <meta content='text/html; charset=utf-8' http-equiv='Content-Type' />
- <meta content='A general-purpose distributed stream computing platform' name='description' />
- <link href='/style/screen.css' media='screen' rel='stylesheet' type='text/css' />
- <link href='/style/print.css' media='print' rel='stylesheet' type='text/css' />
- <!--[if lt IE 9]>
- <link href='/style/ie.css' media='screen' rel='stylesheet' type='text/css' />
- <![endif]-->
- <link href='/style/style.css' rel='stylesheet' type='text/css' />
- <link href='/style/nav.css' rel='stylesheet' type='text/css' />
- <script type='text/javascript'>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>S4: Development tips</title>
+<meta content="A general-purpose distributed stream computing platform" name="description">
+<link href="../../../style/screen.css" media="screen" rel="stylesheet" type="text/css">
+<link href="../../../style/print.css" media="print" rel="stylesheet" type="text/css">
+<!--[if lt IE 9]>
+ <link href="../../../style/ie.css" media="screen" rel="stylesheet" type="text/css">
+ <![endif]--><link href="../../../style/style.css" rel="stylesheet" type="text/css">
+<link href="../../../style/nav.css" rel="stylesheet" type="text/css">
+<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-19490961-1']);
_gaq.push(['_setDomainName', '.s4.io']);
@@ -21,45 +20,44 @@
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
- </script>
- <link href='/style/coderay.css' rel='stylesheet' type='text/css' />
- <link href='/style/pygmentize.css' rel='stylesheet' type='text/css' />
- </head>
- <body>
- <div id='header'>
- <div class='container'>
- <div id='logo'>
- <a href='/'>
- <img src='/images/s4_test.png' />
- </a>
+ </script><link href="../../../style/coderay.css" rel="stylesheet" type="text/css">
+<link href="../../../style/pygmentize.css" rel="stylesheet" type="text/css">
+</head>
+<body>
+ <div id="header">
+ <div class="container">
+ <div id="logo">
+ <a href="../../../">
+ <img src="../../../images/s4_test.png"></a>
</div>
- <div id='navbar'><ul id='nav'>
- <li>
- <a href='/'>home</a>
+ <div id="navbar"><ul id="nav">
+<li>
+ <a href="../../../">home</a>
</li>
<li>
- <a href='https://cwiki.apache.org/confluence/display/S4/S4+Wiki'>doc [0.5]</a>
+ <a href="https://cwiki.apache.org/confluence/display/S4/S4+Wiki">doc [0.5]</a>
</li>
<li>
- <a href='http://git-wip-us.apache.org/repos/asf?p=incubator-s4.git' onClick="_gaq.push(['_trackEvent', 'External', 'Apache Git', 'http://github.com/s4']);">code</a>
+ <a href="http://git-wip-us.apache.org/repos/asf?p=incubator-s4.git" onclick="_gaq.push(['_trackEvent', 'External', 'Apache Git', 'http://github.com/s4']);">code</a>
</li>
<li>
- <a href='http://people.apache.org/~mmorel/apache-s4-0.5.0-incubating-doc/javadoc/'>API</a>
+ <a href="http://people.apache.org/~mmorel/apache-s4-0.5.0-incubating-doc/javadoc/">API</a>
</li>
<li>
- <a href='/contrib'>get involved</a>
+ <a href="../../../contrib">get involved</a>
</li>
<li>
- <a href='/team'>team</a>
+ <a href="../../../team">team</a>
</li>
<li>
- <a href='/download'>download</a>
+ <a href="../../../download">download</a>
</li>
</ul></div>
</div>
</div>
- <div id='wrapper'>
- <div class='container' id='container'><blockquote>
+ <div id="wrapper">
+ <div class="container" id="container">
+<blockquote>
<p>Here are a few tips to ease the development of S4 applications.</p>
</blockquote>
@@ -80,7 +78,9 @@
</li>
<li>Then run <code>gradlew eclipse</code> or <code>gradlew idea</code>
</li>
-</ul><hr><h1 id="start-a-local-zookeeper-instance">Start a local Zookeeper instance</h1>
+</ul>
+<hr>
+<h1 id="start-a-local-zookeeper-instance">Start a local Zookeeper instance</h1>
<ul>
<li>
@@ -95,7 +95,9 @@
<pre><code> s4 zkServer -clusters=c=testCluster1:flp=12000:nbTasks=1
</code></pre>
</li>
-</ul><hr><h1 id="load-an-application-in-a-new-node-directly-from-an-ide">Load an application in a new node directly from an IDE</h1>
+</ul>
+<hr>
+<h1 id="load-an-application-in-a-new-node-directly-from-an-ide">Load an application in a new node directly from an IDE</h1>
<p>This allows to <em>skip the packaging phase!</em></p>
@@ -108,11 +110,13 @@
</li>
<li>the app class name: <code>-appClass=myAppClass</code>
</li>
-</ul><p>If you use a local Zookeeper instance, there is no need to specify the <code>-zk</code> option.</p></div>
+</ul>
+<p>If you use a local Zookeeper instance, there is no need to specify the <code>-zk</code> option.</p>
+</div>
</div>
- <div id='footer'>
- <div class='container'>
- <span class='copyright'>Apache S4 - Copyright 2013 The Apache Software Foundation</span>
+ <div id="footer">
+ <div class="container">
+ <span class="copyright">Apache S4 - Copyright 2013 The Apache Software Foundation</span>
</div>
</div>
</body>
Modified: incubator/s4/site/doc/0.6.0/event_dispatch/index.html
URL: http://svn.apache.org/viewvc/incubator/s4/site/doc/0.6.0/event_dispatch/index.html?rev=1450926&r1=1450925&r2=1450926&view=diff
==============================================================================
--- incubator/s4/site/doc/0.6.0/event_dispatch/index.html (original)
+++ incubator/s4/site/doc/0.6.0/event_dispatch/index.html Wed Feb 27 19:15:47 2013
@@ -1,17 +1,16 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
- <head>
- <title>S4: Event dispatch</title>
- <meta content='text/html; charset=utf-8' http-equiv='Content-Type' />
- <meta content='A general-purpose distributed stream computing platform' name='description' />
- <link href='/style/screen.css' media='screen' rel='stylesheet' type='text/css' />
- <link href='/style/print.css' media='print' rel='stylesheet' type='text/css' />
- <!--[if lt IE 9]>
- <link href='/style/ie.css' media='screen' rel='stylesheet' type='text/css' />
- <![endif]-->
- <link href='/style/style.css' rel='stylesheet' type='text/css' />
- <link href='/style/nav.css' rel='stylesheet' type='text/css' />
- <script type='text/javascript'>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>S4: Event dispatch</title>
+<meta content="A general-purpose distributed stream computing platform" name="description">
+<link href="../../../style/screen.css" media="screen" rel="stylesheet" type="text/css">
+<link href="../../../style/print.css" media="print" rel="stylesheet" type="text/css">
+<!--[if lt IE 9]>
+ <link href="../../../style/ie.css" media="screen" rel="stylesheet" type="text/css">
+ <![endif]--><link href="../../../style/style.css" rel="stylesheet" type="text/css">
+<link href="../../../style/nav.css" rel="stylesheet" type="text/css">
+<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-19490961-1']);
_gaq.push(['_setDomainName', '.s4.io']);
@@ -21,45 +20,44 @@
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
- </script>
- <link href='/style/coderay.css' rel='stylesheet' type='text/css' />
- <link href='/style/pygmentize.css' rel='stylesheet' type='text/css' />
- </head>
- <body>
- <div id='header'>
- <div class='container'>
- <div id='logo'>
- <a href='/'>
- <img src='/images/s4_test.png' />
- </a>
+ </script><link href="../../../style/coderay.css" rel="stylesheet" type="text/css">
+<link href="../../../style/pygmentize.css" rel="stylesheet" type="text/css">
+</head>
+<body>
+ <div id="header">
+ <div class="container">
+ <div id="logo">
+ <a href="../../../">
+ <img src="../../../images/s4_test.png"></a>
</div>
- <div id='navbar'><ul id='nav'>
- <li>
- <a href='/'>home</a>
+ <div id="navbar"><ul id="nav">
+<li>
+ <a href="../../../">home</a>
</li>
<li>
- <a href='https://cwiki.apache.org/confluence/display/S4/S4+Wiki'>doc [0.5]</a>
+ <a href="https://cwiki.apache.org/confluence/display/S4/S4+Wiki">doc [0.5]</a>
</li>
<li>
- <a href='http://git-wip-us.apache.org/repos/asf?p=incubator-s4.git' onClick="_gaq.push(['_trackEvent', 'External', 'Apache Git', 'http://github.com/s4']);">code</a>
+ <a href="http://git-wip-us.apache.org/repos/asf?p=incubator-s4.git" onclick="_gaq.push(['_trackEvent', 'External', 'Apache Git', 'http://github.com/s4']);">code</a>
</li>
<li>
- <a href='http://people.apache.org/~mmorel/apache-s4-0.5.0-incubating-doc/javadoc/'>API</a>
+ <a href="http://people.apache.org/~mmorel/apache-s4-0.5.0-incubating-doc/javadoc/">API</a>
</li>
<li>
- <a href='/contrib'>get involved</a>
+ <a href="../../../contrib">get involved</a>
</li>
<li>
- <a href='/team'>team</a>
+ <a href="../../../team">team</a>
</li>
<li>
- <a href='/download'>download</a>
+ <a href="../../../download">download</a>
</li>
</ul></div>
</div>
</div>
- <div id='wrapper'>
- <div class='container' id='container'><blockquote>
+ <div id="wrapper">
+ <div class="container" id="container">
+<blockquote>
<p>Exploring how events are dispatched to, from and within S4 nodes</p>
</blockquote>
@@ -72,7 +70,8 @@
<ul>
<li>dispatching events to partitions (<em>outgoing dispatch</em>)</li>
<li>dispatching external events within a partition (<em>incoming dispatch</em>)</li>
-</ul><h1 id="outgoing-dispatch">Outgoing dispatch</h1>
+</ul>
+<h1 id="outgoing-dispatch">Outgoing dispatch</h1>
<p>A stream can be defined with a KeyFinder, as :</p>
@@ -145,13 +144,14 @@
<strong>shedding</strong>: the current event is dropped</li>
<li>
<strong>throttling</strong>, i.e. placing an upper bound on the processing rate, is a convenient way to avoid sending too many messages too fast.</li>
-</ul><p>S4 provides various default implementations of these behaviours and you can also define your own custom executors as appropriate.</p>
+</ul>
+<p>S4 provides various default implementations of these behaviours and you can also define your own custom executors as appropriate.</p>
<h2 id="workflow">workflow</h2>
<p>The following picture illustrates the pipeline of executors.</p>
-<p><img src="/images/doc/0.6.0/executors.png" alt="image"></p>
+<p><img src="../../../images/doc/0.6.0/executors.png" alt="image"></p>
<h3 id="when-a-node-receives-a-message">When a node receives a message:</h3>
@@ -170,7 +170,8 @@
</ul>
</li>
<li>the event is processed in the PE instance that matches the key of the event</li>
-</ol><h3 id="when-a-pe-emits-a-message">When a PE emits a message:</h3>
+</ol>
+<h3 id="when-a-pe-emits-a-message">When a PE emits a message:</h3>
<ol>
<li>an event is passed to a referenced stream</li>
@@ -187,7 +188,8 @@
<li>local sender executors are <strong>throttling</strong> by default, with a configurable maximum rate. If events arrive at a higher rate, they are <strong>dropped</strong>.</li>
</ul>
</li>
-</ol><h2 id="configuration-parameters">configuration parameters</h2>
+</ol>
+<h2 id="configuration-parameters">configuration parameters</h2>
<ul>
<li>blocking executors can lead to deadlocks, depending on the application graph</li>
@@ -197,11 +199,12 @@
</li>
<li>default parameters are specified in <code>default.s4.comm.properties</code>
</li>
-</ul></div>
+</ul>
+</div>
</div>
- <div id='footer'>
- <div class='container'>
- <span class='copyright'>Apache S4 - Copyright 2013 The Apache Software Foundation</span>
+ <div id="footer">
+ <div class="container">
+ <span class="copyright">Apache S4 - Copyright 2013 The Apache Software Foundation</span>
</div>
</div>
</body>
Modified: incubator/s4/site/doc/0.6.0/fault_tolerance/index.html
URL: http://svn.apache.org/viewvc/incubator/s4/site/doc/0.6.0/fault_tolerance/index.html?rev=1450926&r1=1450925&r2=1450926&view=diff
==============================================================================
--- incubator/s4/site/doc/0.6.0/fault_tolerance/index.html (original)
+++ incubator/s4/site/doc/0.6.0/fault_tolerance/index.html Wed Feb 27 19:15:47 2013
@@ -1,17 +1,16 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
- <head>
- <title>S4: Fault tolerance</title>
- <meta content='text/html; charset=utf-8' http-equiv='Content-Type' />
- <meta content='A general-purpose distributed stream computing platform' name='description' />
- <link href='/style/screen.css' media='screen' rel='stylesheet' type='text/css' />
- <link href='/style/print.css' media='print' rel='stylesheet' type='text/css' />
- <!--[if lt IE 9]>
- <link href='/style/ie.css' media='screen' rel='stylesheet' type='text/css' />
- <![endif]-->
- <link href='/style/style.css' rel='stylesheet' type='text/css' />
- <link href='/style/nav.css' rel='stylesheet' type='text/css' />
- <script type='text/javascript'>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>S4: Fault tolerance</title>
+<meta content="A general-purpose distributed stream computing platform" name="description">
+<link href="../../../style/screen.css" media="screen" rel="stylesheet" type="text/css">
+<link href="../../../style/print.css" media="print" rel="stylesheet" type="text/css">
+<!--[if lt IE 9]>
+ <link href="../../../style/ie.css" media="screen" rel="stylesheet" type="text/css">
+ <![endif]--><link href="../../../style/style.css" rel="stylesheet" type="text/css">
+<link href="../../../style/nav.css" rel="stylesheet" type="text/css">
+<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-19490961-1']);
_gaq.push(['_setDomainName', '.s4.io']);
@@ -21,45 +20,44 @@
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
- </script>
- <link href='/style/coderay.css' rel='stylesheet' type='text/css' />
- <link href='/style/pygmentize.css' rel='stylesheet' type='text/css' />
- </head>
- <body>
- <div id='header'>
- <div class='container'>
- <div id='logo'>
- <a href='/'>
- <img src='/images/s4_test.png' />
- </a>
+ </script><link href="../../../style/coderay.css" rel="stylesheet" type="text/css">
+<link href="../../../style/pygmentize.css" rel="stylesheet" type="text/css">
+</head>
+<body>
+ <div id="header">
+ <div class="container">
+ <div id="logo">
+ <a href="../../../">
+ <img src="../../../images/s4_test.png"></a>
</div>
- <div id='navbar'><ul id='nav'>
- <li>
- <a href='/'>home</a>
+ <div id="navbar"><ul id="nav">
+<li>
+ <a href="../../../">home</a>
</li>
<li>
- <a href='https://cwiki.apache.org/confluence/display/S4/S4+Wiki'>doc [0.5]</a>
+ <a href="https://cwiki.apache.org/confluence/display/S4/S4+Wiki">doc [0.5]</a>
</li>
<li>
- <a href='http://git-wip-us.apache.org/repos/asf?p=incubator-s4.git' onClick="_gaq.push(['_trackEvent', 'External', 'Apache Git', 'http://github.com/s4']);">code</a>
+ <a href="http://git-wip-us.apache.org/repos/asf?p=incubator-s4.git" onclick="_gaq.push(['_trackEvent', 'External', 'Apache Git', 'http://github.com/s4']);">code</a>
</li>
<li>
- <a href='http://people.apache.org/~mmorel/apache-s4-0.5.0-incubating-doc/javadoc/'>API</a>
+ <a href="http://people.apache.org/~mmorel/apache-s4-0.5.0-incubating-doc/javadoc/">API</a>
</li>
<li>
- <a href='/contrib'>get involved</a>
+ <a href="../../../contrib">get involved</a>
</li>
<li>
- <a href='/team'>team</a>
+ <a href="../../../team">team</a>
</li>
<li>
- <a href='/download'>download</a>
+ <a href="../../../download">download</a>
</li>
</ul></div>
</div>
</div>
- <div id='wrapper'>
- <div class='container' id='container'><p>Stream processing applications are typically long running applications, and they may accumulate state over extended periods of time.</p>
+ <div id="wrapper">
+ <div class="container" id="container">
+<p>Stream processing applications are typically long running applications, and they may accumulate state over extended periods of time.</p>
<p>When running a distributed system over a long period of time, expect:</p>
@@ -68,7 +66,8 @@
<li>infrastructure updates</li>
<li>scheduled restarts</li>
<li>application updates</li>
-</ul><p>In each of these situations, some or all of S4 nodes will be shutdown. The system may therefore be partly unavailable, and in-memory state accumulated during the execution may be lost.</p>
+</ul>
+<p>In each of these situations, some or all of S4 nodes will be shutdown. The system may therefore be partly unavailable, and in-memory state accumulated during the execution may be lost.</p>
<p>In order to deal with this kind of situation, S4 provides:</p>
@@ -76,7 +75,8 @@
<li>high availability</li>
<li>state recovery (based on checkpointing)</li>
<li>while preserving low processing latency</li>
-</ul><p>In this document, we first describe the high availability mechanism implemented in S4, then we describe the checkpointing and recovery mechanism, and how to customize it, then we describe future improvements.</p>
+</ul>
+<p>In this document, we first describe the high availability mechanism implemented in S4, then we describe the checkpointing and recovery mechanism, and how to customize it, then we describe future improvements.</p>
<h1 id="fail-over-mechanism">Fail-over mechanism</h1>
@@ -84,7 +84,7 @@
<p>The following figure illustrates this fail-over mechanism: </p>
-<p><img src="/images/doc/0.6.0/failover.png" alt="image"></p>
+<p><img src="../../../images/doc/0.6.0/failover.png" alt="image"></p>
<p>This technique provides high availability but does not prevent state loss.</p>
@@ -115,7 +115,8 @@
<em>periodically checkpoint</em> the state of PEs across the S4 cluster</li>
<li>
<em>lazily recover</em> (triggered by messages)</li>
-</ul><p>This means that if there is a previous state that was checkpointed, and that a new PE is instantiated because a new key is seen, the PE instance will fetch the corresponding checkpoint, recover the corresponding state, and only then start processing events. State loss is minimal!</p>
+</ul>
+<p>This means that if there is a previous state that was checkpointed, and that a new PE is instantiated because a new key is seen, the PE instance will fetch the corresponding checkpoint, recover the corresponding state, and only then start processing events. State loss is minimal!</p>
<h3 id="design">Design</h3>
@@ -130,9 +131,10 @@ Asynchronous checkpointing aims at minim
<ul>
<li>serialize the PE instance</li>
<li>save the serialized PE instance to remote storage</li>
-</ul><p>The following figure shows the various components involved: the checkpointing framework handles the serialization and passes serialized state to a pluggable storage backend:</p>
+</ul>
+<p>The following figure shows the various components involved: the checkpointing framework handles the serialization and passes serialized state to a pluggable storage backend:</p>
-<p><img src="/images/doc/0.6.0/checkpointing-framework.png" alt="image"></p>
+<p><img src="../../../images/doc/0.6.0/checkpointing-framework.png" alt="image"></p>
<h5 id="recovery">Recovery</h5>
@@ -148,7 +150,8 @@ When a message for a new key arrives in
<ul>
<li>the PE class provides an empty no-arg constructor (that restriction should be lifted in next releases)</li>
<li>it has non transient serializable fields (and by opposition, transient fields will never be checkpointed)</li>
-</ul><h5 id="checkpointing-application-configuration">Checkpointing application configuration</h5>
+</ul>
+<h5 id="checkpointing-application-configuration">Checkpointing application configuration</h5>
<p>Checkpointing intervals are defined per prototype, in time intervals or event counts (for now). This is specified in the application module, using API methods from the ProcessingElement class, and passing a CheckpointingConfiguration object. Please refer to the API documentation.</p>
@@ -220,11 +223,12 @@ When a message for a new key arrives in
<li>s4.checkpointing.fetchingDisabledDurationMs (default = 600000)</li>
</ul>
</li>
-</ul></div>
+</ul>
+</div>
</div>
- <div id='footer'>
- <div class='container'>
- <span class='copyright'>Apache S4 - Copyright 2013 The Apache Software Foundation</span>
+ <div id="footer">
+ <div class="container">
+ <span class="copyright">Apache S4 - Copyright 2013 The Apache Software Foundation</span>
</div>
</div>
</body>
Modified: incubator/s4/site/doc/0.6.0/index.html
URL: http://svn.apache.org/viewvc/incubator/s4/site/doc/0.6.0/index.html?rev=1450926&r1=1450925&r2=1450926&view=diff
==============================================================================
--- incubator/s4/site/doc/0.6.0/index.html (original)
+++ incubator/s4/site/doc/0.6.0/index.html Wed Feb 27 19:15:47 2013
@@ -1,17 +1,16 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
- <head>
- <title>S4: S4 0.6.0</title>
- <meta content='text/html; charset=utf-8' http-equiv='Content-Type' />
- <meta content='A general-purpose distributed stream computing platform' name='description' />
- <link href='/style/screen.css' media='screen' rel='stylesheet' type='text/css' />
- <link href='/style/print.css' media='print' rel='stylesheet' type='text/css' />
- <!--[if lt IE 9]>
- <link href='/style/ie.css' media='screen' rel='stylesheet' type='text/css' />
- <![endif]-->
- <link href='/style/style.css' rel='stylesheet' type='text/css' />
- <link href='/style/nav.css' rel='stylesheet' type='text/css' />
- <script type='text/javascript'>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>S4: S4 0.6.0</title>
+<meta content="A general-purpose distributed stream computing platform" name="description">
+<link href="../../style/screen.css" media="screen" rel="stylesheet" type="text/css">
+<link href="../../style/print.css" media="print" rel="stylesheet" type="text/css">
+<!--[if lt IE 9]>
+ <link href="../../style/ie.css" media="screen" rel="stylesheet" type="text/css">
+ <![endif]--><link href="../../style/style.css" rel="stylesheet" type="text/css">
+<link href="../../style/nav.css" rel="stylesheet" type="text/css">
+<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-19490961-1']);
_gaq.push(['_setDomainName', '.s4.io']);
@@ -21,45 +20,44 @@
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
- </script>
- <link href='/style/coderay.css' rel='stylesheet' type='text/css' />
- <link href='/style/pygmentize.css' rel='stylesheet' type='text/css' />
- </head>
- <body>
- <div id='header'>
- <div class='container'>
- <div id='logo'>
- <a href='/'>
- <img src='/images/s4_test.png' />
- </a>
+ </script><link href="../../style/coderay.css" rel="stylesheet" type="text/css">
+<link href="../../style/pygmentize.css" rel="stylesheet" type="text/css">
+</head>
+<body>
+ <div id="header">
+ <div class="container">
+ <div id="logo">
+ <a href="../../">
+ <img src="../../images/s4_test.png"></a>
</div>
- <div id='navbar'><ul id='nav'>
- <li>
- <a href='/'>home</a>
+ <div id="navbar"><ul id="nav">
+<li>
+ <a href="../../">home</a>
</li>
<li>
- <a href='https://cwiki.apache.org/confluence/display/S4/S4+Wiki'>doc [0.5]</a>
+ <a href="https://cwiki.apache.org/confluence/display/S4/S4+Wiki">doc [0.5]</a>
</li>
<li>
- <a href='http://git-wip-us.apache.org/repos/asf?p=incubator-s4.git' onClick="_gaq.push(['_trackEvent', 'External', 'Apache Git', 'http://github.com/s4']);">code</a>
+ <a href="http://git-wip-us.apache.org/repos/asf?p=incubator-s4.git" onclick="_gaq.push(['_trackEvent', 'External', 'Apache Git', 'http://github.com/s4']);">code</a>
</li>
<li>
- <a href='http://people.apache.org/~mmorel/apache-s4-0.5.0-incubating-doc/javadoc/'>API</a>
+ <a href="http://people.apache.org/~mmorel/apache-s4-0.5.0-incubating-doc/javadoc/">API</a>
</li>
<li>
- <a href='/contrib'>get involved</a>
+ <a href="../../contrib">get involved</a>
</li>
<li>
- <a href='/team'>team</a>
+ <a href="../../team">team</a>
</li>
<li>
- <a href='/download'>download</a>
+ <a href="../../download">download</a>
</li>
</ul></div>
</div>
</div>
- <div id='wrapper'>
- <div class='container' id='container'><blockquote>
+ <div id="wrapper">
+ <div class="container" id="container">
+<blockquote>
<p>This is the documentation for S4 0.6.0. For previous versions, please refer to the <a href="https://cwiki.apache.org/confluence/display/S4/S4+Wiki">wiki</a></p>
</blockquote>
@@ -71,7 +69,8 @@
<li>You may start with an <a href="overview">overview</a> of the platform</li>
<li>Then follow a <a href="walkthrough">walkthrough</a> for an hands-on introduction</li>
<li>And <a href="dev_tips">here</a> are some tips to ease the development process</li>
-</ul><h2 id="configuration">Configuration</h2>
+</ul>
+<h2 id="configuration">Configuration</h2>
<ul>
<li><a href="configuration">Customize the platform and pass configuration parameters</a></li>
@@ -81,23 +80,26 @@
<a href="event_dispatch">Dispatch events </a> within an application and between applications</li>
<li>
<a href="metrics">Monitor</a> the system</li>
-</ul><h2 id="features">Features</h2>
+</ul>
+<h2 id="features">Features</h2>
<ul>
<li>Details about <a href="fault_tolerance">fault tolerance</a>
</li>
-</ul><h2 id="troubleshooting">Troubleshooting</h2>
+</ul>
+<h2 id="troubleshooting">Troubleshooting</h2>
<ul>
<li>Try the <a href="https://cwiki.apache.org/confluence/display/S4/FAQ">FAQ</a>
</li>
<li>Try the <a href="https://cwiki.apache.org/S4/s4-apache-mailing-lists.html">mailing lists</a>
</li>
-</ul></div>
+</ul>
+</div>
</div>
- <div id='footer'>
- <div class='container'>
- <span class='copyright'>Apache S4 - Copyright 2013 The Apache Software Foundation</span>
+ <div id="footer">
+ <div class="container">
+ <span class="copyright">Apache S4 - Copyright 2013 The Apache Software Foundation</span>
</div>
</div>
</body>
Modified: incubator/s4/site/doc/0.6.0/metrics/index.html
URL: http://svn.apache.org/viewvc/incubator/s4/site/doc/0.6.0/metrics/index.html?rev=1450926&r1=1450925&r2=1450926&view=diff
==============================================================================
--- incubator/s4/site/doc/0.6.0/metrics/index.html (original)
+++ incubator/s4/site/doc/0.6.0/metrics/index.html Wed Feb 27 19:15:47 2013
@@ -1,17 +1,16 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
- <head>
- <title>S4: Metrics</title>
- <meta content='text/html; charset=utf-8' http-equiv='Content-Type' />
- <meta content='A general-purpose distributed stream computing platform' name='description' />
- <link href='/style/screen.css' media='screen' rel='stylesheet' type='text/css' />
- <link href='/style/print.css' media='print' rel='stylesheet' type='text/css' />
- <!--[if lt IE 9]>
- <link href='/style/ie.css' media='screen' rel='stylesheet' type='text/css' />
- <![endif]-->
- <link href='/style/style.css' rel='stylesheet' type='text/css' />
- <link href='/style/nav.css' rel='stylesheet' type='text/css' />
- <script type='text/javascript'>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>S4: Metrics</title>
+<meta content="A general-purpose distributed stream computing platform" name="description">
+<link href="../../../style/screen.css" media="screen" rel="stylesheet" type="text/css">
+<link href="../../../style/print.css" media="print" rel="stylesheet" type="text/css">
+<!--[if lt IE 9]>
+ <link href="../../../style/ie.css" media="screen" rel="stylesheet" type="text/css">
+ <![endif]--><link href="../../../style/style.css" rel="stylesheet" type="text/css">
+<link href="../../../style/nav.css" rel="stylesheet" type="text/css">
+<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-19490961-1']);
_gaq.push(['_setDomainName', '.s4.io']);
@@ -21,45 +20,44 @@
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
- </script>
- <link href='/style/coderay.css' rel='stylesheet' type='text/css' />
- <link href='/style/pygmentize.css' rel='stylesheet' type='text/css' />
- </head>
- <body>
- <div id='header'>
- <div class='container'>
- <div id='logo'>
- <a href='/'>
- <img src='/images/s4_test.png' />
- </a>
+ </script><link href="../../../style/coderay.css" rel="stylesheet" type="text/css">
+<link href="../../../style/pygmentize.css" rel="stylesheet" type="text/css">
+</head>
+<body>
+ <div id="header">
+ <div class="container">
+ <div id="logo">
+ <a href="../../../">
+ <img src="../../../images/s4_test.png"></a>
</div>
- <div id='navbar'><ul id='nav'>
- <li>
- <a href='/'>home</a>
+ <div id="navbar"><ul id="nav">
+<li>
+ <a href="../../../">home</a>
</li>
<li>
- <a href='https://cwiki.apache.org/confluence/display/S4/S4+Wiki'>doc [0.5]</a>
+ <a href="https://cwiki.apache.org/confluence/display/S4/S4+Wiki">doc [0.5]</a>
</li>
<li>
- <a href='http://git-wip-us.apache.org/repos/asf?p=incubator-s4.git' onClick="_gaq.push(['_trackEvent', 'External', 'Apache Git', 'http://github.com/s4']);">code</a>
+ <a href="http://git-wip-us.apache.org/repos/asf?p=incubator-s4.git" onclick="_gaq.push(['_trackEvent', 'External', 'Apache Git', 'http://github.com/s4']);">code</a>
</li>
<li>
- <a href='http://people.apache.org/~mmorel/apache-s4-0.5.0-incubating-doc/javadoc/'>API</a>
+ <a href="http://people.apache.org/~mmorel/apache-s4-0.5.0-incubating-doc/javadoc/">API</a>
</li>
<li>
- <a href='/contrib'>get involved</a>
+ <a href="../../../contrib">get involved</a>
</li>
<li>
- <a href='/team'>team</a>
+ <a href="../../../team">team</a>
</li>
<li>
- <a href='/download'>download</a>
+ <a href="../../../download">download</a>
</li>
</ul></div>
</div>
</div>
- <div id='wrapper'>
- <div class='container' id='container'><blockquote>
+ <div id="wrapper">
+ <div class="container" id="container">
+<blockquote>
<p>S4 continuously collects runtime statistics. Letâs see how to access these and add custom ones.</p>
</blockquote>
@@ -96,11 +94,12 @@ csv:file://path/to/directory:10:SECONDS
console:1:MINUTES
</code></pre>
-<p>Reporting to Ganglia or Graphite is not provided out of the box with S4, but itâs quite easy to add. You simply have to add the corresponding dependencies to your project and enable reporting to these systems during the initialization of your application. See the <a href="http://metrics.codahale.com">metrics</a> documentation for more information.</p></div>
+<p>Reporting to Ganglia or Graphite is not provided out of the box with S4, but itâs quite easy to add. You simply have to add the corresponding dependencies to your project and enable reporting to these systems during the initialization of your application. See the <a href="http://metrics.codahale.com">metrics</a> documentation for more information.</p>
+</div>
</div>
- <div id='footer'>
- <div class='container'>
- <span class='copyright'>Apache S4 - Copyright 2013 The Apache Software Foundation</span>
+ <div id="footer">
+ <div class="container">
+ <span class="copyright">Apache S4 - Copyright 2013 The Apache Software Foundation</span>
</div>
</div>
</body>
Modified: incubator/s4/site/doc/0.6.0/overview/index.html
URL: http://svn.apache.org/viewvc/incubator/s4/site/doc/0.6.0/overview/index.html?rev=1450926&r1=1450925&r2=1450926&view=diff
==============================================================================
--- incubator/s4/site/doc/0.6.0/overview/index.html (original)
+++ incubator/s4/site/doc/0.6.0/overview/index.html Wed Feb 27 19:15:47 2013
@@ -1,17 +1,16 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
- <head>
- <title>S4: S4 0.6.0 overview</title>
- <meta content='text/html; charset=utf-8' http-equiv='Content-Type' />
- <meta content='A general-purpose distributed stream computing platform' name='description' />
- <link href='/style/screen.css' media='screen' rel='stylesheet' type='text/css' />
- <link href='/style/print.css' media='print' rel='stylesheet' type='text/css' />
- <!--[if lt IE 9]>
- <link href='/style/ie.css' media='screen' rel='stylesheet' type='text/css' />
- <![endif]-->
- <link href='/style/style.css' rel='stylesheet' type='text/css' />
- <link href='/style/nav.css' rel='stylesheet' type='text/css' />
- <script type='text/javascript'>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>S4: S4 0.6.0 overview</title>
+<meta content="A general-purpose distributed stream computing platform" name="description">
+<link href="../../../style/screen.css" media="screen" rel="stylesheet" type="text/css">
+<link href="../../../style/print.css" media="print" rel="stylesheet" type="text/css">
+<!--[if lt IE 9]>
+ <link href="../../../style/ie.css" media="screen" rel="stylesheet" type="text/css">
+ <![endif]--><link href="../../../style/style.css" rel="stylesheet" type="text/css">
+<link href="../../../style/nav.css" rel="stylesheet" type="text/css">
+<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-19490961-1']);
_gaq.push(['_setDomainName', '.s4.io']);
@@ -21,45 +20,44 @@
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
- </script>
- <link href='/style/coderay.css' rel='stylesheet' type='text/css' />
- <link href='/style/pygmentize.css' rel='stylesheet' type='text/css' />
- </head>
- <body>
- <div id='header'>
- <div class='container'>
- <div id='logo'>
- <a href='/'>
- <img src='/images/s4_test.png' />
- </a>
+ </script><link href="../../../style/coderay.css" rel="stylesheet" type="text/css">
+<link href="../../../style/pygmentize.css" rel="stylesheet" type="text/css">
+</head>
+<body>
+ <div id="header">
+ <div class="container">
+ <div id="logo">
+ <a href="../../../">
+ <img src="../../../images/s4_test.png"></a>
</div>
- <div id='navbar'><ul id='nav'>
- <li>
- <a href='/'>home</a>
+ <div id="navbar"><ul id="nav">
+<li>
+ <a href="../../../">home</a>
</li>
<li>
- <a href='https://cwiki.apache.org/confluence/display/S4/S4+Wiki'>doc [0.5]</a>
+ <a href="https://cwiki.apache.org/confluence/display/S4/S4+Wiki">doc [0.5]</a>
</li>
<li>
- <a href='http://git-wip-us.apache.org/repos/asf?p=incubator-s4.git' onClick="_gaq.push(['_trackEvent', 'External', 'Apache Git', 'http://github.com/s4']);">code</a>
+ <a href="http://git-wip-us.apache.org/repos/asf?p=incubator-s4.git" onclick="_gaq.push(['_trackEvent', 'External', 'Apache Git', 'http://github.com/s4']);">code</a>
</li>
<li>
- <a href='http://people.apache.org/~mmorel/apache-s4-0.5.0-incubating-doc/javadoc/'>API</a>
+ <a href="http://people.apache.org/~mmorel/apache-s4-0.5.0-incubating-doc/javadoc/">API</a>
</li>
<li>
- <a href='/contrib'>get involved</a>
+ <a href="../../../contrib">get involved</a>
</li>
<li>
- <a href='/team'>team</a>
+ <a href="../../../team">team</a>
</li>
<li>
- <a href='/download'>download</a>
+ <a href="../../../download">download</a>
</li>
</ul></div>
</div>
</div>
- <div id='wrapper'>
- <div class='container' id='container'><h1 id="what-is-s4">What is S4?</h1>
+ <div id="wrapper">
+ <div class="container" id="container">
+<h1 id="what-is-s4">What is S4?</h1>
<p>S4 is a general-purpose,near real-time, distributed, decentralized, scalable, event-driven, modular platform that allows programmers to easily implement applications for processing continuous unbounded streams of data.</p>
@@ -73,7 +71,8 @@
<li>improved [configurability](S4:Configuration - 0.6.0], for both the S4 platform and deployed applications</li>
<li>
<strong>elasticity</strong> and fine partition tuning, through an integration with Apache Helix</li>
-</ul><h1 id="what-are-the-cool-features">What are the cool features?</h1>
+</ul>
+<h1 id="what-are-the-cool-features">What are the cool features?</h1>
<p><strong>Flexible deployment</strong>:</p>
@@ -82,14 +81,16 @@
<li>By default keys are homogeneously sparsed over the cluster: helps balance the load, especially for fine grained partitioning</li>
<li>S4 also provides fine control over the partitioning (with Apache Helix)</li>
<li>Semi-automatic Rebalancing</li>
-</ul><p><strong>Modular design</strong>:</p>
+</ul>
+<p><strong>Modular design</strong>:</p>
<ul>
<li>both the platform and the applications are built by dependency injection, and configured through independent modules.</li>
<li>makes it <strong>easy to customize</strong> the system according to specific requirements</li>
<li>pluggable event serving policies: <strong>load shedding, throttling, blocking</strong>
</li>
-</ul><p><strong>Dynamic and loose coupling of S4 applications</strong>:</p>
+</ul>
+<p><strong>Dynamic and loose coupling of S4 applications</strong>:</p>
<ul>
<li>through a pub-sub mechanism</li>
@@ -101,14 +102,16 @@
<li>provision, control and update subsystems independently</li>
</ul>
</li>
-</ul><p><strong><a href="fault_tolerance">Fault tolerant</a></strong></p>
+</ul>
+<p><strong><a href="fault_tolerance">Fault tolerant</a></strong></p>
<ul>
<li>
<strong>Fail-over</strong> mechanism for high availability</li>
<li>
<strong>Checkpointing and recovery</strong> mechanism for minimizing state loss</li>
-</ul><p><strong>Pure Java</strong>: statically typed, easy to understand, to refactor, and to extend</p>
+</ul>
+<p><strong>Pure Java</strong>: statically typed, easy to understand, to refactor, and to extend</p>
<h1 id="how-does-it-work">How does it work?</h1>
@@ -129,7 +132,8 @@
<li>an ongoing integration with <a href="http://helix.apache.org">Apache Helix</a> removes these limitations and allows a variable number of nodes and a rebalancing of partitions</li>
</ul>
</li>
-</ul><p><strong>Applications</strong></p>
+</ul>
+<p><strong>Applications</strong></p>
<ul>
<li>Users develop applications and deploy them on S4 clusters</li>
@@ -144,19 +148,21 @@
<li>PEs communicate asynchronously by sending <strong>events</strong> on streams.</li>
<li>Events are dispatched to nodes according to their <strong>key</strong>
</li>
-</ul><p><strong>External streams</strong> are a special kind of stream that:</p>
+</ul>
+<p><strong>External streams</strong> are a special kind of stream that:</p>
<ul>
<li>send events outside of the application</li>
<li>receive events from external sources</li>
<li>can interconnect and assemble applications into larger systems.</li>
-</ul><p><strong>Adapters</strong> are S4 applications that can convert external streams into streams of S4 events. Since adapters are also S4 applications, they can be scaled easily.</p>
+</ul>
+<p><strong>Adapters</strong> are S4 applications that can convert external streams into streams of S4 events. Since adapters are also S4 applications, they can be scaled easily.</p>
<h2 id="a-hierarchical-perspective-on-s4">A hierarchical perspective on S4</h2>
<p>The following diagram sums-up the key concepts in a hierarchical fashion:</p>
-<p><img src="/images/doc/0.6.0/S4_hierarchical_archi.png" alt="image"></p>
+<p><img src="../../../images/doc/0.6.0/S4_hierarchical_archi.png" alt="image"></p>
<h1 id="where-can-i-find-more-information">Where can I find more information?</h1>
@@ -170,11 +176,12 @@
<li>The source code is available throught [git](https://git-wip-us.apache.org/repos/asf?p=incubator-s4.git], <a href="http://incubator.apache.org/s4/contrib/">here</a> are instructions for fetching the code.</li>
<li>A nice set of <a href="http://www.slideshare.net/leoneu/20111104-s4-overview">slides</a> was used for a presentation at Stanford in November 2011.</li>
<li>The driving ideas are detailed in a <a href="http://www.4lunas.org/pub/2010-s4.pdf">conference publication</a> from KDCloudâ11 (joint workshop with ICDMâ11)</li>
-</ul></div>
+</ul>
+</div>
</div>
- <div id='footer'>
- <div class='container'>
- <span class='copyright'>Apache S4 - Copyright 2013 The Apache Software Foundation</span>
+ <div id="footer">
+ <div class="container">
+ <span class="copyright">Apache S4 - Copyright 2013 The Apache Software Foundation</span>
</div>
</div>
</body>
Modified: incubator/s4/site/doc/0.6.0/walkthrough/index.html
URL: http://svn.apache.org/viewvc/incubator/s4/site/doc/0.6.0/walkthrough/index.html?rev=1450926&r1=1450925&r2=1450926&view=diff
==============================================================================
--- incubator/s4/site/doc/0.6.0/walkthrough/index.html (original)
+++ incubator/s4/site/doc/0.6.0/walkthrough/index.html Wed Feb 27 19:15:47 2013
@@ -1,17 +1,16 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
- <head>
- <title>S4: Walkthrough</title>
- <meta content='text/html; charset=utf-8' http-equiv='Content-Type' />
- <meta content='A general-purpose distributed stream computing platform' name='description' />
- <link href='/style/screen.css' media='screen' rel='stylesheet' type='text/css' />
- <link href='/style/print.css' media='print' rel='stylesheet' type='text/css' />
- <!--[if lt IE 9]>
- <link href='/style/ie.css' media='screen' rel='stylesheet' type='text/css' />
- <![endif]-->
- <link href='/style/style.css' rel='stylesheet' type='text/css' />
- <link href='/style/nav.css' rel='stylesheet' type='text/css' />
- <script type='text/javascript'>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>S4: Walkthrough</title>
+<meta content="A general-purpose distributed stream computing platform" name="description">
+<link href="../../../style/screen.css" media="screen" rel="stylesheet" type="text/css">
+<link href="../../../style/print.css" media="print" rel="stylesheet" type="text/css">
+<!--[if lt IE 9]>
+ <link href="../../../style/ie.css" media="screen" rel="stylesheet" type="text/css">
+ <![endif]--><link href="../../../style/style.css" rel="stylesheet" type="text/css">
+<link href="../../../style/nav.css" rel="stylesheet" type="text/css">
+<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-19490961-1']);
_gaq.push(['_setDomainName', '.s4.io']);
@@ -21,45 +20,44 @@
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
- </script>
- <link href='/style/coderay.css' rel='stylesheet' type='text/css' />
- <link href='/style/pygmentize.css' rel='stylesheet' type='text/css' />
- </head>
- <body>
- <div id='header'>
- <div class='container'>
- <div id='logo'>
- <a href='/'>
- <img src='/images/s4_test.png' />
- </a>
+ </script><link href="../../../style/coderay.css" rel="stylesheet" type="text/css">
+<link href="../../../style/pygmentize.css" rel="stylesheet" type="text/css">
+</head>
+<body>
+ <div id="header">
+ <div class="container">
+ <div id="logo">
+ <a href="../../../">
+ <img src="../../../images/s4_test.png"></a>
</div>
- <div id='navbar'><ul id='nav'>
- <li>
- <a href='/'>home</a>
+ <div id="navbar"><ul id="nav">
+<li>
+ <a href="../../../">home</a>
</li>
<li>
- <a href='https://cwiki.apache.org/confluence/display/S4/S4+Wiki'>doc [0.5]</a>
+ <a href="https://cwiki.apache.org/confluence/display/S4/S4+Wiki">doc [0.5]</a>
</li>
<li>
- <a href='http://git-wip-us.apache.org/repos/asf?p=incubator-s4.git' onClick="_gaq.push(['_trackEvent', 'External', 'Apache Git', 'http://github.com/s4']);">code</a>
+ <a href="http://git-wip-us.apache.org/repos/asf?p=incubator-s4.git" onclick="_gaq.push(['_trackEvent', 'External', 'Apache Git', 'http://github.com/s4']);">code</a>
</li>
<li>
- <a href='http://people.apache.org/~mmorel/apache-s4-0.5.0-incubating-doc/javadoc/'>API</a>
+ <a href="http://people.apache.org/~mmorel/apache-s4-0.5.0-incubating-doc/javadoc/">API</a>
</li>
<li>
- <a href='/contrib'>get involved</a>
+ <a href="../../../contrib">get involved</a>
</li>
<li>
- <a href='/team'>team</a>
+ <a href="../../../team">team</a>
</li>
<li>
- <a href='/download'>download</a>
+ <a href="../../../download">download</a>
</li>
</ul></div>
</div>
</div>
- <div id='wrapper'>
- <div class='container' id='container'><blockquote>
+ <div id="wrapper">
+ <div class="container" id="container">
+<blockquote>
<p>Improvements from S4 0.5.0 include a more convenient configuration system, illustrated here: all platform and application parameters are specified when configuring/deploying the app.</p>
</blockquote>
@@ -70,13 +68,15 @@
<ul>
<li>
<a href="http://incubator.apache.org/s4/download/">Download</a> the 0.6.0 release </li>
-</ul><blockquote>
+</ul>
+<blockquote>
<p>We recommend getting the âsourceâ release and building it</p>
</blockquote>
<ul>
-<li>or checkout from the Apache git repository, by following the <a href="/contrib">instructions</a>. The 0.6.0 tag corresponds to the current release.</li>
-</ul><p>If you get the binary release, s4 scripts are immediately available. Otherwise you must build the project:</p>
+<li>or checkout from the Apache git repository, by following the <a href="../../../contrib">instructions</a>. The 0.6.0 tag corresponds to the current release.</li>
+</ul>
+<p>If you get the binary release, s4 scripts are immediately available. Otherwise you must build the project:</p>
<ul>
<li>
@@ -94,7 +94,9 @@
...:s4-tools:installApp
</code></pre>
</li>
-</ul><hr><h1 id="start-a-new-application">Start a new application</h1>
+</ul>
+<hr>
+<h1 id="start-a-new-application">Start a new application</h1>
<p>S4 provides some scripts in order to simplify development and testing of applications. Letâs see how to create a new project and start a sample application.</p>
@@ -117,13 +119,15 @@
src/ --> sources (maven-like structure)
</code></pre>
</li>
-</ul><h2 id="have-a-look-at-the-sample-project-content">Have a look at the sample project content</h2>
+</ul>
+<h2 id="have-a-look-at-the-sample-project-content">Have a look at the sample project content</h2>
<p>The src/main/java/hello directory contains 3 files:</p>
<ul>
<li>HelloPE.java : a very simple PE that simply prints the name contained in incoming events</li>
-</ul><pre><code class="language-java"><span class="c1">// ProcessingElement provides integration with the S4 platform</span>
+</ul>
+<pre><code class="language-java"><span class="c1">// ProcessingElement provides integration with the S4 platform</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">HelloPE</span> <span class="kd">extends</span> <span class="n">ProcessingElement</span> <span class="o">{</span>
<span class="c1">// you should define downstream streams here and inject them in the app definition</span>
@@ -142,7 +146,8 @@
<li>HelloApp.java: defines a simple application: exposes an input stream (ânamesâ), connected to the HelloPE. See <a href="event_dispatch">the event dispatch configuration page</a> for more information about how events are dispatched.
// App parent class provides integration with the S4 platform
public class HelloApp extends App {</li>
-</ul><pre><code class="language-java"><span class="nd">@Override</span>
+</ul>
+<pre><code class="language-java"><span class="nd">@Override</span>
<span class="kd">protected</span> <span class="kt">void</span> <span class="nf">onStart</span><span class="o">()</span> <span class="o">{</span>
<span class="o">}</span>
@@ -164,7 +169,8 @@
<ul>
<li>HelloInputAdapter is a simple adapter that reads character lines from a socket, converts them into events, and sends the events to interested S4 apps, through the ânamesâ stream</li>
-</ul><h2 id="run-the-sample-app">Run the sample app</h2>
+</ul>
+<h2 id="run-the-sample-app">Run the sample app</h2>
<p>In order to run an S4 application, you need :</p>
@@ -172,7 +178,8 @@
<li>to set-up a cluster: provision a cluster and start S4 nodes for that cluster</li>
<li>to package the app</li>
<li>to publish the app on the cluster</li>
-</ul><h1 id="set-up-the-cluster">Set-up the cluster:</h1>
+</ul>
+<h1 id="set-up-the-cluster">Set-up the cluster:</h1>
<ul>
<li>
@@ -190,7 +197,8 @@
</li>
</ol>
</li>
-</ul><ol>
+</ul>
+<ol>
<li>
<p>Define a new cluster. Say a cluster named âcluster1â with 2 partitions, nodes listening to ports starting from 12000:</p>
@@ -200,13 +208,16 @@
[main] INFO org.apache.s4.tools.DefineCluster - New cluster configuration uploaded into zookeeper
</code></pre>
</li>
-</ol><ul>
+</ol>
+<ul>
<li>Alternatively you may combine these two steps into a single one, by passing the cluster configuration inline with the <code>zkServer</code> command:</li>
-</ul><pre><code class="language-bash">S4:incubator-s4<span class="nv">$ </span>./s4 zkServer -clusters<span class="o">=</span><span class="nv">c</span><span class="o">=</span>cluster1:flp<span class="o">=</span>12000:nbTasks<span class="o">=</span>2 -clean</code></pre>
+</ul>
+<pre><code class="language-bash">S4:incubator-s4<span class="nv">$ </span>./s4 zkServer -clusters<span class="o">=</span><span class="nv">c</span><span class="o">=</span>cluster1:flp<span class="o">=</span>12000:nbTasks<span class="o">=</span>2 -clean</code></pre>
<ul>
<li>Start 2 S4 nodes with the default configuration, and attach them to cluster âcluster1â :</li>
-</ul><pre><code class="language-bash">S4:myApp<span class="nv">$ </span>./s4 node -c<span class="o">=</span>cluster1
+</ul>
+<pre><code class="language-bash">S4:myApp<span class="nv">$ </span>./s4 node -c<span class="o">=</span>cluster1
calling referenced s4 script : /Users/S4/tmp/incubator-s4/s4
15:50:18.996 <span class="o">[</span>main<span class="o">]</span> INFO org.apache.s4.core.Main - Initializing S4 node with :
- comm module class <span class="o">[</span>org.apache.s4.comm.DefaultCommModule<span class="o">]</span>
@@ -267,7 +278,8 @@ Again specifying the app class is option
[ZkClient-EventThread-15-localhost:2181] INFO org.apache.s4.core.App - Init prototype [hello.HelloPE].
</code></pre>
</li>
-</ul><p>Great! The application is now deployed on 2 S4 nodes.</p>
+</ul>
+<p>Great! The application is now deployed on 2 S4 nodes.</p>
<p>You can check the status of the application, nodes and streams with the âstatusâ command:</p>
@@ -282,7 +294,8 @@ Again specifying the app class is option
<li>the adapter class</li>
<li>the name of the output stream</li>
<li>the cluster where to deploy this app</li>
-</ul><p>For easy testing, we provide a facility to start a node with an adapter app without having to package the adapter app.</p>
+</ul>
+<p>For easy testing, we provide a facility to start a node with an adapter app without having to package the adapter app.</p>
<ul>
<li>
@@ -322,7 +335,8 @@ Again specifying the app class is option
<pre><code> Hello Bob!
</code></pre>
</li>
-</ul><blockquote>
+</ul>
+<blockquote>
<p>If you keep sending messages, nodes will alternatively display the âhelloâ messages because the adapter app sends keyless events on the ânamesâ stream in a round-robin fashion by default.</p>
</blockquote>
@@ -330,9 +344,10 @@ Again specifying the app class is option
<p>The following figures illustrate the various steps we have taken. The local file system is used as the S4 application repository in our example.</p>
-<p><img src="/images/doc/0.6.0/sampleAppDeployment.png" alt="image"></p>
+<p><img src="../../../images/doc/0.6.0/sampleAppDeployment.png" alt="image"></p>
-<hr><h1 id="run-the-twitter-trending-example">Run the Twitter trending example</h1>
+<hr>
+<h1 id="run-the-twitter-trending-example">Run the Twitter trending example</h1>
<p>Letâs have a look at another application, that computes trendy Twitter topics by listening to the spritzer stream from the Twitter API. This application was adapted from a previous example in S4 0.3.</p>
@@ -343,12 +358,14 @@ Again specifying the app class is option
<ul>
<li>twitter-counter , in test-apps/twitter-counter/ : extracts topics from tweets and maintains a count of the most popular ones, periodically dumped to disk</li>
<li>twitter-adapter, in test-apps/twitter-adapter/ : listens to the feed from Twitter, converts status text into S4 events, and passes them to the âRawStatusâ stream</li>
-</ul><p>Have a look at the code in these directories. Youâll note that:</p>
+</ul>
+<p>Have a look at the code in these directories. Youâll note that:</p>
<ul>
<li>the build.gradle file must be tailored to include new dependencies (twitter4j libs in twitter-adapter)</li>
<li>events are partitioned through various keys</li>
-</ul><h2 id="run-it">Run it!</h2>
+</ul>
+<h2 id="run-it">Run it!</h2>
<blockquote>
<p>Note: You need a twitter4j.properties file in your home directory with the following content (debug is optional):</p>
@@ -409,7 +426,9 @@ password=<matching password>
<pre><code> ./s4 status
</code></pre>
</li>
-</ul><hr><h1 id="what-next">What next?</h1>
+</ul>
+<hr>
+<h1 id="what-next">What next?</h1>
<p>You have now seen some basics applications, and you know how to run them, and how to get events into the system. You may now try to code your own apps with your own data.</p>
@@ -421,11 +440,12 @@ password=<matching password>
<p>Last, the <a href="http://people.apache.org/~mmorel/apache-s4-0.6.0-incubating-doc/javadoc/">javadoc</a> will help you when writing applications.</p>
-<p>We hope this will help you start rapidly, and remember: weâre happy to help!</p></div>
+<p>We hope this will help you start rapidly, and remember: weâre happy to help!</p>
+</div>
</div>
- <div id='footer'>
- <div class='container'>
- <span class='copyright'>Apache S4 - Copyright 2013 The Apache Software Foundation</span>
+ <div id="footer">
+ <div class="container">
+ <span class="copyright">Apache S4 - Copyright 2013 The Apache Software Foundation</span>
</div>
</div>
</body>