You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@edgent.apache.org by qu...@apache.org on 2016/07/26 22:31:31 UTC
[47/51] [partial] incubator-quarks-website git commit: from
05ad5e885c21d745f87c23c280f222cbca457b89
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/a13739b3/content/docs/console.html
----------------------------------------------------------------------
diff --git a/content/docs/console.html b/content/docs/console.html
index 8abebc8..18af5f4 100644
--- a/content/docs/console.html
+++ b/content/docs/console.html
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="">
<meta name="keywords" content=" ">
-<title>Application console | Apache Quarks Documentation</title>
+<title>Application console | Apache Edgent Documentation</title>
<link rel="stylesheet" type="text/css" href="../css/syntax.css">
<link rel="stylesheet" type="text/css" href="../css/font-awesome.min.css">
<!--<link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css">-->
@@ -60,7 +60,7 @@
<span class="icon-bar"></span>
</button>
- <a class="fa fa-home fa-lg navbar-brand" href="../docs/home.html"> <span class="projectTitle"> Apache Quarks Documentation</span></a>
+ <a class="fa fa-home fa-lg navbar-brand" href="../docs/home.html"> <span class="projectTitle"> Apache Edgent Documentation</span></a>
</div>
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
@@ -107,7 +107,7 @@
- <li><a href="http://quarks.incubator.apache.org/javadoc/lastest/index.html" target="_blank">Javadoc</a></li>
+ <li><a href="http://quarks.incubator.apache.org/javadoc/latest/index.html" target="_blank">Javadoc</a></li>
@@ -121,7 +121,7 @@
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Quarks Resources<b class="caret"></b></a>
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Edgent Resources<b class="caret"></b></a>
<ul class="dropdown-menu">
@@ -156,7 +156,7 @@
<!-- Send feedback function -->
<script>
function SendLinkByMail(href) {
-var subject= "Apache Quarks Documentation feedback";
+var subject= "Apache Edgent Documentation feedback";
var body = "I have some feedback about the Application console page: ";
body += window.location.href;
body += "";
@@ -257,7 +257,7 @@ window.location.href = uri;
<ul id="mysidebar" class="nav">
- <span class="siteTagline">Quarks</span>
+ <span class="siteTagline">Edgent</span>
<span class="versionTagline">Version 0.3.0</span>
@@ -271,7 +271,7 @@ window.location.href = uri;
- <li><a href="../docs/quarks_index.html">Introduction</a></li>
+ <li><a href="../docs/edgent_index.html">Introduction</a></li>
@@ -298,7 +298,7 @@ window.location.href = uri;
- <li><a href="../docs/quarks-getting-started.html">Getting started guide</a></li>
+ <li><a href="../docs/edgent-getting-started.html">Getting started guide</a></li>
@@ -308,7 +308,7 @@ window.location.href = uri;
- <li><a href="../docs/common-quarks-operations.html">Common operations</a></li>
+ <li><a href="../docs/common-edgent-operations.html">Common operations</a></li>
@@ -319,13 +319,13 @@ window.location.href = uri;
- <li><a href="#">Quarks Cookbook</a>
+ <li><a href="#">Edgent Cookbook</a>
<ul>
- <li><a href="../recipes/recipe_hello_quarks.html">Hello Quarks!</a></li>
+ <li><a href="../recipes/recipe_hello_edgent.html">Hello Edgent!</a></li>
@@ -601,19 +601,19 @@ $('#toc').on('click', 'a', function() {
<h2 id="visualizing-and-monitoring-your-application">Visualizing and monitoring your application</h2>
-<p>The Quarks application console is a web application that enables you to visualize your application topology and monitor the tuples flowing through your application. The kind of oplets used in the topology, as well as the stream tags included in the topology, are also visible in the console.</p>
+<p>The Edgent application console is a web application that enables you to visualize your application topology and monitor the tuples flowing through your application. The kind of oplets used in the topology, as well as the stream tags included in the topology, are also visible in the console.</p>
<h2 id="adding-the-console-web-app-to-your-application">Adding the console web app to your application</h2>
-<p>To use the console, you must use the Quarks classes that provide the service to access the console web application or directly call the <code>HttpServer</code> class itself, start the server and then obtain the console URL.</p>
+<p>To use the console, you must use the Edgent classes that provide the service to access the console web application or directly call the <code>HttpServer</code> class itself, start the server and then obtain the console URL.</p>
<p>The easiest way to include the console in your application is to use the the <code>DevelopmentProvider</code> class. <code>DevelopmentProvider</code> is a subclass of <code>DirectProvider</code> and adds services such as access to the console web application and counter oplets used to determine tuple counts. You can get the URL for the console from the <code>DevelopmentProvider</code> using the <code>getService</code> method as shown in a hypothetical application shown below:</p>
<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="kn">import</span> <span class="nn">java.util.concurrent.TimeUnit</span><span class="o">;</span>
-<span class="kn">import</span> <span class="nn">quarks.console.server.HttpServer</span><span class="o">;</span>
-<span class="kn">import</span> <span class="nn">quarks.providers.development.DevelopmentProvider</span><span class="o">;</span>
-<span class="kn">import</span> <span class="nn">quarks.topology.TStream</span><span class="o">;</span>
-<span class="kn">import</span> <span class="nn">quarks.topology.Topology</span><span class="o">;</span>
+<span class="kn">import</span> <span class="nn">org.apache.edgent.console.server.HttpServer</span><span class="o">;</span>
+<span class="kn">import</span> <span class="nn">org.apache.edgent.providers.development.DevelopmentProvider</span><span class="o">;</span>
+<span class="kn">import</span> <span class="nn">org.apache.edgent.topology.TStream</span><span class="o">;</span>
+<span class="kn">import</span> <span class="nn">org.apache.edgent.topology.Topology</span><span class="o">;</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">TempSensorApplication</span> <span class="o">{</span>
<span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="n">main</span><span class="o">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span>
@@ -657,13 +657,13 @@ $('#toc').on('click', 'a', function() {
<p>To see the features of the console in action and as a way to demonstrate how to monitor a topology in the console, let's look at the <code>ConsoleWaterDetector</code> sample (on <a href="https://github.com/apache/incubator-quarks/blob/master/samples/console/src/main/java/quarks/samples/console/ConsoleWaterDetector.java">GitHub</a>).</p>
-<p>Prior to running any console applications, the <code>console.war</code> file must be built as mentioned above. If you are building quarks from a Git repository, go to the top level Quarks directory and run <code>ant</code>.</p>
+<p>Prior to running any console applications, the <code>console.war</code> file must be built as mentioned above. If you are building Edgent from a Git repository, go to the top level Edgent directory and run <code>ant</code>.</p>
<p>Here is an example in my environment:</p>
-<div class="highlight"><pre><code class="language-" data-lang="">Susans-MacBook-Pro-247:quarks susancline$ pwd
-/Users/susancline/git/quarks
-Susans-MacBook-Pro-247:quarks susancline$ ant
-Buildfile: /Users/susancline/git/quarks/build.xml
+<div class="highlight"><pre><code class="language-" data-lang="">Susans-MacBook-Pro-247:edgent susancline$ pwd
+/Users/susancline/git/edgent
+Susans-MacBook-Pro-247:edgent susancline$ ant
+Buildfile: /Users/susancline/git/edgent/build.xml
setcommitversion:
@@ -680,10 +680,10 @@ compile:
[javadoc] Constructing Javadoc information...
[javadoc] Standard Doclet version 1.8.0_71
[javadoc] Building tree for all the packages and classes...
-[javadoc] Generating /Users/susancline/git/quarks/target/docs/javadoc/quarks/analytics/sensors/package-summary.html...
-[javadoc] Copying file /Users/susancline/git/quarks/analytics/sensors/src/main/java/quarks/analytics/sensors/doc-files/deadband.png to directory /Users/susancline/git/quarks/target/docs/javadoc/quarks/analytics/sensors/doc-files...
-[javadoc] Generating /Users/susancline/git/quarks/target/docs/javadoc/quarks/topology/package-summary.html...
-[javadoc] Copying file /Users/susancline/git/quarks/api/topology/src/main/java/quarks/topology/doc-files/sources.html to directory /Users/susancline/git/quarks/target/docs/javadoc/quarks/topology/doc-files...
+[javadoc] Generating /Users/susancline/git/edgent/target/docs/javadoc/edgent/analytics/sensors/package-summary.html...
+[javadoc] Copying file /Users/susancline/git/edgent/analytics/sensors/src/main/java/edgent/analytics/sensors/doc-files/deadband.png to directory /Users/susancline/git/edgent/target/docs/javadoc/edgent/analytics/sensors/doc-files...
+[javadoc] Generating /Users/susancline/git/edgent/target/docs/javadoc/edgent/topology/package-summary.html...
+[javadoc] Copying file /Users/susancline/git/edgent/api/topology/src/main/java/edgent/topology/doc-files/sources.html to directory /Users/susancline/git/edgent/target/docs/javadoc/edgent/topology/doc-files...
[javadoc] Building index for all the packages and classes...
[javadoc] Building index for all classes...
@@ -693,16 +693,16 @@ BUILD SUCCESSFUL
Total time: 3 seconds
</code></pre></div>
<p>This command will let you know that <code>console.war</code> was built and is in the correct place, under the <code>webapps</code> directory.</p>
-<div class="highlight"><pre><code class="language-" data-lang="">Susans-MacBook-Pro-247:quarks susancline$ find . -name console.war -print
+<div class="highlight"><pre><code class="language-" data-lang="">Susans-MacBook-Pro-247:edgent susancline$ find . -name console.war -print
./target/java8/console/webapps/console.war
</code></pre></div>
<p>Now we know we have built <code>console.war</code>, so we're good to go. To run this sample from the command line:</p>
-<div class="highlight"><pre><code class="language-" data-lang="">Susans-MacBook-Pro-247:quarks susancline$ pwd
-/Users/susancline/git/quarks
-Susans-MacBook-Pro-247:quarks susancline$ java -cp target/java8/samples/lib/quarks.samples.console.jar:. quarks.samples.console.ConsoleWaterDetector
+<div class="highlight"><pre><code class="language-" data-lang="">Susans-MacBook-Pro-247:edgent susancline$ pwd
+/Users/susancline/git/edgent
+Susans-MacBook-Pro-247:edgent susancline$ java -cp target/java8/samples/lib/edgent.samples.console.jar:. edgent.samples.console.ConsoleWaterDetector
</code></pre></div>
<p>If everything is successful, you'll start seeing output. You may have to scroll back up to get the URL of the console:</p>
-<div class="highlight"><pre><code class="language-" data-lang="">Susans-MacBook-Pro-247:quarks susancline$ java -cp target/java8/samples/lib/quarks.samples.console.jar:. quarks.samples.console.ConsoleWaterDetector
+<div class="highlight"><pre><code class="language-" data-lang="">Susans-MacBook-Pro-247:edgent susancline$ java -cp target/java8/samples/lib/edgent.samples.console.jar:. edgent.samples.console.ConsoleWaterDetector
Mar 07, 2016 12:04:52 PM org.eclipse.jetty.util.log.Log initialized
INFO: Logging initialized @176ms
Mar 07, 2016 12:04:53 PM org.eclipse.jetty.server.Server doStart
@@ -844,15 +844,15 @@ Well3 alert, acidity value is 10
<span class="o">}</span>
</code></pre></div>
<p>What this does is get all the counters in the <code>MetricRegistry</code> class and print out the name of the counter oplet they are monitoring along with the tuple count if it is zero. Here is some sample output:</p>
-<div class="highlight"><pre><code class="language-" data-lang="">Counter Op:TupleCounter.quarks.oplet.JOB_0.OP_44 has a tuple count of zero!
-Counter Op:TupleCounter.quarks.oplet.JOB_0.OP_45 has a tuple count of zero!
-Counter Op:TupleCounter.quarks.oplet.JOB_0.OP_46 has a tuple count of zero!
-Counter Op:TupleCounter.quarks.oplet.JOB_0.OP_47 has a tuple count of zero!
-Counter Op:TupleCounter.quarks.oplet.JOB_0.OP_89 has a tuple count of zero!
-Counter Op:TupleCounter.quarks.oplet.JOB_0.OP_95 has a tuple count of zero!
-Counter Op:TupleCounter.quarks.oplet.JOB_0.OP_96 has a tuple count of zero!
-Counter Op:TupleCounter.quarks.oplet.JOB_0.OP_97 has a tuple count of zero!
-Counter Op:TupleCounter.quarks.oplet.JOB_0.OP_98 has a tuple count of zero!
+<div class="highlight"><pre><code class="language-" data-lang="">Counter Op:TupleCounter.edgent.oplet.JOB_0.OP_44 has a tuple count of zero!
+Counter Op:TupleCounter.edgent.oplet.JOB_0.OP_45 has a tuple count of zero!
+Counter Op:TupleCounter.edgent.oplet.JOB_0.OP_46 has a tuple count of zero!
+Counter Op:TupleCounter.edgent.oplet.JOB_0.OP_47 has a tuple count of zero!
+Counter Op:TupleCounter.edgent.oplet.JOB_0.OP_89 has a tuple count of zero!
+Counter Op:TupleCounter.edgent.oplet.JOB_0.OP_95 has a tuple count of zero!
+Counter Op:TupleCounter.edgent.oplet.JOB_0.OP_96 has a tuple count of zero!
+Counter Op:TupleCounter.edgent.oplet.JOB_0.OP_97 has a tuple count of zero!
+Counter Op:TupleCounter.edgent.oplet.JOB_0.OP_98 has a tuple count of zero!
</code></pre></div>
<p>To summarize what the application is doing:</p>
@@ -903,7 +903,7 @@ Counter Op:TupleCounter.quarks.oplet.JOB_0.OP_98 has a tuple count of zero!
<p><img src='images/console_oplet_properties.jpg' alt='Displays a table showing the relationship between the oplets and vertices' width='100%'/></p>
-<p>Looking at the sixth line in the table, where the Name is 'OP_5', we can see that the Oplet kind is a <code>Map</code>, a <code>quarks.oplet.functional.Map</code>, the Tuple count is 0 (this is because the view is in Static flow mode - the graph does not show the number of tuples flowing in it), the source oplet is 'OP_55', the target oplet is 'OP_60', and there are no stream tags coming from the source or target streams. Relationships for all oplets can be viewed in this manner.</p>
+<p>Looking at the sixth line in the table, where the Name is 'OP_5', we can see that the Oplet kind is a <code>Map</code>, a <code>edgent.oplet.functional.Map</code>, the Tuple count is 0 (this is because the view is in Static flow mode - the graph does not show the number of tuples flowing in it), the source oplet is 'OP_55', the target oplet is 'OP_60', and there are no stream tags coming from the source or target streams. Relationships for all oplets can be viewed in this manner.</p>
<p>Now, looking at the graph, if we want to see the relationships for a single oplet, we can hover over it. The image below shows the hover when we are over 'OP_5'.</p>
@@ -974,12 +974,12 @@ Counter Op:TupleCounter.quarks.oplet.JOB_0.OP_98 has a tuple count of zero!
<ul>
<li>A <code>DevelopmentProvider</code> is used; this automatically inserts counters on the streams of the topology</li>
-<li>A <code>quarks.metrics.Metric.Counter</code> or <code>quarks.metrics.Metric.RateMeter</code> is added to an individual stream</li>
+<li>A <code>edgent.metrics.Metric.Counter</code> or <code>edgent.metrics.Metric.RateMeter</code> is added to an individual stream</li>
</ul>
<h2 id="counters">Counters</h2>
-<p>In the <code>ConsoleWaterDetector</code> application we used a <code>DevelopmentProvider</code>. Therefore, counters were added to most streams (edges) with the following exceptions (from the <a href="http://quarks.incubator.apache.org/javadoc/lastest/quarks/metrics/Metrics.html#counter-quarks.topology.TStream-">Javadoc</a> for <code>quarks.metrics.Metrics</code>):</p>
+<p>In the <code>ConsoleWaterDetector</code> application we used a <code>DevelopmentProvider</code>. Therefore, counters were added to most streams (edges) with the following exceptions (from the <a href="http://quarks.incubator.apache.org/javadoc/latest/quarks/metrics/Metrics.html#counter-quarks.topology.TStream-">Javadoc</a> for <code>edgent.metrics.Metrics</code>):</p>
<p><em>Oplets are only inserted upstream from a FanOut oplet.</em></p>
@@ -1057,7 +1057,7 @@ Metrics.rateMeter(individualAlerts3.get(0));
<p>The intent of the information on this page is to help you understand the following:</p>
<ul>
-<li>How to add the console application to a Quarks application</li>
+<li>How to add the console application to an Edgent application</li>
<li>How to run the <code>ConsoleWaterDetector</code> sample</li>
<li>The design/architecture in the <code>ConsoleWaterDetector</code> application</li>
<li>The controls for the Topology graph are and what they do, including the different views of the graph</li>
@@ -1068,9 +1068,9 @@ Metrics.rateMeter(individualAlerts3.get(0));
<li>How to correlate values from the metrics section with the topology graph</li>
</ul>
-<p>The Quarks console will continue to evolve and improve. Please open an issue if you see a problem with the existing console, but more importantly add an issue if you have an idea of how to make the console better.</p>
+<p>The Edgent console will continue to evolve and improve. Please open an issue if you see a problem with the existing console, but more importantly add an issue if you have an idea of how to make the console better.</p>
-<p>The more folks write Quarks applications and view them in the console, the more information we can gather from the community about what is needed in the console. Please consider making a contribution if there is a feature in the console that would really help you and others!</p>
+<p>The more folks write Edgent applications and view them in the console, the more information we can gather from the community about what is needed in the console. Please consider making a contribution if there is a feature in the console that would really help you and others!</p>
<div class="tags">
@@ -1103,14 +1103,14 @@ Metrics.rateMeter(individualAlerts3.get(0));
<div class="col-lg-12 footer">
Site last
- generated: Jul 21, 2016 <br/>
+ generated: Jul 26, 2016 <br/>
</div>
</div>
<br/>
<div class="row">
<div class="col-md-12">
- <p class="small">Apache Quarks is an effort undergoing Incubation at The Apache Software
+ <p class="small">Apache Edgent is an effort undergoing Incubation at The Apache Software
Foundation (ASF), sponsored by the Incubator. Incubation is required of all newly accepted projects
until a further review indicates that the infrastructure, communications, and decision making process
have stabilized in a manner consistent with other successful ASF projects. While incubation status is
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/a13739b3/content/docs/edgent-getting-started.html
----------------------------------------------------------------------
diff --git a/content/docs/edgent-getting-started.html b/content/docs/edgent-getting-started.html
new file mode 100644
index 0000000..6553f07
--- /dev/null
+++ b/content/docs/edgent-getting-started.html
@@ -0,0 +1,840 @@
+<!DOCTYPE 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">
+<meta name="description" content="">
+<meta name="keywords" content=" ">
+<title>Getting started with Apache Edgent | Apache Edgent Documentation</title>
+<link rel="stylesheet" type="text/css" href="../css/syntax.css">
+<link rel="stylesheet" type="text/css" href="../css/font-awesome.min.css">
+<!--<link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css">-->
+<link rel="stylesheet" type="text/css" href="../css/modern-business.css">
+<link rel="stylesheet" type="text/css" href="../css/lavish-bootstrap.css">
+<link rel="stylesheet" type="text/css" href="../css/customstyles.css">
+<link rel="stylesheet" type="text/css" href="../css/theme-blue.css">
+<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.4.1/jquery.cookie.min.js"></script>
+<script src="../js/jquery.navgoco.min.js"></script>
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/2.0.0/anchor.min.js"></script>
+<script src="../js/toc.js"></script>
+<script src="../js/customscripts.js"></script>
+<link rel="shortcut icon" href="../common_images/favicon.ico" type="image/x-icon">
+<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
+<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
+<!--[if lt IE 9]>
+<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
+<![endif]-->
+
+
+
+
+
+
+
+
+
+<script>
+ $(function () {
+ $('[data-toggle="tooltip"]').tooltip()
+ })
+</script>
+
+
+
+ </head>
+
+<body>
+
+ <!-- Navigation -->
+<nav class="navbar navbar-inverse navbar-fixed-top" role="navigation">
+ <div class="container topnavlinks">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+
+ <a class="fa fa-home fa-lg navbar-brand" href="../docs/home.html"> <span class="projectTitle"> Apache Edgent Documentation</span></a>
+
+ </div>
+ <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
+ <ul class="nav navbar-nav navbar-right">
+ <!-- entries without drop-downs appear here -->
+ <!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->
+
+
+
+
+
+
+
+
+
+ <li class="dropdown">
+
+
+
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">GitHub Repos<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+
+
+ <li><a href="https://github.com/apache/incubator-quarks" target="_blank">Source code</a></li>
+
+
+
+
+
+ <li><a href="https://github.com/apache/incubator-quarks-website" target="_blank">Website/Documentation</a></li>
+
+
+
+
+
+ </ul>
+ </li>
+
+
+
+
+
+
+
+
+ <li><a href="http://quarks.incubator.apache.org/javadoc/latest/index.html" target="_blank">Javadoc</a></li>
+
+
+
+
+
+
+ <!-- entries with drop-downs appear here -->
+ <!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->
+
+ <li class="dropdown">
+
+
+
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Edgent Resources<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+
+
+ <li><a href="https://github.com/apache/incubator-quarks/releases" target="_blank">Download</a></li>
+
+
+
+
+
+ <li><a href="samples">Samples</a></li>
+
+
+
+
+
+ <li><a href="faq">FAQ</a></li>
+
+
+
+
+
+ </ul>
+ </li>
+
+
+
+
+ <!-- special insertion -->
+
+
+ <!-- Send feedback function -->
+<script>
+function SendLinkByMail(href) {
+var subject= "Apache Edgent Documentation feedback";
+var body = "I have some feedback about the Getting started with Apache Edgent page: ";
+body += window.location.href;
+body += "";
+var uri = "mailto:?subject=";
+uri += encodeURIComponent(subject);
+uri += "&body=";
+uri += encodeURIComponent(body);
+window.location.href = uri;
+}
+</script>
+
+<li><a href="mailto:dev@quarks.incubator.apache.org" target="_blank"><i class="fa fa-envelope-o"></i> Feedback</a></li>
+
+
+ <!--uncomment this block if you want simple search instead of algolia-->
+ <li>
+ <!--start search-->
+ <div id="search-demo-container">
+ <input type="text" id="search-input" placeholder="search...">
+ <ul id="results-container"></ul>
+ </div>
+ <script src="../js/jekyll-search.js" type="text/javascript"></script>
+ <script type="text/javascript">
+ SimpleJekyllSearch.init({
+ searchInput: document.getElementById('search-input'),
+ resultsContainer: document.getElementById('results-container'),
+ dataSource: '../search.json',
+ searchResultTemplate: '<li><a href="{url}" title="Getting started with Apache Edgent">{title}</a></li>',
+ noResultsText: 'No results found.',
+ limit: 10,
+ fuzzy: true,
+ })
+ </script>
+ <!--end search-->
+ </li>
+
+
+ </div>
+ <!-- /.container -->
+</nav>
+
+
+
+ <!-- Page Content -->
+ <div class="container">
+ <div class="col-lg-12"> </div>
+
+
+<!-- Content Row -->
+<div class="row">
+ <!-- Sidebar Column -->
+ <div class="col-md-3">
+
+ <script>
+
+ $(document).ready(function() {
+ // Initialize navgoco with default options
+ $("#mysidebar").navgoco({
+ caretHtml: '',
+ accordion: true,
+ openClass: 'active', // open
+ save: true,
+ cookie: {
+ name: 'navgoco',
+ expires: false,
+ path: '/'
+ },
+ slide: {
+ duration: 400,
+ easing: 'swing'
+ }
+ });
+
+ $("#collapseAll").click(function(e) {
+ e.preventDefault();
+ $("#mysidebar").navgoco('toggle', false);
+ });
+
+ $("#expandAll").click(function(e) {
+ e.preventDefault();
+ $("#mysidebar").navgoco('toggle', true);
+ });
+
+ });
+
+ </script>
+
+
+
+
+
+
+
+
+
+
+
+
+ <ul id="mysidebar" class="nav">
+
+ <span class="siteTagline">Edgent</span>
+ <span class="versionTagline">Version 0.3.0</span>
+
+
+
+
+
+
+ <li><a href="#">Overview</a>
+ <ul>
+
+
+
+
+ <li><a href="../docs/edgent_index.html">Introduction</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../docs/faq.html">FAQ</a></li>
+
+
+
+
+
+
+ </ul>
+
+
+
+ <li><a href="#">Get Started</a>
+ <ul>
+
+
+
+
+ <li class="active"><a href="../docs/edgent-getting-started.html">Getting started guide</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../docs/common-edgent-operations.html">Common operations</a></li>
+
+
+
+
+
+
+ </ul>
+
+
+
+ <li><a href="#">Edgent Cookbook</a>
+ <ul>
+
+
+
+
+ <li><a href="../recipes/recipe_hello_edgent.html">Hello Edgent!</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../recipes/recipe_source_function.html">Writing a source function</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../recipes/recipe_value_out_of_range.html">Detecting a sensor value out of expected range</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../recipes/recipe_different_processing_against_stream.html">Applying different processing against a single stream</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../recipes/recipe_combining_streams_processing_results.html">Splitting a stream to apply different processing and combining the results into a single stream</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../recipes/recipe_external_filter_range.html">Using an external configuration file for filter ranges</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../recipes/recipe_adaptable_filter_range.html">Changing a filter's range</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../recipes/recipe_adaptable_polling_source.html">Changing a polled source stream's period</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../recipes/recipe_adaptable_deadtime_filter.html">Using an adaptable deadtime filter</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../recipes/recipe_dynamic_analytic_control.html">Dynamically enabling analytic flows</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../recipes/recipe_parallel_analytics.html">How can I run analytics on several tuples in parallel?</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../recipes/recipe_concurrent_analytics.html">How can I run several analytics on a tuple concurrently?</a></li>
+
+
+
+
+
+
+ </ul>
+
+
+
+ <li><a href="#">Sample Programs</a>
+ <ul>
+
+
+
+
+ <li><a href="../docs/samples.html">Samples</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../docs/quickstart.html">Quickstart IBM Watson IoT Platform</a></li>
+
+
+
+
+
+
+ </ul>
+
+
+
+ <li><a href="#">Using the Console</a>
+ <ul>
+
+
+
+
+ <li><a href="../docs/console.html">Using the console</a></li>
+
+
+
+
+
+
+ </ul>
+
+
+
+ <li><a href="#">Get Involved</a>
+ <ul>
+
+
+
+
+ <li><a href="../docs/community.html">How to participate</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../docs/committers.html">Committers</a></li>
+
+
+
+
+
+
+ </ul>
+
+
+
+
+
+ <!-- if you aren't using the accordion, uncomment this block:
+
+ <p class="external">
+ <a href="#" id="collapseAll">Collapse All</a> | <a href="#" id="expandAll">Expand All</a>
+ </p>
+ -->
+ <br/>
+ </li>
+ </ul>
+ <div class="row">
+ <div class="col-md-12">
+
+<!-- this handles the automatic toc. use ## for subheads to auto-generate the on-page minitoc. if you use html tags, you must supply an ID for the heading element in order for it to appear in the minitoc. -->
+<script>
+$( document ).ready(function() {
+ // Handler for .ready() called.
+
+$('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2,h3,h4' });
+
+/* this offset helps account for the space taken up by the floating toolbar. */
+$('#toc').on('click', 'a', function() {
+ var target = $(this.getAttribute('href'))
+ , scroll_target = target.offset().top
+
+ $(window).scrollTop(scroll_target - 10);
+ return false
+})
+
+});
+</script>
+
+
+<div id="toc"></div>
+
+ </div>
+ </div>
+ </div>
+
+ <!-- this highlights the active parent class in the navgoco sidebar. this is critical so that the parent expands when you're viewing a page. This must appear below the sidebar code above. Otherwise, if placed inside customscripts.js, the script runs before the sidebar code runs and the class never gets inserted.-->
+ <script>$("li.active").parents('li').toggleClass("active");</script>
+
+
+ <!-- Content Column -->
+ <div class="col-md-9">
+
+ <div class="post-header">
+ <h1 class="post-title-main">Getting started with Apache Edgent</h1>
+</div>
+
+<div class="post-content">
+
+
+
+<!-- this handles the automatic toc. use ## for subheads to auto-generate the on-page minitoc. if you use html tags, you must supply an ID for the heading element in order for it to appear in the minitoc. -->
+<script>
+$( document ).ready(function() {
+ // Handler for .ready() called.
+
+$('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2,h3,h4' });
+
+/* this offset helps account for the space taken up by the floating toolbar. */
+$('#toc').on('click', 'a', function() {
+ var target = $(this.getAttribute('href'))
+ , scroll_target = target.offset().top
+
+ $(window).scrollTop(scroll_target - 10);
+ return false
+})
+
+});
+</script>
+
+
+<div id="toc"></div>
+
+
+
+
+ <a target="_blank" href="https://github.com/apache/incubator-quarks-website/blob/master/site/docs/edgent-getting-started.md" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
+
+ <h2 id="what-is-apache-edgent">What is Apache Edgent?</h2>
+
+<p>Edgent is an open source programming model and runtime for edge devices that enables you to analyze streaming data on your edge devices. When you analyze on the edge, you can:</p>
+
+<ul>
+<li>Reduce the amount of data that you transmit to your analytics server</li>
+<li>Reduce the amount of data that you store</li>
+</ul>
+
+<p>For more information, see the <a href="home">Edgent overview</a>.</p>
+
+<h3 id="apache-edgent-and-streaming-analytics">Apache Edgent and streaming analytics</h3>
+
+<p>The fundamental building block of an Edgent application is a <strong>stream</strong>: a continuous sequence of tuples (messages, events, sensor readings, and so on).</p>
+
+<p>The Edgent API provides the ability to process or analyze each tuple as it appears on a stream, resulting in a derived stream.</p>
+
+<p>Source streams are streams that originate data for analysis, such as readings from a device's temperature sensor.</p>
+
+<p>Streams are terminated using sink functions that can perform local device control or send information to centralized analytic systems through a message hub.</p>
+
+<p>Edgent's primary API is functional where streams are sourced, transformed, analyzed or sinked though functions, typically represented as lambda expressions, such as <code>reading -> reading < 50 || reading > 80</code> to filter temperature readings in Fahrenheit.</p>
+
+<h3 id="downloading-apache-edgent">Downloading Apache Edgent</h3>
+
+<p>To use Edgent, access the source code and build it. You can read more about building Edgent <a href="https://github.com/apache/incubator-quarks/blob/master/DEVELOPMENT.md">here</a>.</p>
+
+<p>After you build the Edgent package, you can set up your environment.</p>
+
+<h3 id="setting-up-your-environment">Setting up your environment</h3>
+
+<p>Ensure that you are running a supported environment. For more information, see the <a href="home">Edgent overview</a>. This guide assumes you're running Java 8.</p>
+
+<p>The Edgent Java 8 JAR files are located in the <code>edgent/java8/lib</code> directory.</p>
+
+<ol>
+<li><p>Create a new Java project in Eclipse, and specify Java 8 as the execution environment JRE:</p>
+
+<p><img src="images/New_Java_Project.JPG" style="width:448px;height:589px;"></p></li>
+<li><p>Modify the Java build path to include all of the JAR files in the <code>edgent\java8\lib</code> directory:</p>
+
+<p><img src="images/Build_Path_Jars.JPG" style="width:660px;height:469px;"></p></li>
+</ol>
+
+<p>Your environment is set up! You can start writing your first Edgent application.</p>
+
+<h2 id="creating-a-simple-application">Creating a simple application</h2>
+
+<p>If you're new to Edgent or to writing streaming applications, the best way to get started is to write a simple program.</p>
+
+<p>Edgent is a framework that pushes data analytics and machine learning to <em>edge devices</em>. (Edge devices include things like routers, gateways, machines, equipment, sensors, appliances, or vehicles that are connected to a network.) Edgent enables you to process data locally—such as, in a car engine, on an Android phone, or Raspberry Pi—before you send data over a network.</p>
+
+<p>For example, if your device takes temperature readings from a sensor 1,000 times per second, it is more efficient to process the data locally and send only interesting or unexpected results over the network. To simulate this, let's define a (simulated) TempSensor class:</p>
+<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="kn">import</span> <span class="nn">java.util.Random</span><span class="o">;</span>
+
+<span class="kn">import</span> <span class="nn">org.apache.edgent.function.Supplier</span><span class="o">;</span>
+
+<span class="cm">/**
+ * Every time get() is called, TempSensor generates a temperature reading.
+ */</span>
+<span class="kd">public</span> <span class="kd">class</span> <span class="nc">TempSensor</span> <span class="kd">implements</span> <span class="n">Supplier</span><span class="o"><</span><span class="n">Double</span><span class="o">></span> <span class="o">{</span>
+ <span class="kt">double</span> <span class="n">currentTemp</span> <span class="o">=</span> <span class="mf">65.0</span><span class="o">;</span>
+ <span class="n">Random</span> <span class="n">rand</span><span class="o">;</span>
+
+ <span class="n">TempSensor</span><span class="o">(){</span>
+ <span class="n">rand</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Random</span><span class="o">();</span>
+ <span class="o">}</span>
+
+ <span class="nd">@Override</span>
+ <span class="kd">public</span> <span class="n">Double</span> <span class="n">get</span><span class="o">()</span> <span class="o">{</span>
+ <span class="c1">// Change the current temperature some random amount</span>
+ <span class="kt">double</span> <span class="n">newTemp</span> <span class="o">=</span> <span class="n">rand</span><span class="o">.</span><span class="na">nextGaussian</span><span class="o">()</span> <span class="o">+</span> <span class="n">currentTemp</span><span class="o">;</span>
+ <span class="n">currentTemp</span> <span class="o">=</span> <span class="n">newTemp</span><span class="o">;</span>
+ <span class="k">return</span> <span class="n">currentTemp</span><span class="o">;</span>
+ <span class="o">}</span>
+<span class="o">}</span>
+</code></pre></div>
+<p>Every time you call <code>TempSensor.get()</code>, it returns a new temperature reading. The continuous temperature readings are a stream of data that an Edgent application can process.</p>
+
+<p>Our sample Edgent application processes this stream by filtering the data and printing the results. Let's define a TempSensorApplication class for the application:</p>
+<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="kn">import</span> <span class="nn">java.util.concurrent.TimeUnit</span><span class="o">;</span>
+
+<span class="kn">import</span> <span class="nn">org.apache.edgent.providers.direct.DirectProvider</span><span class="o">;</span>
+<span class="kn">import</span> <span class="nn">org.apache.edgent.topology.TStream</span><span class="o">;</span>
+<span class="kn">import</span> <span class="nn">org.apache.edgent.topology.Topology</span><span class="o">;</span>
+
+<span class="kd">public</span> <span class="kd">class</span> <span class="nc">TempSensorApplication</span> <span class="o">{</span>
+ <span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="n">main</span><span class="o">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span>
+ <span class="n">TempSensor</span> <span class="n">sensor</span> <span class="o">=</span> <span class="k">new</span> <span class="n">TempSensor</span><span class="o">();</span>
+ <span class="n">DirectProvider</span> <span class="n">dp</span> <span class="o">=</span> <span class="k">new</span> <span class="n">DirectProvider</span><span class="o">();</span>
+ <span class="n">Topology</span> <span class="n">topology</span> <span class="o">=</span> <span class="n">dp</span><span class="o">.</span><span class="na">newTopology</span><span class="o">();</span>
+ <span class="n">TStream</span><span class="o"><</span><span class="n">Double</span><span class="o">></span> <span class="n">tempReadings</span> <span class="o">=</span> <span class="n">topology</span><span class="o">.</span><span class="na">poll</span><span class="o">(</span><span class="n">sensor</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">TimeUnit</span><span class="o">.</span><span class="na">MILLISECONDS</span><span class="o">);</span>
+ <span class="n">TStream</span><span class="o"><</span><span class="n">Double</span><span class="o">></span> <span class="n">filteredReadings</span> <span class="o">=</span> <span class="n">tempReadings</span><span class="o">.</span><span class="na">filter</span><span class="o">(</span><span class="n">reading</span> <span class="o">-></span> <span class="n">reading</span> <span class="o"><</span> <span class="mi">50</span> <span class="o">||</span> <span class="n">reading</span> <span class="o">></span> <span class="mi">80</span><span class="o">);</span>
+
+ <span class="n">filteredReadings</span><span class="o">.</span><span class="na">print</span><span class="o">();</span>
+ <span class="n">dp</span><span class="o">.</span><span class="na">submit</span><span class="o">(</span><span class="n">topology</span><span class="o">);</span>
+ <span class="o">}</span>
+<span class="o">}</span>
+</code></pre></div>
+<p>To understand how the application processes the stream, let's review each line.</p>
+
+<h3 id="specifying-a-provider">Specifying a provider</h3>
+
+<p>Your first step when you write an Edgent application is to create a <a href="http://quarks.incubator.apache.org/javadoc/latest/index.html?edgent/providers/direct/DirectProvider.html"><code>DirectProvider</code></a>:</p>
+<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="n">DirectProvider</span> <span class="n">dp</span> <span class="o">=</span> <span class="k">new</span> <span class="n">DirectProvider</span><span class="o">();</span>
+</code></pre></div>
+<p>A <code>Provider</code> is an object that contains information on how and where your Edgent application will run. A <code>DirectProvider</code> is a type of Provider that runs your application directly within the current virtual machine when its <code>submit()</code> method is called.</p>
+
+<h3 id="creating-a-topology">Creating a topology</h3>
+
+<p>Additionally a Provider is used to create a <a href="http://quarks.incubator.apache.org/javadoc/latest/index.html?edgent/topology/Topology.html"><code>Topology</code></a> instance:</p>
+<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="n">Topology</span> <span class="n">topology</span> <span class="o">=</span> <span class="n">dp</span><span class="o">.</span><span class="na">newTopology</span><span class="o">();</span>
+</code></pre></div>
+<p>In Edgent, <code>Topology</code> is a container that describes the structure of your application:</p>
+
+<ul>
+<li>Where the streams in the application come from</li>
+<li>How the data in the stream is modified</li>
+</ul>
+
+<p>In the TempSensor application above, we have exactly one data source: the <code>TempSensor</code> object. We define the source stream by calling <code>topology.poll()</code>, which takes both a <code>Supplier</code> function and a time parameter to indicate how frequently readings should be taken. In our case, we read from the sensor every millisecond:</p>
+<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="n">TStream</span><span class="o"><</span><span class="n">Double</span><span class="o">></span> <span class="n">tempReadings</span> <span class="o">=</span> <span class="n">topology</span><span class="o">.</span><span class="na">poll</span><span class="o">(</span><span class="n">sensor</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">TimeUnit</span><span class="o">.</span><span class="na">MILLISECONDS</span><span class="o">);</span>
+</code></pre></div>
+<h3 id="defining-the-tstream-object">Defining the <code>TStream</code> object</h3>
+
+<p>Calling <code>topology.poll()</code> to define a source stream creates a <code>TStream<Double></code> instance, which represents the series of readings taken from the temperature sensor.</p>
+
+<p>A streaming application can run indefinitely, so the <code>TStream</code> might see an arbitrarily large number of readings pass through it. Because a <code>TStream</code> represents the flow of your data, it supports a number of operations which allow you to modify your data.</p>
+
+<h3 id="filtering-a-tstream">Filtering a <code>TStream</code></h3>
+
+<p>In our example, we want to filter the stream of temperature readings, and remove any "uninteresting" or expected readings—specifically readings which are above 50 degrees and below 80 degrees. To do this, we call the <code>TStream</code>'s <code>filter</code> method and pass in a function that returns <em>true</em> if the data is interesting and <em>false</em> if the data is uninteresting:</p>
+<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="n">TStream</span><span class="o"><</span><span class="n">Double</span><span class="o">></span> <span class="n">filteredReadings</span> <span class="o">=</span> <span class="n">tempReadings</span><span class="o">.</span><span class="na">filter</span><span class="o">(</span><span class="n">reading</span> <span class="o">-></span> <span class="n">reading</span> <span class="o"><</span> <span class="mi">50</span> <span class="o">||</span> <span class="n">reading</span> <span class="o">></span> <span class="mi">80</span><span class="o">);</span>
+</code></pre></div>
+<p>As you can see, the function that is passed to <code>filter</code> operates on each tuple individually. Unlike data streaming frameworks like <a href="https://spark.apache.org/">Apache Spark</a>, which operate on a collection of data in batch mode, Edgent achieves low latency processing by manipulating each piece of data as soon as it becomes available. Filtering a <code>TStream</code> produces another <code>TStream</code> that contains only the filtered tuples; for example, the <code>filteredReadings</code> stream.</p>
+
+<h3 id="printing-to-output">Printing to output</h3>
+
+<p>When our application detects interesting data (data outside of the expected parameters), we want to print results. You can do this by calling the <code>TStream.print()</code> method, which prints using <code>.toString()</code> on each tuple that passes through the stream:</p>
+<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="n">filteredReadings</span><span class="o">.</span><span class="na">print</span><span class="o">();</span>
+</code></pre></div>
+<p>Unlike <code>TStream.filter()</code>, <code>TStream.print()</code> does not produce another <code>TStream</code>. This is because <code>TStream.print()</code> is a <strong>sink</strong>, which represents the terminus of a stream.</p>
+
+<p>In addition to <code>TStream.print()</code> there are other sink operations that send tuples to an MQTT server, JDBC connection, file, or Kafka cluster. Additionally, you can define your own sink by invoking <code>TStream.sink()</code> and passing in your own function.</p>
+
+<h3 id="submitting-your-application">Submitting your application</h3>
+
+<p>Now that your application has been completely declared, the final step is to run your application.</p>
+
+<p><code>DirectProvider</code> contains a <code>submit()</code> method, which runs your application directly within the current virtual machine:</p>
+<div class="highlight"><pre><code class="language-java" data-lang="java"><span class="n">dp</span><span class="o">.</span><span class="na">submit</span><span class="o">(</span><span class="n">topology</span><span class="o">);</span>
+</code></pre></div>
+<p>After you run your program, you should see output containing only "interesting" data coming from your sensor:</p>
+<div class="highlight"><pre><code class="language-" data-lang="">49.904032311772596
+47.97837504039084
+46.59272336309031
+46.681544551652934
+47.400819234155236
+...
+</code></pre></div>
+<p>As you can see, all temperatures are outside the 50-80 degree range. In terms of a real-world application, this would prevent a device from sending superfluous data over a network, thereby reducing communication costs.</p>
+
+<h2 id="further-examples">Further examples</h2>
+
+<p>This example demonstrates a small piece of Edgent's functionality. Edgent supports more complicated topologies, such as topologies that require merging and splitting data streams, or perform operations which aggregate the last <em>N</em> seconds of data (for example, calculating a moving average).</p>
+
+<p>For more complex examples, see:</p>
+
+<ul>
+<li><a href="samples">Edgent sample programs</a></li>
+<li><a href="common-edgent-operations">Common Edgent operations</a></li>
+</ul>
+
+
+<div class="tags">
+
+</div>
+
+<!--
+
+ <div id="disqus_thread"></div>
+ <script type="text/javascript">
+ /* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
+ var disqus_shortname = 'idrbwjekyll'; // required: replace example with your forum shortname
+
+ /* * * DON'T EDIT BELOW THIS LINE * * */
+ (function() {
+ var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
+ dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
+ (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
+ })();
+ </script>
+ <noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
+ -->
+
+</div>
+
+
+
+<footer>
+ <div class="row">
+ <div class="col-lg-12 footer">
+
+ Site last
+ generated: Jul 26, 2016 <br/>
+
+ </div>
+ </div>
+ <br/>
+ <div class="row">
+ <div class="col-md-12">
+ <p class="small">Apache Edgent is an effort undergoing Incubation at The Apache Software
+ Foundation (ASF), sponsored by the Incubator. Incubation is required of all newly accepted projects
+ until a further review indicates that the infrastructure, communications, and decision making process
+ have stabilized in a manner consistent with other successful ASF projects. While incubation status is
+ not necessarily a reflection of the completeness or stability of the code, it does indicate that the
+ project has yet to be fully endorsed by the ASF.</p>
+ </div>
+ </div>
+ <div class="row">
+ <div class="col-md-12">
+ <p class="small">Copyright � 2016 The Apache Software Foundation. Licensed under the Apache
+ License, Version 2.0.
+ Apache, the Apache Feather logo, and the Apache Incubator project logo are trademarks of The Apache
+ Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their
+ respective owners.</p>
+ </div>
+ </div>
+</footer>
+
+ </div><!-- /.row -->
+
+ </div> <!-- /.container -->
+
+</body>
+
+
+</html>
+
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/a13739b3/content/docs/edgent_index.html
----------------------------------------------------------------------
diff --git a/content/docs/edgent_index.html b/content/docs/edgent_index.html
new file mode 100644
index 0000000..66a6c9b
--- /dev/null
+++ b/content/docs/edgent_index.html
@@ -0,0 +1,694 @@
+<!DOCTYPE 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">
+<meta name="description" content="">
+<meta name="keywords" content=" ">
+<title>Apache Edgent documentation | Apache Edgent Documentation</title>
+<link rel="stylesheet" type="text/css" href="../css/syntax.css">
+<link rel="stylesheet" type="text/css" href="../css/font-awesome.min.css">
+<!--<link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css">-->
+<link rel="stylesheet" type="text/css" href="../css/modern-business.css">
+<link rel="stylesheet" type="text/css" href="../css/lavish-bootstrap.css">
+<link rel="stylesheet" type="text/css" href="../css/customstyles.css">
+<link rel="stylesheet" type="text/css" href="../css/theme-blue.css">
+<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.4.1/jquery.cookie.min.js"></script>
+<script src="../js/jquery.navgoco.min.js"></script>
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/2.0.0/anchor.min.js"></script>
+<script src="../js/toc.js"></script>
+<script src="../js/customscripts.js"></script>
+<link rel="shortcut icon" href="../common_images/favicon.ico" type="image/x-icon">
+<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
+<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
+<!--[if lt IE 9]>
+<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
+<![endif]-->
+
+
+
+
+
+
+
+
+
+<script>
+ $(function () {
+ $('[data-toggle="tooltip"]').tooltip()
+ })
+</script>
+
+
+
+ </head>
+
+<body>
+
+ <!-- Navigation -->
+<nav class="navbar navbar-inverse navbar-fixed-top" role="navigation">
+ <div class="container topnavlinks">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+
+ <a class="fa fa-home fa-lg navbar-brand" href="../docs/home.html"> <span class="projectTitle"> Apache Edgent Documentation</span></a>
+
+ </div>
+ <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
+ <ul class="nav navbar-nav navbar-right">
+ <!-- entries without drop-downs appear here -->
+ <!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->
+
+
+
+
+
+
+
+
+
+ <li class="dropdown">
+
+
+
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">GitHub Repos<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+
+
+ <li><a href="https://github.com/apache/incubator-quarks" target="_blank">Source code</a></li>
+
+
+
+
+
+ <li><a href="https://github.com/apache/incubator-quarks-website" target="_blank">Website/Documentation</a></li>
+
+
+
+
+
+ </ul>
+ </li>
+
+
+
+
+
+
+
+
+ <li><a href="http://quarks.incubator.apache.org/javadoc/latest/index.html" target="_blank">Javadoc</a></li>
+
+
+
+
+
+
+ <!-- entries with drop-downs appear here -->
+ <!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->
+
+ <li class="dropdown">
+
+
+
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Edgent Resources<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+
+
+ <li><a href="https://github.com/apache/incubator-quarks/releases" target="_blank">Download</a></li>
+
+
+
+
+
+ <li><a href="samples">Samples</a></li>
+
+
+
+
+
+ <li><a href="faq">FAQ</a></li>
+
+
+
+
+
+ </ul>
+ </li>
+
+
+
+
+ <!-- special insertion -->
+
+
+ <!-- Send feedback function -->
+<script>
+function SendLinkByMail(href) {
+var subject= "Apache Edgent Documentation feedback";
+var body = "I have some feedback about the Apache Edgent documentation page: ";
+body += window.location.href;
+body += "";
+var uri = "mailto:?subject=";
+uri += encodeURIComponent(subject);
+uri += "&body=";
+uri += encodeURIComponent(body);
+window.location.href = uri;
+}
+</script>
+
+<li><a href="mailto:dev@quarks.incubator.apache.org" target="_blank"><i class="fa fa-envelope-o"></i> Feedback</a></li>
+
+
+ <!--uncomment this block if you want simple search instead of algolia-->
+ <li>
+ <!--start search-->
+ <div id="search-demo-container">
+ <input type="text" id="search-input" placeholder="search...">
+ <ul id="results-container"></ul>
+ </div>
+ <script src="../js/jekyll-search.js" type="text/javascript"></script>
+ <script type="text/javascript">
+ SimpleJekyllSearch.init({
+ searchInput: document.getElementById('search-input'),
+ resultsContainer: document.getElementById('results-container'),
+ dataSource: '../search.json',
+ searchResultTemplate: '<li><a href="{url}" title="Apache Edgent documentation">{title}</a></li>',
+ noResultsText: 'No results found.',
+ limit: 10,
+ fuzzy: true,
+ })
+ </script>
+ <!--end search-->
+ </li>
+
+
+ </div>
+ <!-- /.container -->
+</nav>
+
+
+
+ <!-- Page Content -->
+ <div class="container">
+ <div class="col-lg-12"> </div>
+
+
+<!-- Content Row -->
+<div class="row">
+ <!-- Sidebar Column -->
+ <div class="col-md-3">
+
+ <script>
+
+ $(document).ready(function() {
+ // Initialize navgoco with default options
+ $("#mysidebar").navgoco({
+ caretHtml: '',
+ accordion: true,
+ openClass: 'active', // open
+ save: true,
+ cookie: {
+ name: 'navgoco',
+ expires: false,
+ path: '/'
+ },
+ slide: {
+ duration: 400,
+ easing: 'swing'
+ }
+ });
+
+ $("#collapseAll").click(function(e) {
+ e.preventDefault();
+ $("#mysidebar").navgoco('toggle', false);
+ });
+
+ $("#expandAll").click(function(e) {
+ e.preventDefault();
+ $("#mysidebar").navgoco('toggle', true);
+ });
+
+ });
+
+ </script>
+
+
+
+
+
+
+
+
+
+
+
+
+ <ul id="mysidebar" class="nav">
+
+ <span class="siteTagline">Edgent</span>
+ <span class="versionTagline">Version 0.3.0</span>
+
+
+
+
+
+
+ <li><a href="#">Overview</a>
+ <ul>
+
+
+
+
+ <li class="active"><a href="../docs/edgent_index.html">Introduction</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../docs/faq.html">FAQ</a></li>
+
+
+
+
+
+
+ </ul>
+
+
+
+ <li><a href="#">Get Started</a>
+ <ul>
+
+
+
+
+ <li><a href="../docs/edgent-getting-started.html">Getting started guide</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../docs/common-edgent-operations.html">Common operations</a></li>
+
+
+
+
+
+
+ </ul>
+
+
+
+ <li><a href="#">Edgent Cookbook</a>
+ <ul>
+
+
+
+
+ <li><a href="../recipes/recipe_hello_edgent.html">Hello Edgent!</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../recipes/recipe_source_function.html">Writing a source function</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../recipes/recipe_value_out_of_range.html">Detecting a sensor value out of expected range</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../recipes/recipe_different_processing_against_stream.html">Applying different processing against a single stream</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../recipes/recipe_combining_streams_processing_results.html">Splitting a stream to apply different processing and combining the results into a single stream</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../recipes/recipe_external_filter_range.html">Using an external configuration file for filter ranges</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../recipes/recipe_adaptable_filter_range.html">Changing a filter's range</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../recipes/recipe_adaptable_polling_source.html">Changing a polled source stream's period</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../recipes/recipe_adaptable_deadtime_filter.html">Using an adaptable deadtime filter</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../recipes/recipe_dynamic_analytic_control.html">Dynamically enabling analytic flows</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../recipes/recipe_parallel_analytics.html">How can I run analytics on several tuples in parallel?</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../recipes/recipe_concurrent_analytics.html">How can I run several analytics on a tuple concurrently?</a></li>
+
+
+
+
+
+
+ </ul>
+
+
+
+ <li><a href="#">Sample Programs</a>
+ <ul>
+
+
+
+
+ <li><a href="../docs/samples.html">Samples</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../docs/quickstart.html">Quickstart IBM Watson IoT Platform</a></li>
+
+
+
+
+
+
+ </ul>
+
+
+
+ <li><a href="#">Using the Console</a>
+ <ul>
+
+
+
+
+ <li><a href="../docs/console.html">Using the console</a></li>
+
+
+
+
+
+
+ </ul>
+
+
+
+ <li><a href="#">Get Involved</a>
+ <ul>
+
+
+
+
+ <li><a href="../docs/community.html">How to participate</a></li>
+
+
+
+
+
+
+
+
+
+ <li><a href="../docs/committers.html">Committers</a></li>
+
+
+
+
+
+
+ </ul>
+
+
+
+
+
+ <!-- if you aren't using the accordion, uncomment this block:
+
+ <p class="external">
+ <a href="#" id="collapseAll">Collapse All</a> | <a href="#" id="expandAll">Expand All</a>
+ </p>
+ -->
+ <br/>
+ </li>
+ </ul>
+ <div class="row">
+ <div class="col-md-12">
+
+<!-- this handles the automatic toc. use ## for subheads to auto-generate the on-page minitoc. if you use html tags, you must supply an ID for the heading element in order for it to appear in the minitoc. -->
+<script>
+$( document ).ready(function() {
+ // Handler for .ready() called.
+
+$('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2,h3,h4' });
+
+/* this offset helps account for the space taken up by the floating toolbar. */
+$('#toc').on('click', 'a', function() {
+ var target = $(this.getAttribute('href'))
+ , scroll_target = target.offset().top
+
+ $(window).scrollTop(scroll_target - 10);
+ return false
+})
+
+});
+</script>
+
+
+<div id="toc"></div>
+
+ </div>
+ </div>
+ </div>
+
+ <!-- this highlights the active parent class in the navgoco sidebar. this is critical so that the parent expands when you're viewing a page. This must appear below the sidebar code above. Otherwise, if placed inside customscripts.js, the script runs before the sidebar code runs and the class never gets inserted.-->
+ <script>$("li.active").parents('li').toggleClass("active");</script>
+
+
+ <!-- Content Column -->
+ <div class="col-md-9">
+
+ <div class="post-header">
+ <h1 class="post-title-main">Apache Edgent documentation</h1>
+</div>
+
+<div class="post-content">
+
+
+
+<!-- this handles the automatic toc. use ## for subheads to auto-generate the on-page minitoc. if you use html tags, you must supply an ID for the heading element in order for it to appear in the minitoc. -->
+<script>
+$( document ).ready(function() {
+ // Handler for .ready() called.
+
+$('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2,h3,h4' });
+
+/* this offset helps account for the space taken up by the floating toolbar. */
+$('#toc').on('click', 'a', function() {
+ var target = $(this.getAttribute('href'))
+ , scroll_target = target.offset().top
+
+ $(window).scrollTop(scroll_target - 10);
+ return false
+})
+
+});
+</script>
+
+
+<div id="toc"></div>
+
+
+
+
+ <a target="_blank" href="https://github.com/apache/incubator-quarks-website/blob/master/site/docs/edgent_index.md" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
+
+ <h2 id="new-documentation">New documentation</h2>
+
+<p>Apache Edgent is evolving, and so is the documentation. If the existing documentation hasn't answered your questions, you can request new or updated documentation by opening a <a href="https://issues.apache.org/jira/browse/QUARKS">JIRA</a> issue.</p>
+
+<h2 id="providing-feedback">Providing feedback</h2>
+
+<p>To provide feedback on our documentation:</p>
+
+<ol>
+<li>Navigate to the documentation page for which you are providing feedback</li>
+<li>Click on the <strong>Feedback</strong> button in the top right corner</li>
+</ol>
+
+<p>This will open an issue for the page that you are currently visiting.</p>
+
+<h2 id="contributing-documentation">Contributing documentation</h2>
+
+<p>If you have ideas on how we can better document or explain some of the concepts, we would love to have your contribution! This site uses GitHub's flavor of Markdown and Jekyll markdown for our documentation.</p>
+
+<p>Refer to this documentation on GitHub's flavor of Markdown: <a href="https://help.github.com/categories/writing-on-github">Writing on GitHub</a>.</p>
+
+<p>Refer to this documentation to get started: <a href="https://help.github.com/articles/using-jekyll-with-pages/">Using Jekyll with Pages</a>.</p>
+
+<p>To contribute, clone this project locally, make your changes, and create a <a href="https://github.com/apache/incubator-quarks-website/pulls">pull request</a>.</p>
+
+<p>To learn more, visit <a href="community">Get Involved</a>.</p>
+
+
+<div class="tags">
+
+</div>
+
+<!--
+
+ <div id="disqus_thread"></div>
+ <script type="text/javascript">
+ /* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
+ var disqus_shortname = 'idrbwjekyll'; // required: replace example with your forum shortname
+
+ /* * * DON'T EDIT BELOW THIS LINE * * */
+ (function() {
+ var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
+ dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
+ (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
+ })();
+ </script>
+ <noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
+ -->
+
+</div>
+
+
+
+<footer>
+ <div class="row">
+ <div class="col-lg-12 footer">
+
+ Site last
+ generated: Jul 26, 2016 <br/>
+
+ </div>
+ </div>
+ <br/>
+ <div class="row">
+ <div class="col-md-12">
+ <p class="small">Apache Edgent is an effort undergoing Incubation at The Apache Software
+ Foundation (ASF), sponsored by the Incubator. Incubation is required of all newly accepted projects
+ until a further review indicates that the infrastructure, communications, and decision making process
+ have stabilized in a manner consistent with other successful ASF projects. While incubation status is
+ not necessarily a reflection of the completeness or stability of the code, it does indicate that the
+ project has yet to be fully endorsed by the ASF.</p>
+ </div>
+ </div>
+ <div class="row">
+ <div class="col-md-12">
+ <p class="small">Copyright � 2016 The Apache Software Foundation. Licensed under the Apache
+ License, Version 2.0.
+ Apache, the Apache Feather logo, and the Apache Incubator project logo are trademarks of The Apache
+ Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their
+ respective owners.</p>
+ </div>
+ </div>
+</footer>
+
+ </div><!-- /.row -->
+
+ </div> <!-- /.container -->
+
+</body>
+
+
+</html>
+