eagle-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From h..@apache.org
Subject svn commit: r1789965 [4/7] - in /eagle/site/docs: latest/include/images/ latest/js/ latest/license/ latest/license/highlight.js/ latest/mkdocs/js/ v0.5.0/ v0.5.0/applications/ v0.5.0/developing-application/ v0.5.0/getting-started/ v0.5.0/include/images...
Date Mon, 03 Apr 2017 11:33:15 GMT
Added: eagle/site/docs/v0.5.0/getting-started/index.html
URL: http://svn.apache.org/viewvc/eagle/site/docs/v0.5.0/getting-started/index.html?rev=1789965&view=auto
==============================================================================
--- eagle/site/docs/v0.5.0/getting-started/index.html (added)
+++ eagle/site/docs/v0.5.0/getting-started/index.html Mon Apr  3 11:33:14 2017
@@ -0,0 +1,961 @@
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  
+  
+  <title>Getting Started - Apache Eagle Documentation</title>
+  
+
+  <link rel="shortcut icon" href="../include/images/favicon.png">
+  
+
+  
+  <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
+
+  <link rel="stylesheet" href="../css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
+  <link rel="stylesheet" href="../css/highlight.css">
+
+  
+  <script>
+    // Current page data
+    var mkdocs_page_name = "Getting Started";
+    var mkdocs_page_input_path = "getting-started.md";
+    var mkdocs_page_url = "/getting-started/";
+  </script>
+  
+  <script src="../js/jquery-2.1.1.min.js"></script>
+  <script src="../js/modernizr-2.8.3.min.js"></script>
+  <script type="text/javascript" src="../js/highlight.pack.js"></script>
+  <script src="../js/theme.js"></script> 
+
+  
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+  <div class="wy-grid-for-nav">
+
+    
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
+      <div class="wy-side-nav-search">
+        <a href=".." class="icon icon-home"> Apache Eagle Documentation</a>
+        <div role="search">
+  <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+  </form>
+</div>
+      </div>
+
+      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+        <ul class="current">
+          
+            <li><script>
+    function select(elem) {
+        var selectedClassName = "selected";
+        $(".wy-menu-vertical li.selected").removeClass(selectedClassName);
+        $(elem).addClass(selectedClassName);
+    }
+</script>
+
+<!-- 
+    this macro is to fetch the first child element that has url and return the url as the default one of the section
+    arguemnt:
+      ni: nav_item, corresponding to navigation item configured in mkdocs.yml's "pages"
+ -->
+
+
+<!-- 
+    this macro generates the style for indentation on sub tocs in side nav
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- 
+    this macro shows toc items including nested tocs, toc nesting level would depending on arguments described below
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- generate side nav based on navigation configured in mkdocs.yml -->
+
+    <li class="toctree-l1 ">
+        <a class="" href="..">Home</a>
+        
+    </li>
+<li>
+          
+            <li><script>
+    function select(elem) {
+        var selectedClassName = "selected";
+        $(".wy-menu-vertical li.selected").removeClass(selectedClassName);
+        $(elem).addClass(selectedClassName);
+    }
+</script>
+
+<!-- 
+    this macro is to fetch the first child element that has url and return the url as the default one of the section
+    arguemnt:
+      ni: nav_item, corresponding to navigation item configured in mkdocs.yml's "pages"
+ -->
+
+
+<!-- 
+    this macro generates the style for indentation on sub tocs in side nav
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- 
+    this macro shows toc items including nested tocs, toc nesting level would depending on arguments described below
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- generate side nav based on navigation configured in mkdocs.yml -->
+
+    <li class="toctree-l1 current">
+        <a class="current" href="./">Getting Started</a>
+        
+            <ul>
+            
+                
+    
+        <li class="toctree-l3" onclick="select(this)"><a 
+    
+        
+    
+ href="#architecture">Architecture</a></li>
+        
+            <ul>
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 4em;"
+    
+ href="#eagle-apps">Eagle Apps</a></li>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 4em;"
+    
+ href="#eagle-interface">Eagle Interface</a></li>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 4em;"
+    
+ href="#eagle-integration">Eagle Integration</a></li>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 4em;"
+    
+ href="#eagle-framework">Eagle Framework</a></li>
+        
+            <ul>
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 5em;"
+    
+ href="#alert-engine">Alert Engine</a></li>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 5em;"
+    
+ href="#storage-engine">Storage Engine</a></li>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 5em;"
+    
+ href="#ui-framework">UI Framework</a></li>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 5em;"
+    
+ href="#application-framework">Application Framework</a></li>
+        
+            <ul>
+            
+                
+    
+        
+    
+
+            
+                
+    
+        
+    
+
+            
+                
+    
+        
+    
+
+            
+            </ul>
+        
+    
+
+            
+            </ul>
+        
+    
+
+            
+            </ul>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l3" onclick="select(this)"><a 
+    
+        
+    
+ href="#concepts">Concepts</a></li>
+        
+            <ul>
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 4em;"
+    
+ href="#site">Site</a></li>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 4em;"
+    
+ href="#application_1">Application</a></li>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 4em;"
+    
+ href="#policy">Policy</a></li>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 4em;"
+    
+ href="#alerts">Alerts</a></li>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 4em;"
+    
+ href="#data-source">Data Source</a></li>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 4em;"
+    
+ href="#stream">Stream</a></li>
+        
+    
+
+            
+            </ul>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l3" onclick="select(this)"><a 
+    
+        
+    
+ href="#quick-start">Quick Start</a></li>
+        
+            <ul>
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 4em;"
+    
+ href="#deployment">Deployment</a></li>
+        
+            <ul>
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 5em;"
+    
+ href="#prerequisites">Prerequisites</a></li>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 5em;"
+    
+ href="#installation">Installation</a></li>
+        
+            <ul>
+            
+                
+    
+        
+    
+
+            
+                
+    
+        
+    
+
+            
+            </ul>
+        
+    
+
+            
+            </ul>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 4em;"
+    
+ href="#setup-your-monitoring-case">Setup Your Monitoring Case</a></li>
+        
+    
+
+            
+            </ul>
+        
+    
+
+            
+            </ul>
+        
+    </li>
+<li>
+          
+            <li><script>
+    function select(elem) {
+        var selectedClassName = "selected";
+        $(".wy-menu-vertical li.selected").removeClass(selectedClassName);
+        $(elem).addClass(selectedClassName);
+    }
+</script>
+
+<!-- 
+    this macro is to fetch the first child element that has url and return the url as the default one of the section
+    arguemnt:
+      ni: nav_item, corresponding to navigation item configured in mkdocs.yml's "pages"
+ -->
+
+
+<!-- 
+    this macro generates the style for indentation on sub tocs in side nav
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- 
+    this macro shows toc items including nested tocs, toc nesting level would depending on arguments described below
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- generate side nav based on navigation configured in mkdocs.yml -->
+
+    <li class="toctree-l1 ">
+        <a class="" href="../using-eagle/">Using Eagle</a>
+        
+    </li>
+<li>
+          
+            <li><script>
+    function select(elem) {
+        var selectedClassName = "selected";
+        $(".wy-menu-vertical li.selected").removeClass(selectedClassName);
+        $(elem).addClass(selectedClassName);
+    }
+</script>
+
+<!-- 
+    this macro is to fetch the first child element that has url and return the url as the default one of the section
+    arguemnt:
+      ni: nav_item, corresponding to navigation item configured in mkdocs.yml's "pages"
+ -->
+
+
+<!-- 
+    this macro generates the style for indentation on sub tocs in side nav
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- 
+    this macro shows toc items including nested tocs, toc nesting level would depending on arguments described below
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- generate side nav based on navigation configured in mkdocs.yml -->
+
+    <li class="toctree-l1 ">
+        <a class="" href="../applications/">Applications</a>
+        
+    </li>
+<li>
+          
+            <li><script>
+    function select(elem) {
+        var selectedClassName = "selected";
+        $(".wy-menu-vertical li.selected").removeClass(selectedClassName);
+        $(elem).addClass(selectedClassName);
+    }
+</script>
+
+<!-- 
+    this macro is to fetch the first child element that has url and return the url as the default one of the section
+    arguemnt:
+      ni: nav_item, corresponding to navigation item configured in mkdocs.yml's "pages"
+ -->
+
+
+<!-- 
+    this macro generates the style for indentation on sub tocs in side nav
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- 
+    this macro shows toc items including nested tocs, toc nesting level would depending on arguments described below
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- generate side nav based on navigation configured in mkdocs.yml -->
+
+    <li class="toctree-l1 ">
+        <a class="" href="../developing-application/">Developing Application</a>
+        
+    </li>
+<li>
+          
+            <li><script>
+    function select(elem) {
+        var selectedClassName = "selected";
+        $(".wy-menu-vertical li.selected").removeClass(selectedClassName);
+        $(elem).addClass(selectedClassName);
+    }
+</script>
+
+<!-- 
+    this macro is to fetch the first child element that has url and return the url as the default one of the section
+    arguemnt:
+      ni: nav_item, corresponding to navigation item configured in mkdocs.yml's "pages"
+ -->
+
+
+<!-- 
+    this macro generates the style for indentation on sub tocs in side nav
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- 
+    this macro shows toc items including nested tocs, toc nesting level would depending on arguments described below
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- generate side nav based on navigation configured in mkdocs.yml -->
+
+    <li class="toctree-l1 ">
+        <a class="" href="../underlying-design/">Underlying Design</a>
+        
+    </li>
+<li>
+          
+            <li><script>
+    function select(elem) {
+        var selectedClassName = "selected";
+        $(".wy-menu-vertical li.selected").removeClass(selectedClassName);
+        $(elem).addClass(selectedClassName);
+    }
+</script>
+
+<!-- 
+    this macro is to fetch the first child element that has url and return the url as the default one of the section
+    arguemnt:
+      ni: nav_item, corresponding to navigation item configured in mkdocs.yml's "pages"
+ -->
+
+
+<!-- 
+    this macro generates the style for indentation on sub tocs in side nav
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- 
+    this macro shows toc items including nested tocs, toc nesting level would depending on arguments described below
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- generate side nav based on navigation configured in mkdocs.yml -->
+
+    <li class="toctree-l1 ">
+        <a class="" href="../reference/">Reference</a>
+        
+    </li>
+<li>
+          
+        </ul>
+      </div>
+      &nbsp;
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+      
+      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+        <a href="..">Apache Eagle Documentation</a>
+      </nav>
+
+      
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="breadcrumbs navigation">
+  <ul class="wy-breadcrumbs">
+    <li><a href="..">Docs</a> &raquo;</li>
+    
+      
+    
+    <li>Getting Started</li>
+    <li class="wy-breadcrumbs-aside">
+      
+        
+          <a href="https://github.com/apache/eagle/tree/master/docs" class="icon icon-github"> Edit on GitHub</a>
+        
+      
+    </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main">
+            <div class="section">
+              
+                <h1 id="architecture">Architecture</h1>
+<p><img alt="Eagle 0.5.0 Architecture" src="../include/images/eagle_arch_v0.5.0.png" /></p>
+<h3 id="eagle-apps">Eagle Apps</h3>
+<ul>
+<li>Security</li>
+<li>Hadoop</li>
+<li>Operational Intelligence</li>
+</ul>
+<p>For more applications, see <a href="../applications">Applications</a>.</p>
+<h3 id="eagle-interface">Eagle Interface</h3>
+<ul>
+<li>REST Service</li>
+<li>Management UI</li>
+<li>Customizable Analytics Visualization</li>
+</ul>
+<h3 id="eagle-integration">Eagle Integration</h3>
+<ul>
+<li><a href="https://ambari.apache.org">Apache Ambari</a></li>
+<li><a href="https://www.docker.com">Docker</a></li>
+<li><a href="http://ranger.apache.org">Apache Ranger</a></li>
+<li><a href="https://www.dataguise.com">Dataguise</a></li>
+</ul>
+<h3 id="eagle-framework">Eagle Framework</h3>
+<p>Eagle has multiple distributed real-time frameworks for efficiently developing highly scalable monitoring applications.</p>
+<h4 id="alert-engine">Alert Engine</h4>
+<p><img alt="Eagle Alert Engine" src="../include/images/alert_engine.png" /></p>
+<ul>
+<li>Real-time: Apache Storm (Execution Engine) + Kafka (Message Bus)</li>
+<li>
+<p>Declarative Policy: SQL (CEP) on Streaming
+        from hadoopJmxMetricEventStream
+        [metric == "hadoop.namenode.fsnamesystemstate.capacityused" and value &gt; 0.9] 
+        select metric, host, value, timestamp, component, site 
+        insert into alertStream;</p>
+</li>
+<li>
+<p>Dynamical onboarding &amp; correlation</p>
+</li>
+<li>No downtime migration and upgrading</li>
+</ul>
+<h4 id="storage-engine">Storage Engine</h4>
+<p><img alt="Eagle Storage Engine" src="../include/images/storage_engine.png" /></p>
+<ul>
+<li>
+<p>Light-weight ORM Framework for HBase/RDMBS</p>
+<pre><code>@Table("HbaseTableName")
+@ColumnFamily("ColumnFamily")
+@Prefix("RowkeyPrefix")
+@Service("UniqueEntitytServiceName")
+@JsonIgnoreProperties(ignoreUnknown = true)
+@TimeSeries(false)
+@Indexes({
+    @Index(name="Index_1_alertExecutorId", columns = { "alertExecutorID" }, unique = true)})
+public class AlertDefinitionAPIEntity extends TaggedLogAPIEntity{
+@Column("a")
+private String desc;
+</code></pre>
+</li>
+<li>
+<p>Full-function SQL-Like REST Query </p>
+<pre><code>Query=UniqueEntitytServiceName[@site="sandbox"]{*}
+</code></pre>
+</li>
+<li>
+<p>Optimized Rowkey design for time-series data, optimized for metric/entity/log, etc. different storage types</p>
+<pre><code>Rowkey ::= Prefix | Partition Keys | timestamp | tagName | tagValue | …
+</code></pre>
+</li>
+<li>
+<p Index(name="INDEX_NAME", columns =" { &quot;SECONDARY_INDEX_COLUMN_NAME&quot; ">Secondary Index Support
+        @Indexes(, unique = true/false)})</p>
+</li>
+<li>
+<p>Native HBase Coprocessor
+        org.apache.eagle.storage.hbase.query.coprocessor.AggregateProtocolEndPoint</p>
+</li>
+</ul>
+<h4 id="ui-framework">UI Framework</h4>
+<p>Eagle UI is consist of following parts:</p>
+<ul>
+<li>Eagle Main UI</li>
+<li>Eagle App Portal/Dashboard/Widgets</li>
+<li>Eagle Customized Dashboard </li>
+</ul>
+<h4 id="application-framework">Application Framework</h4>
+<h5 id="application">Application</h5>
+<p>An "Application" or "App" is composed of data integration, policies and insights for one data source.</p>
+<h5 id="application-descriptor">Application Descriptor</h5>
+<p>An "Application Descriptor" is a static packaged metadata information consist of basic information like type, name, version, description, and application process, configuration, streams, docs, policies and so on. </p>
+<p>Here is an example ApplicationDesc of <code>JPM_WEB_APP</code></p>
+<pre><code>    {
+    type: "JPM_WEB_APP",
+    name: "Job Performance Monitoring Web ",
+    version: "0.5.0-incubating",
+    description: null,
+    appClass: "org.apache.eagle.app.StaticApplication",
+    jarPath: "/opt/eagle/0.5.0-incubating-SNAPSHOT-build-20161103T0332/eagle-0.5.0-incubating-SNAPSHOT/lib/eagle-topology-0.5.0-incubating-SNAPSHOT-hadoop-2.4.1-11-assembly.jar",
+    viewPath: "/apps/jpm",
+    providerClass: "org.apache.eagle.app.jpm.JPMWebApplicationProvider",
+    configuration: {
+        properties: [{
+            name: "service.host",
+            displayName: "Eagle Service Host",
+            value: "localhost",
+            description: "Eagle Service Host, default: localhost",
+            required: false
+        }, {
+            name: "service.port",
+            displayName: "Eagle Service Port",
+            value: "8080",
+            description: "Eagle Service Port, default: 8080",
+            required: false
+        }]
+    },
+    streams: null,
+    docs: null,
+    executable: false,
+    dependencies: [{
+        type: "MR_RUNNING_JOB_APP",
+        version: "0.5.0-incubating",
+        required: true
+    }, {
+        type: "MR_HISTORY_JOB_APP",
+        version: "0.5.0-incubating",
+        required: true
+    }]
+    }
+</code></pre>
+<h5 id="application-provider">Application Provider</h5>
+<p>Appilcation Provider is a package management and loading mechanism leveraging <a href="https://docs.oracle.com/javase/tutorial/ext/basics/spi.html">Java SPI</a>.</p>
+<p>For example, in file <code>META-INF/services/org.apache.eagle.app.spi.ApplicationProvider</code>, place the full class name of an application provider:</p>
+<pre><code>org.apache.eagle.app.jpm.JPMWebApplicationProvider
+</code></pre>
+<hr />
+<h1 id="concepts">Concepts</h1>
+<ul>
+<li>Here are some terms we are using in Apache Eagle (incubating, called Eagle in the following), please check them for your reference. They are basic knowledge of Eagle which also will help to well understand Eagle.</li>
+</ul>
+<h2 id="site">Site</h2>
+<ul>
+<li>A site can be considered as a physical data center. Big data platform e.g. Hadoop may be deployed to multiple data centers in an enterprise.</li>
+</ul>
+<h2 id="application_1">Application</h2>
+<ul>
+<li>An "Application" or "App" is composed of data integration, policies and insights for one data source.</li>
+</ul>
+<h2 id="policy">Policy</h2>
+<ul>
+<li>A "Policy" defines the rule to alert. Policy can be simply a filter expression or a complex window based aggregation rules etc.</li>
+</ul>
+<h2 id="alerts">Alerts</h2>
+<ul>
+<li>An "Alert" is an real-time event detected with certain alert policy or correlation logic, with different severity levels like INFO/WARNING/DANGER.</li>
+</ul>
+<h2 id="data-source">Data Source</h2>
+<ul>
+<li>A "Data Source" is a monitoring target data. Eagle supports many data sources HDFS audit logs, Hive2 query, MapReduce job etc.</li>
+</ul>
+<h2 id="stream">Stream</h2>
+<ul>
+<li>A "Stream" is the streaming data from a data source. Each data source has its own stream.</li>
+</ul>
+<hr />
+<h1 id="quick-start">Quick Start</h1>
+<h2 id="deployment">Deployment</h2>
+<h3 id="prerequisites">Prerequisites</h3>
+<p>Eagle requires the following dependencies:</p>
+<ul>
+<li>For streaming platform dependencies<ul>
+<li>Storm: 0.9.3 or later</li>
+<li>Hadoop: 2.6.x or later</li>
+<li>Hbase: 0.98.x or later</li>
+<li>Kafka: 0.8.x or later</li>
+<li>Zookeeper: 3.4.6 or later</li>
+<li>Java: 1.8.x</li>
+</ul>
+</li>
+<li>For metadata database dependencies (Choose one of them)<ul>
+<li>MangoDB 3.2.2 or later<ul>
+<li>Installation is required</li>
+</ul>
+</li>
+<li>Mysql 5.1.x or later<ul>
+<li>Installation is required</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<p>Notice:  </p>
+<blockquote>
+<pre><code>Storm 0.9.x does NOT support JDK8. You can replace asm-4.0.jar with asm-all-5.0.jar in the storm lib directory. 
+Then restart other services(nimbus/ui/supervisor).
+</code></pre>
+</blockquote>
+<h3 id="installation">Installation</h3>
+<h5 id="build-eagle">Build Eagle</h5>
+<ul>
+<li>
+<p>Download the latest version of Eagle source code.</p>
+<pre><code>git clone https://github.com/apache/incubator-eagle.git
+</code></pre>
+</li>
+<li>
+<p>Build the source code, and a tar.gz package will be generated under eagle-server-assembly/target</p>
+<pre><code>mvn clean install -DskipTests
+</code></pre>
+</li>
+</ul>
+<h5 id="deploy-eagle">Deploy Eagle</h5>
+<ul>
+<li>Copy binary package to your server machine. In the package, you should find:<ul>
+<li><strong>bin/</strong>: scripts used for start eagle server</li>
+<li><strong>conf/</strong>: default configurations for eagle server setup.</li>
+<li><strong>lib/</strong> : all included software packages for eagle server</li>
+</ul>
+</li>
+<li>Change configurations under <code>conf/</code><ul>
+<li><strong>eagle.conf</strong></li>
+<li><strong>server.yml</strong></li>
+</ul>
+</li>
+<li>
+<p>Run eagle-server.sh</p>
+<pre><code>./bin/eagle-server.sh start
+</code></pre>
+</li>
+<li>
+<p>Check eagle server</p>
+<ul>
+<li>Visit http://host:port/ in your web browser.</li>
+</ul>
+</li>
+</ul>
+<h2 id="setup-your-monitoring-case">Setup Your Monitoring Case</h2>
+<p><code>Placeholder for topic: Setup Your Monitoring Case</code></p>
+              
+            </div>
+          </div>
+          <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="../using-eagle/" class="btn btn-neutral float-right" title="Using Eagle">Next <span class="icon icon-circle-arrow-right"></span></a>
+      
+      
+        <a href=".." class="btn btn-neutral" title="Home"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+      
+    </div>
+  
+
+  <hr/>
+
+  <div role="contentinfo">
+    <!-- Copyright etc -->
+    
+  </div>
+
+  Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+</footer>
+	  
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+
+<div class="rst-versions" role="note" style="cursor: pointer">
+    <span class="rst-current-version" data-toggle="rst-current-version">
+      
+          <a href="https://github.com/apache/eagle/tree/master/docs" class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
+      
+      
+        <span><a href=".." style="color: #fcfcfc;">&laquo; Previous</a></span>
+      
+      
+        <span style="margin-left: 15px"><a href="../using-eagle/" style="color: #fcfcfc">Next &raquo;</a></span>
+      
+    </span>
+</div>
+
+</body>
+</html>

Propchange: eagle/site/docs/v0.5.0/getting-started/index.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: eagle/site/docs/v0.5.0/include/images/install_jmx_2.png
URL: http://svn.apache.org/viewvc/eagle/site/docs/v0.5.0/include/images/install_jmx_2.png?rev=1789965&view=auto
==============================================================================
Binary file - no diff available.

Propchange: eagle/site/docs/v0.5.0/include/images/install_jmx_2.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: eagle/site/docs/v0.5.0/include/images/install_jmx_3.png
URL: http://svn.apache.org/viewvc/eagle/site/docs/v0.5.0/include/images/install_jmx_3.png?rev=1789965&view=auto
==============================================================================
Binary file - no diff available.

Propchange: eagle/site/docs/v0.5.0/include/images/install_jmx_3.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: eagle/site/docs/v0.5.0/include/images/install_jmx_6.png
URL: http://svn.apache.org/viewvc/eagle/site/docs/v0.5.0/include/images/install_jmx_6.png?rev=1789965&view=auto
==============================================================================
Binary file - no diff available.

Propchange: eagle/site/docs/v0.5.0/include/images/install_jmx_6.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: eagle/site/docs/v0.5.0/include/images/integration_applications.png
URL: http://svn.apache.org/viewvc/eagle/site/docs/v0.5.0/include/images/integration_applications.png?rev=1789965&view=auto
==============================================================================
Binary file - no diff available.

Propchange: eagle/site/docs/v0.5.0/include/images/integration_applications.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: eagle/site/docs/v0.5.0/include/images/integration_sites.png
URL: http://svn.apache.org/viewvc/eagle/site/docs/v0.5.0/include/images/integration_sites.png?rev=1789965&view=auto
==============================================================================
Binary file - no diff available.

Propchange: eagle/site/docs/v0.5.0/include/images/integration_sites.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: eagle/site/docs/v0.5.0/include/images/jpm.jpg
URL: http://svn.apache.org/viewvc/eagle/site/docs/v0.5.0/include/images/jpm.jpg?rev=1789965&view=auto
==============================================================================
Binary file - no diff available.

Propchange: eagle/site/docs/v0.5.0/include/images/jpm.jpg
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: eagle/site/docs/v0.5.0/include/images/jpm_configure.png
URL: http://svn.apache.org/viewvc/eagle/site/docs/v0.5.0/include/images/jpm_configure.png?rev=1789965&view=auto
==============================================================================
Binary file - no diff available.

Propchange: eagle/site/docs/v0.5.0/include/images/jpm_configure.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: eagle/site/docs/v0.5.0/include/images/jpm_define_policy.png
URL: http://svn.apache.org/viewvc/eagle/site/docs/v0.5.0/include/images/jpm_define_policy.png?rev=1789965&view=auto
==============================================================================
Binary file - no diff available.

Propchange: eagle/site/docs/v0.5.0/include/images/jpm_define_policy.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: eagle/site/docs/v0.5.0/include/images/jpm_streams.png
URL: http://svn.apache.org/viewvc/eagle/site/docs/v0.5.0/include/images/jpm_streams.png?rev=1789965&view=auto
==============================================================================
Binary file - no diff available.

Propchange: eagle/site/docs/v0.5.0/include/images/jpm_streams.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: eagle/site/docs/v0.5.0/index.html
URL: http://svn.apache.org/viewvc/eagle/site/docs/v0.5.0/index.html?rev=1789965&view=auto
==============================================================================
--- eagle/site/docs/v0.5.0/index.html (added)
+++ eagle/site/docs/v0.5.0/index.html Mon Apr  3 11:33:14 2017
@@ -0,0 +1,791 @@
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  
+  
+  <title>Apache Eagle Documentation</title>
+  
+
+  <link rel="shortcut icon" href="include/images/favicon.png">
+  
+
+  
+  <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
+
+  <link rel="stylesheet" href="./css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="./css/theme_extra.css" type="text/css" />
+  <link rel="stylesheet" href="./css/highlight.css">
+
+  
+  <script>
+    // Current page data
+    var mkdocs_page_name = "None";
+    var mkdocs_page_input_path = "index.md";
+    var mkdocs_page_url = "/";
+  </script>
+  
+  <script src="./js/jquery-2.1.1.min.js"></script>
+  <script src="./js/modernizr-2.8.3.min.js"></script>
+  <script type="text/javascript" src="./js/highlight.pack.js"></script>
+  <script src="./js/theme.js"></script> 
+
+  
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+  <div class="wy-grid-for-nav">
+
+    
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
+      <div class="wy-side-nav-search">
+        <a href="." class="icon icon-home"> Apache Eagle Documentation</a>
+        <div role="search">
+  <form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+  </form>
+</div>
+      </div>
+
+      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+        <ul class="current">
+          
+            <li><script>
+    function select(elem) {
+        var selectedClassName = "selected";
+        $(".wy-menu-vertical li.selected").removeClass(selectedClassName);
+        $(elem).addClass(selectedClassName);
+    }
+</script>
+
+<!-- 
+    this macro is to fetch the first child element that has url and return the url as the default one of the section
+    arguemnt:
+      ni: nav_item, corresponding to navigation item configured in mkdocs.yml's "pages"
+ -->
+
+
+<!-- 
+    this macro generates the style for indentation on sub tocs in side nav
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- 
+    this macro shows toc items including nested tocs, toc nesting level would depending on arguments described below
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- generate side nav based on navigation configured in mkdocs.yml -->
+
+    <li class="toctree-l1 current">
+        <a class="current" href=".">Home</a>
+        
+            <ul>
+            
+                
+    
+        <li class="toctree-l3" onclick="select(this)"><a 
+    
+        
+    
+ href="#what-is-eagle">What is Eagle</a></li>
+        
+            <ul>
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 4em;"
+    
+ href="#terminology">Terminology</a></li>
+        
+            <ul>
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 5em;"
+    
+ href="#site">Site</a></li>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 5em;"
+    
+ href="#application">Application</a></li>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 5em;"
+    
+ href="#stream">Stream</a></li>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 5em;"
+    
+ href="#data-activity-monitoring">Data Activity Monitoring</a></li>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 5em;"
+    
+ href="#alert-engine">Alert Engine</a></li>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 5em;"
+    
+ href="#policy">Policy</a></li>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 5em;"
+    
+ href="#alert">Alert</a></li>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 5em;"
+    
+ href="#alert-publisher">Alert Publisher</a></li>
+        
+    
+
+            
+            </ul>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 4em;"
+    
+ href="#key-qualities">Key Qualities</a></li>
+        
+            <ul>
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 5em;"
+    
+ href="#extensible">Extensible</a></li>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 5em;"
+    
+ href="#scalable">Scalable</a></li>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 5em;"
+    
+ href="#real-time">Real-time</a></li>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 5em;"
+    
+ href="#dynamic">Dynamic</a></li>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 5em;"
+    
+ href="#easy-of-use">Easy-of-Use</a></li>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 5em;"
+    
+ href="#non-invasive">Non-Invasive</a></li>
+        
+    
+
+            
+            </ul>
+        
+    
+
+            
+            </ul>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l3" onclick="select(this)"><a 
+    
+        
+    
+ href="#use-case-examples">Use Case Examples</a></li>
+        
+            <ul>
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 4em;"
+    
+ href="#data-activity-monitoring_1">Data Activity Monitoring</a></li>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 4em;"
+    
+ href="#job-performance-analysis">Job Performance Analysis</a></li>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l4" onclick="select(this)"><a 
+    
+        
+        style="padding-left: 4em;"
+    
+ href="#cluster-performance-analytics">Cluster Performance Analytics</a></li>
+        
+    
+
+            
+            </ul>
+        
+    
+
+            
+                
+    
+        <li class="toctree-l3" onclick="select(this)"><a 
+    
+        
+    
+ href="#disclaimer">Disclaimer</a></li>
+        
+    
+
+            
+            </ul>
+        
+    </li>
+<li>
+          
+            <li><script>
+    function select(elem) {
+        var selectedClassName = "selected";
+        $(".wy-menu-vertical li.selected").removeClass(selectedClassName);
+        $(elem).addClass(selectedClassName);
+    }
+</script>
+
+<!-- 
+    this macro is to fetch the first child element that has url and return the url as the default one of the section
+    arguemnt:
+      ni: nav_item, corresponding to navigation item configured in mkdocs.yml's "pages"
+ -->
+
+
+<!-- 
+    this macro generates the style for indentation on sub tocs in side nav
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- 
+    this macro shows toc items including nested tocs, toc nesting level would depending on arguments described below
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- generate side nav based on navigation configured in mkdocs.yml -->
+
+    <li class="toctree-l1 ">
+        <a class="" href="getting-started/">Getting Started</a>
+        
+    </li>
+<li>
+          
+            <li><script>
+    function select(elem) {
+        var selectedClassName = "selected";
+        $(".wy-menu-vertical li.selected").removeClass(selectedClassName);
+        $(elem).addClass(selectedClassName);
+    }
+</script>
+
+<!-- 
+    this macro is to fetch the first child element that has url and return the url as the default one of the section
+    arguemnt:
+      ni: nav_item, corresponding to navigation item configured in mkdocs.yml's "pages"
+ -->
+
+
+<!-- 
+    this macro generates the style for indentation on sub tocs in side nav
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- 
+    this macro shows toc items including nested tocs, toc nesting level would depending on arguments described below
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- generate side nav based on navigation configured in mkdocs.yml -->
+
+    <li class="toctree-l1 ">
+        <a class="" href="using-eagle/">Using Eagle</a>
+        
+    </li>
+<li>
+          
+            <li><script>
+    function select(elem) {
+        var selectedClassName = "selected";
+        $(".wy-menu-vertical li.selected").removeClass(selectedClassName);
+        $(elem).addClass(selectedClassName);
+    }
+</script>
+
+<!-- 
+    this macro is to fetch the first child element that has url and return the url as the default one of the section
+    arguemnt:
+      ni: nav_item, corresponding to navigation item configured in mkdocs.yml's "pages"
+ -->
+
+
+<!-- 
+    this macro generates the style for indentation on sub tocs in side nav
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- 
+    this macro shows toc items including nested tocs, toc nesting level would depending on arguments described below
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- generate side nav based on navigation configured in mkdocs.yml -->
+
+    <li class="toctree-l1 ">
+        <a class="" href="applications/">Applications</a>
+        
+    </li>
+<li>
+          
+            <li><script>
+    function select(elem) {
+        var selectedClassName = "selected";
+        $(".wy-menu-vertical li.selected").removeClass(selectedClassName);
+        $(elem).addClass(selectedClassName);
+    }
+</script>
+
+<!-- 
+    this macro is to fetch the first child element that has url and return the url as the default one of the section
+    arguemnt:
+      ni: nav_item, corresponding to navigation item configured in mkdocs.yml's "pages"
+ -->
+
+
+<!-- 
+    this macro generates the style for indentation on sub tocs in side nav
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- 
+    this macro shows toc items including nested tocs, toc nesting level would depending on arguments described below
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- generate side nav based on navigation configured in mkdocs.yml -->
+
+    <li class="toctree-l1 ">
+        <a class="" href="developing-application/">Developing Application</a>
+        
+    </li>
+<li>
+          
+            <li><script>
+    function select(elem) {
+        var selectedClassName = "selected";
+        $(".wy-menu-vertical li.selected").removeClass(selectedClassName);
+        $(elem).addClass(selectedClassName);
+    }
+</script>
+
+<!-- 
+    this macro is to fetch the first child element that has url and return the url as the default one of the section
+    arguemnt:
+      ni: nav_item, corresponding to navigation item configured in mkdocs.yml's "pages"
+ -->
+
+
+<!-- 
+    this macro generates the style for indentation on sub tocs in side nav
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- 
+    this macro shows toc items including nested tocs, toc nesting level would depending on arguments described below
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- generate side nav based on navigation configured in mkdocs.yml -->
+
+    <li class="toctree-l1 ">
+        <a class="" href="underlying-design/">Underlying Design</a>
+        
+    </li>
+<li>
+          
+            <li><script>
+    function select(elem) {
+        var selectedClassName = "selected";
+        $(".wy-menu-vertical li.selected").removeClass(selectedClassName);
+        $(elem).addClass(selectedClassName);
+    }
+</script>
+
+<!-- 
+    this macro is to fetch the first child element that has url and return the url as the default one of the section
+    arguemnt:
+      ni: nav_item, corresponding to navigation item configured in mkdocs.yml's "pages"
+ -->
+
+
+<!-- 
+    this macro generates the style for indentation on sub tocs in side nav
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- 
+    this macro shows toc items including nested tocs, toc nesting level would depending on arguments described below
+    argument:
+      current_level: the level number of current toc item
+      max_level: a number indicating how many toc item levels should show up
+ -->
+
+
+<!-- generate side nav based on navigation configured in mkdocs.yml -->
+
+    <li class="toctree-l1 ">
+        <a class="" href="reference/">Reference</a>
+        
+    </li>
+<li>
+          
+        </ul>
+      </div>
+      &nbsp;
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+      
+      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+        <a href=".">Apache Eagle Documentation</a>
+      </nav>
+
+      
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="breadcrumbs navigation">
+  <ul class="wy-breadcrumbs">
+    <li><a href=".">Docs</a> &raquo;</li>
+    
+      
+    
+    <li>Home</li>
+    <li class="wy-breadcrumbs-aside">
+      
+        
+          <a href="https://github.com/apache/eagle/tree/master/docs" class="icon icon-github"> Edit on GitHub</a>
+        
+      
+    </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main">
+            <div class="section">
+              
+                <h1 id="what-is-eagle">What is Eagle</h1>
+<p><strong> Apache Eagle </strong> (incubating) is a highly extensible, scalable monitoring and alerting platform, designed with its flexible application framework and proven big data technologies, such as Kafka, Spark and Storm. It ships a rich set of applications for big data platform monitoring, e.g. HDFS/HBase/YARN service health check, JMX metrics, daemon logs, audit logs and yarn applications. External Eagle developers can define applications to monitoring their NoSQLs or Web Servers, and publish to Eagle application repository at your own discretion. It also provides the state-of-art alert engine to report security breaches, service failures, and application anomalies, highly customizable by the alert policy definition. </p>
+<p><img alt="overview" src="./include/images/overview.png" /></p>
+<h2 id="terminology">Terminology</h2>
+<h3 id="site">Site</h3>
+<ul>
+<li>A virtual concept in Apache Eagle. You can use it to manage a group of application instances, and distinguish the applications if you have a certain application installed for multiple times.</li>
+</ul>
+<h3 id="application">Application</h3>
+<ul>
+<li>Application(or Monitoring Application) is the first-class citizen in Apache Eagle, it stands for an end-to-end monitoring/alerting solution, which usually contains the monitoring source onboarding, source schema specification, alerting policy and dashboard definition.</li>
+</ul>
+<h3 id="stream">Stream</h3>
+<ul>
+<li>Stream is the input for Alert Engine, each Application should have its own stream to be defined by the developer. Usually, it will have a POJO-like structure included in the stream definition. Once it's defined, Application should have the logic to write data into Kafka.</li>
+</ul>
+<h3 id="data-activity-monitoring">Data Activity Monitoring</h3>
+<ul>
+<li>A built-in monitoring application to monitor HDFS/HBase/Hive operations, and allow users to define certain policies to detect sensitive data access and malicious data operations in real-time.</li>
+</ul>
+<h3 id="alert-engine">Alert Engine</h3>
+<ul>
+<li>A specific built-in application shared for all other monitoring applications, it reads data from Kafka, and processes the data by applying the policy in real-time manner, and generates alert notification. So we call this application as the Alert Engine.</li>
+</ul>
+<h3 id="policy">Policy</h3>
+<ul>
+<li>A rule used by Alert Engine to match the data input from Kafka. Policy is defined in <a href="https://docs.wso2.com/display/CEP300/Siddhi+Language+Specification">SiddhiQL</a> format.</li>
+</ul>
+<h3 id="alert">Alert</h3>
+<ul>
+<li>If any data input to Alert Engine meets the policy, the Alert Engine will generate a message and publish it through alert publisher. We call such messages as the alerts.</li>
+</ul>
+<h3 id="alert-publisher">Alert Publisher</h3>
+<ul>
+<li>It will publish the alert to external channels which can be the SMTP channel, the Kafka channel, Slack channel or other storage systems.</li>
+</ul>
+<h2 id="key-qualities">Key Qualities</h2>
+<h3 id="extensible">Extensible</h3>
+<ul>
+<li>Apache Eagle built its core framework around the application concept, application itself includes the logic for monitoring source data collection, pre-processing and normalization. Developer can easily develop his own out-of-box monitoring applications using Eagle's application framework, and deploy into Eagle.</li>
+</ul>
+<h3 id="scalable">Scalable</h3>
+<ul>
+<li>The Eagle core team has chosen the proven big data technologies to build its fundamental runtime, and apply a scalable core to make it adaptive according to the throughput of data stream as well as the number of monitored applications.</li>
+</ul>
+<h3 id="real-time">Real-time</h3>
+<ul>
+<li>Storm or Spark Streaming based computing engine allow us to apply the policy to data stream and generate alerts in real-time manner.</li>
+</ul>
+<h3 id="dynamic">Dynamic</h3>
+<ul>
+<li>The user can freely enable or disable a monitoring application without restarting the service. Eagle user can dynamically add/delet/change their alert policies without any impact to the underlying runtime.</li>
+</ul>
+<h3 id="easy-of-use">Easy-of-Use</h3>
+<ul>
+<li>User can enable the monitoring for a service within minutes effort by just choosing the corresponding monitoring application and configuring few parameters for the service.</li>
+</ul>
+<h3 id="non-invasive">Non-Invasive</h3>
+<ul>
+<li>Apache Eagle uses the out-of-box applications to monitor services, you don't need any change to your existing services.</li>
+</ul>
+<hr />
+<h1 id="use-case-examples">Use Case Examples</h1>
+<h2 id="data-activity-monitoring_1">Data Activity Monitoring</h2>
+<ul>
+<li>
+<p>Data activity represents how user explores data provided by big data platforms. Analyzing data activity and alerting for insecure access are fundamental requirements for securing enterprise data. As data volume is increasing exponentially with Hadoop, Hive, Spark technology, understanding data activities for every user becomes extremely hard, let alone to alert for a single malicious event in real time among petabytes streaming data per day.</p>
+</li>
+<li>
+<p>Securing enterprise data starts from understanding data activities for every user. Apache Eagle (incubating, called Eagle in the following) has integrated with many popular big data platforms e.g. Hadoop, Hive, Spark, Cassandra etc. With Eagle user can browse data hierarchy, mark sensitive data and then create comprehensive policy to alert for insecure data access.</p>
+</li>
+</ul>
+<h2 id="job-performance-analysis">Job Performance Analysis</h2>
+<ul>
+<li>
+<p>Running map/reduce job is the most popular way people use to analyze data in Hadoop system. Analyzing job performance and providing tuning suggestions are critical for Hadoop system stability, job SLA and resource usage etc.</p>
+</li>
+<li>
+<p>Eagle analyzes job performance with two complementing approaches. First Eagle periodically takes snapshots for all running jobs with YARN API, secondly Eagle continuously reads job lifecycle events immediately after the job is completed. With the two approaches, Eagle can analyze single job's trend, data skew problem, failure reasons etc. More interestingly, Eagle can analyze whole Hadoop cluster's performance by taking into account all jobs.</p>
+</li>
+</ul>
+<h2 id="cluster-performance-analytics">Cluster Performance Analytics</h2>
+<ul>
+<li>
+<p>It is critical to understand why a cluster performs bad. Is that because of some crazy jobs recently on-boarded, or huge amount of tiny files, or namenode performance degrading?</p>
+</li>
+<li>
+<p>Eagle in realtime calculates resource usage per minute out of individual jobs, e.g. CPU, memory, HDFS IO bytes, HDFS IO numOps etc. and also collects namenode JMX metrics. Correlating them together will easily help system administrator find root cause for cluster slowness.</p>
+</li>
+</ul>
+<hr />
+<h1 id="disclaimer">Disclaimer</h1>
+<ul>
+<li>Apache Eagle now is being incubated, and therefore, across the whole documentation site, all appearances of case-insensitive word <code>eagle</code> and <code>apache eagle</code> represent <code>Apache Eagle (incubating)</code>. This could be seen as a part of disclaimer.</li>
+</ul>
+              
+            </div>
+          </div>
+          <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="getting-started/" class="btn btn-neutral float-right" title="Getting Started">Next <span class="icon icon-circle-arrow-right"></span></a>
+      
+      
+    </div>
+  
+
+  <hr/>
+
+  <div role="contentinfo">
+    <!-- Copyright etc -->
+    
+  </div>
+
+  Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+</footer>
+	  
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+
+<div class="rst-versions" role="note" style="cursor: pointer">
+    <span class="rst-current-version" data-toggle="rst-current-version">
+      
+          <a href="https://github.com/apache/eagle/tree/master/docs" class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
+      
+      
+      
+        <span style="margin-left: 15px"><a href="getting-started/" style="color: #fcfcfc">Next &raquo;</a></span>
+      
+    </span>
+</div>
+
+</body>
+</html>
+
+<!--
+MkDocs version : 0.15.3
+Build Date UTC : 2017-04-03 11:18:38.368529
+-->

Propchange: eagle/site/docs/v0.5.0/index.html
------------------------------------------------------------------------------
    svn:eol-style = native



Mime
View raw message