_site/docs/deployment-in-sandbox.html - eagle - Git at Google

 <!DOCTYPE html>
 <head>
   	<meta charset="utf-8">
   	<meta http-equiv="X-UA-Compatible" content="IE=edge">

  	<title>Eagle - Get Started with Sandbox</title>
  	<meta name="description" content="Eagle - Analyze Big Data Platforms for Security and Performance">

 	<meta name="keywords" content="Eagle, Hadoop, Security, Real Time">
 	<meta name="author" content="eBay Inc.">

 	<meta charset="utf-8">
 	<meta name="viewport" content="initial-scale=1">

 	<link rel="stylesheet" href="/css/animate.css">
 	<link rel="stylesheet" href="/css/bootstrap.min.css">

 	<link rel="stylesheet" href="/css/font-awesome.min.css">

 	<link rel="stylesheet" href="/css/misc.css">
 	<link rel="stylesheet" href="/css/style.css">
 	<link rel="stylesheet" href="/css/styles.css">
   	<link rel="stylesheet" href="/css/main.css">
   	<link rel="alternate" type="application/rss+xml" title="Eagle" href="http://goeagle.io/feed.xml" />
   	<link rel="shortcut icon" href="/images/favicon.png">

   	<!-- Baidu Analytics Tracking-->
 	<script>
 	var _hmt = _hmt || [];
 	(function() {
 	  var hm = document.createElement("script");
 	  hm.src = "//hm.baidu.com/hm.js?fedc55df2ea52777a679192e8f849ece";
 	  var s = document.getElementsByTagName("script")[0];
 	  s.parentNode.insertBefore(hm, s);
 	})();
 	</script>

 	<!-- Google Analytics Tracking -->
 	<script>
 	  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
 	  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
 	  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
 	  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
 	  ga('create', 'UA-68929805-1', 'auto');
 	  ga('send', 'pageview');
 	</script>
 </head>
 <body>
 <!-- header start -->
 <div id="home_page">
   <div class="topbar">
     <div class="container">
       <div class="row" >
         <nav class="navbar navbar-default">
           <div class="container-fluid">
             <!-- Brand and toggle get grouped for better mobile display -->
             <div class="navbar-header">
               <button type="button" class="navbar-toggle collapsed" 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="navbar-brand" href="/"><img src="/images/logo2.png" height="44px" style="margin-top:-7px"></a> </div>

             <!-- Collect the nav links, forms, and other content for toggling -->
             <!-- <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
               <ul class="nav navbar-nav navbar-right" id="top-menu">
                 <li><a class="menu" href="/#home_page">HOME</a></li>
                 <li><a class="menu" href="/docs/">DOCS</a></li>
                 <li><a class="menu" href="/#about_page">ABOUT</a></li>
                 <li><a class="menu" href="/#diagram_page">ARCHITECTURE</a></li>
                 <li><a class="menu" href="/#modules_page">MODULES</a></li>
                 <li><a class="menu" href="/#usecase_page">USE CASES</a></li>
                 <li>
                 </li>
               </ul> -->
             </div>
           </div>
           <!-- /.container-fluid -->
         </nav>
       </div>
     </div>
   </div>
   <div class="headerimage">
     <div class="flexslider">
       <ul class="slides">
         <li><img src="/images/slider/4.jpg" alt="Slide 1"></li>
       </ul>
     </div>
   </div>
   <div class="particles" style="height:40%"> </div><!---particles-->
   <div class="slider-caption" style="top:80px;">
     <div class="homewrapper">
       <div class="hometitle">
         <a href="/">
           <img src="/images/feather.png" height="80px">
         </a>
       </div>
       <div class="hometext">
         <h2>Analyze Big Data Platforms For Security and Performance</h2>
         <div class="social-buttons">
           <a href="https://github.com/apache/eagle"><i class="fa fa-github"></i></a>
           <a href="http://twitter.com/TheApacheEagle"><i class="fa fa-twitter"></i></a>
           <a href="https://www.facebook.com/TheApacheEagle/"><i class="fa fa-facebook"></i></a>
           <a href="#"><i class="fa fa-weixin"></i></a>
           <!-- <a href="https://www.weibo.com/ApacheEagle/"><i class="fa fa-weibo"></i></a> -->
         </div>
      </div>
     </div>
   </div>
 </div>
 <!-- header end -->
 <div class="container-fluid page-content">
   <div class="row">
     <div class="col-md-10 col-md-offset-1">
       <!-- sidebar -->
       <div class="col-xs-6 col-sm-3" id="sidebar" role="navigation">
         <ul class="nav" id="adminnav">

         <li class="heading">Getting Started</li>

           <li class="sidenavli  "><a href="/docs/index.html" data-permalink="/docs/deployment-in-sandbox.html" id="">Introduction</a></li>

           <li class="sidenavli  "><a href="/docs/usecases.html" data-permalink="/docs/deployment-in-sandbox.html" id="">Use Cases</a></li>

           <li class="sidenavli  "><a href="/docs/terminology.html" data-permalink="/docs/deployment-in-sandbox.html" id="">Terminology</a></li>

           <li class="sidenavli  "><a href="/docs/ecosystem.html" data-permalink="/docs/deployment-in-sandbox.html" id="">Ecosystem</a></li>

           <li class="sidenavli  "><a href="/docs/community.html" data-permalink="/docs/deployment-in-sandbox.html" id="">Community</a></li>

           <li class="sidenavli  "><a href="/docs/FAQ.html" data-permalink="/docs/deployment-in-sandbox.html" id="">FAQ</a></li>

         <li class="divider"></li>

         <li class="heading">Documentations</li>

           <li class="sidenavli  "><a href="/docs/latest/" data-permalink="/docs/deployment-in-sandbox.html" id="">Latest version (v0.5.0)</a></li>

         <li class="divider"></li>

         <li class="heading">Download</li>

           <li class="sidenavli  "><a href="/docs/download-latest.html" data-permalink="/docs/deployment-in-sandbox.html" id="">Latest version (v0.5.0)</a></li>

           <li class="sidenavli  "><a href="/docs/download.html" data-permalink="/docs/deployment-in-sandbox.html" id="">Archived</a></li>

         <li class="divider"></li>

         <li class="heading">Supplement</li>

           <li class="sidenavli  "><a href="/docs/security.html" data-permalink="/docs/deployment-in-sandbox.html" id="">Security</a></li>

         <li class="divider"></li>

         <li class="sidenavli">
           <a href="mailto:dev@eagle.apache.org" target="_blank">Need Help?</a>
         </li>
         </ul>
       </div>
       <div class="col-xs-6 col-sm-9 page-main-content" style="margin-left: -15px" id="loadcontent">
         <h1 class="page-header" style="margin-top: 0px">Get Started with Sandbox</h1>
         <p>Here is the summary of the steps for setting up Apache Eagle (called Eagle in the following) in Hortonworks sandbox:</p>

 <ul>
   <li>Step 1: Setup sandbox image in a virtual machine</li>
   <li>Step 2: Setup Hadoop<sup id="fnref:HADOOP"><a href="#fn:HADOOP" class="footnote">1</a></sup> environment in sandbox</li>
   <li>Step 3: Download and extract a Eagle release to sandbox</li>
   <li>Step 4: Install Eagle</li>
   <li>Step 5: Stream HDFS audit log</li>
 </ul>

 <h3 id="step-1-setup-sandbox-image-in-a-virtual-machine"><strong>Step 1: Setup sandbox image in a virtual machine</strong></h3>

 <p>To install Eagle on a sandbox you need to run a HDP sandbox image in a virtual machine with 8GB memory recommended.</p>

 <ol>
   <li>Get Virtual Box or VMware <a href="http://hortonworks.com/products/hortonworks-sandbox/#install">Virtualization environment</a></li>
   <li>Get <a href="http://hortonworks.com/products/hortonworks-sandbox/#archive">Hortonworks Sandbox v 2.2.4</a></li>
 </ol>

 <h3 id="step-2-setup-hadoop-environment-in-sandbox"><strong>Step 2: Setup Hadoop environment in sandbox</strong></h3>

 <ol>
   <li>Launch Ambari<sup id="fnref:AMBARI"><a href="#fn:AMBARI" class="footnote">2</a></sup> to manage the Hadoop environment
     <ul>
       <li>Enable Ambari in sandbox http://127.0.0.1:8000 (Click on Enable Button)</li>
       <li>Login to Ambari UI http://127.0.0.1:8080/ with username and password as “admin”</li>
     </ul>
   </li>
   <li>Grant root as HBase<sup id="fnref:HBASE"><a href="#fn:HBASE" class="footnote">3</a></sup> superuser via Ambari
 <img src="/images/docs/hbase-superuser.png" alt="add superuser" /></li>
   <li>Start Storm<sup id="fnref:STORM"><a href="#fn:STORM" class="footnote">4</a></sup>, HBase &amp; Kafka<sup id="fnref:KAFKA"><a href="#fn:KAFKA" class="footnote">5</a></sup>, Ambari. Showing Storm as an example below.
 <img src="/images/docs/start-storm.png" alt="Restart Services" title="Services" /></li>
 </ol>

 <h3 id="step-3-download-and-extract-a-eagle-release-to-sandbox"><strong>Step 3: Download and extract a Eagle release to sandbox</strong></h3>

 <ul>
   <li>
     <p><strong>Download</strong></p>

     <ul>
       <li>
         <p><strong>Option 1</strong>: Download eagle jar from <a href="http://66.211.190.194/eagle-0.1.0.tar.gz">here</a>.</p>
       </li>
       <li>
         <p><strong>Option 2</strong>: Build form source code <a href="https://github.com/apache/eagle">eagle github</a>. After successful build, ‘eagle-xxx-bin.tar.gz’ will be generated under <code class="highlighter-rouge">./eagle-assembly/target</code></p>

         <div class="highlighter-rouge"><pre class="highlight"><code># installed npm is required before compiling
 $ mvn clean install -DskipTests=true
 </code></pre>
         </div>
       </li>
     </ul>
   </li>
   <li>
     <p><strong>Copy and extract the package to sandbox</strong></p>

     <div class="highlighter-rouge"><pre class="highlight"><code>#extract
 $ tar -zxvf eagle-0.1.0-bin.tar.gz
 $ mv eagle-0.1.0 /usr/hdp/current/eagle
 </code></pre>
     </div>
   </li>
 </ul>

 <p><br /></p>

 <h3 id="step-4-install-eagle-in-sandbox"><strong>Step 4: Install Eagle in Sandbox</strong></h3>

 <p>The following installation actually contains installing and setting up a sandbox site with three data sources HdfsAuditLog, HiveQueryLog, and <a href="/docs/tutorial/userprofile.html">User Profiles</a></p>

 <ul>
   <li>
     <p><strong>Option 1</strong>: Install Eagle using command line</p>

     <div class="highlighter-rouge"><pre class="highlight"><code>$ cd /usr/hdp/current/eagle
 $ examples/eagle-sandbox-starter.sh
 </code></pre>
     </div>
   </li>
   <li>
     <p><strong>Option 2</strong>: Install Eagle using <a href="/docs/ambari-plugin-install.html">Eagle Ambari plugin</a></p>
   </li>
 </ul>

 <h3 id="step-5-stream-hdfs-audit-log"><strong>Step 5: Stream HDFS audit log</strong></h3>

 <p>To stream HDFS audit log into Kafka, the last step is to install a namenode log4j Kafka appender (another option Logstash is <a href="/docs/import-hdfs-auditLog.html">here</a>).</p>

 <ul>
   <li>
     <p><strong>Step 1</strong>: Configure Advanced hadoop-log4j via <a href="http://localhost:8080/#/main/services/HDFS/configs" target="_blank">Ambari UI</a>, and add below “KAFKA_HDFS_AUDIT” log4j appender to hdfs audit logging.</p>

     <div class="highlighter-rouge"><pre class="highlight"><code>log4j.appender.KAFKA_HDFS_AUDIT=org.apache.eagle.log4j.kafka.KafkaLog4jAppender
 log4j.appender.KAFKA_HDFS_AUDIT.Topic=sandbox_hdfs_audit_log
 log4j.appender.KAFKA_HDFS_AUDIT.BrokerList=sandbox.hortonworks.com:6667
 log4j.appender.KAFKA_HDFS_AUDIT.KeyClass=org.apache.eagle.log4j.kafka.hadoop.AuditLogKeyer
 log4j.appender.KAFKA_HDFS_AUDIT.Layout=org.apache.log4j.PatternLayout
 log4j.appender.KAFKA_HDFS_AUDIT.Layout.ConversionPattern=%d{ISO8601} %p %c{2}: %m%n
 log4j.appender.KAFKA_HDFS_AUDIT.ProducerType=async
 #log4j.appender.KAFKA_HDFS_AUDIT.BatchSize=1
 #log4j.appender.KAFKA_HDFS_AUDIT.QueueSize=1
 </code></pre>
     </div>

     <p><img src="/images/docs/hdfs-log4j-conf.png" alt="HDFS LOG4J Configuration" title="hdfslog4jconf" /></p>
   </li>
   <li>
     <p><strong>Step 3</strong>: Edit Advanced hadoop-env via <a href="http://localhost:8080/#/main/services/HDFS/configs" target="_blank">Ambari UI</a>, and add the reference to KAFKA_HDFS_AUDIT to HADOOP_NAMENODE_OPTS.</p>

     <div class="highlighter-rouge"><pre class="highlight"><code>-Dhdfs.audit.logger=INFO,DRFAAUDIT,KAFKA_HDFS_AUDIT
 </code></pre>
     </div>

     <p><img src="/images/docs/hdfs-env-conf.png" alt="HDFS Environment Configuration" title="hdfsenvconf" /></p>
   </li>
   <li>
     <p><strong>Step 4</strong>: Edit Advanced hadoop-env via <a href="http://localhost:8080/#/main/services/HDFS/configs" target="_blank">Ambari UI</a>, and append the following command to it.</p>

     <div class="highlighter-rouge"><pre class="highlight"><code>export HADOOP_CLASSPATH=${HADOOP_CLASSPATH}:/usr/hdp/current/eagle/lib/log4jkafka/lib/*
 </code></pre>
     </div>

     <p><img src="/images/docs/hdfs-env-conf2.png" alt="HDFS Environment Configuration" title="hdfsenvconf2" /></p>
   </li>
   <li>
     <p><strong>Step 5</strong>: save the changes and restart the namenode.</p>
   </li>
   <li>
     <p><strong>Step 6</strong>: Check whether logs are flowing into topic <code class="highlighter-rouge">sandbox_hdfs_audit_log</code></p>

     <div class="highlighter-rouge"><pre class="highlight"><code>$ /usr/hdp/current/kafka-broker/bin/kafka-console-consumer.sh --zookeeper localhost:2181 --topic sandbox_hdfs_audit_log
 </code></pre>
     </div>
   </li>
 </ul>

 <p>Now please login to Eagle web http://localhost:9099/eagle-service with account <code class="highlighter-rouge">admin/secret</code>, and try the sample demos on
 <a href="/docs/quick-start.html">Quick Starer</a></p>

 <p>(If the NAT network is used in a virtual machine, it’s required to add port 9099 to forwarding ports)
   <img src="/images/docs/eagle-service.png" alt="Forwarding Port" />
   <img src="/images/docs/login.png" alt="login" /></p>

 <hr />

 <h4 id="footnotes"><em>Footnotes</em></h4>

 <div class="footnotes">
   <ol>
     <li id="fn:HADOOP">
       <p><em>All mentions of “hadoop” on this page represent Apache Hadoop.</em>&nbsp;<a href="#fnref:HADOOP" class="reversefootnote">&#8617;</a></p>
     </li>
     <li id="fn:AMBARI">
       <p><em>All mentions of “ambari” on this page represent Apache Ambari.</em>&nbsp;<a href="#fnref:AMBARI" class="reversefootnote">&#8617;</a></p>
     </li>
     <li id="fn:HBASE">
       <p><em>All mentions of “hbase” on this page represent Apache HBase.</em>&nbsp;<a href="#fnref:HBASE" class="reversefootnote">&#8617;</a></p>
     </li>
     <li id="fn:STORM">
       <p><em>All mentions of “storm” on this page represent Apache Storm.</em>&nbsp;<a href="#fnref:STORM" class="reversefootnote">&#8617;</a></p>
     </li>
     <li id="fn:KAFKA">
       <p><em>All mentions of “kafka” on this page represent Apache Kafka.</em>&nbsp;<a href="#fnref:KAFKA" class="reversefootnote">&#8617;</a></p>
     </li>
   </ol>
 </div>

       </div><!--end of loadcontent-->
     </div>
     <!--end of centered content-->
   </div>
 </div>
 <!--end of container-->

 <!-- footer start -->
 <div class="footerwrapper">
   <div class="container">
     <div class="row">
       <div class="col-md-12"><div style="margin-left:auto; margin-right:auto; text-align:center;font-size: 12px">
 <div>
 </div>
 <div>
 <a href="http://www.apache.org">
 <img id="asf-logo" alt="Apache Software Foundation" src="/images/apache-logo-small.gif">
 </a>
 </div>
 <div>
 Copyright © 2015 <a href="http://www.apache.org">The Apache Software Foundation</a>, Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
 </div>
 <div>
 Apache Eagle, Eagle, Apache Hadoop, Hadoop, Apache HBase, HBase, Apache Hive, Hive, Apache Ambari, Ambari, Apache Spark, Spark, Apache Kafka, Kafka, Apache Storm, Storm, Apache Maven, Maven, Apache Tomcat, Tomcat, Apache Derby, Derby, Apache Cassandra, Cassandra, Apache ZooKeeper, ZooKeeper, Apache, the Apache feather logo, and the Apache project logo are trademarks of The Apache Software Foundation.
 </div>
       </div></div>
     </div>
   </div>
 </div>
 <!-- footer end -->

 <!-- JavaScripts -->
 <script src="/js/jquery-1.11.1.min.js"></script>
 <script src="/js/jquery.singlePageNav.js"></script>
 <script src="/js/jquery.flexslider.js"></script>
 <script src="/js/modernizr.min.js"></script>
 <script src="/js/svg.js"></script>
 <script>
     /************** FlexSlider *********************/
     $('.flexslider').flexslider({
         animation: "fade",
         directionNav: false
     });
 </script>

 <script>
     /************** FlexSlider *********************/
     $('.flexslider').flexslider({
         animation: "fade",
         directionNav: false
     });
 </script>
 </body>
 </html>
	<!DOCTYPE html>
	<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">

	<title>Eagle - Get Started with Sandbox</title>
	<meta name="description" content="Eagle - Analyze Big Data Platforms for Security and Performance">

	<meta name="keywords" content="Eagle, Hadoop, Security, Real Time">
	<meta name="author" content="eBay Inc.">

	<meta charset="utf-8">
	<meta name="viewport" content="initial-scale=1">

	<link rel="stylesheet" href="/css/animate.css">
	<link rel="stylesheet" href="/css/bootstrap.min.css">

	<link rel="stylesheet" href="/css/font-awesome.min.css">

	<link rel="stylesheet" href="/css/misc.css">
	<link rel="stylesheet" href="/css/style.css">
	<link rel="stylesheet" href="/css/styles.css">
	<link rel="stylesheet" href="/css/main.css">
	<link rel="alternate" type="application/rss+xml" title="Eagle" href="http://goeagle.io/feed.xml" />
	<link rel="shortcut icon" href="/images/favicon.png">

	<!-- Baidu Analytics Tracking-->
	<script>
	var _hmt = _hmt \|\| [];
	(function() {
	var hm = document.createElement("script");
	hm.src = "//hm.baidu.com/hm.js?fedc55df2ea52777a679192e8f849ece";
	var s = document.getElementsByTagName("script")[0];
	s.parentNode.insertBefore(hm, s);
	})();
	</script>

	<!-- Google Analytics Tracking -->
	<script>
	(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]\|\|function(){
	(i[r].q=i[r].q\|\|[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
	m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
	})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
	ga('create', 'UA-68929805-1', 'auto');
	ga('send', 'pageview');
	</script>
	</head>
	<body>
	<!-- header start -->
	<div id="home_page">
	<div class="topbar">
	<div class="container">
	<div class="row" >
	<nav class="navbar navbar-default">
	<div class="container-fluid">
	<!-- Brand and toggle get grouped for better mobile display -->
	<div class="navbar-header">
	<button type="button" class="navbar-toggle collapsed" 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="navbar-brand" href="/"><img src="/images/logo2.png" height="44px" style="margin-top:-7px"></a> </div>

	<!-- Collect the nav links, forms, and other content for toggling -->
	<!-- <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
	<ul class="nav navbar-nav navbar-right" id="top-menu">
	<li><a class="menu" href="/#home_page">HOME</a></li>
	<li><a class="menu" href="/docs/">DOCS</a></li>
	<li><a class="menu" href="/#about_page">ABOUT</a></li>
	<li><a class="menu" href="/#diagram_page">ARCHITECTURE</a></li>
	<li><a class="menu" href="/#modules_page">MODULES</a></li>
	<li><a class="menu" href="/#usecase_page">USE CASES</a></li>
	<li>
	</li>
	</ul> -->
	</div>
	</div>
	<!-- /.container-fluid -->
	</nav>
	</div>
	</div>
	</div>
	<div class="headerimage">
	<div class="flexslider">
	<ul class="slides">
	<li><img src="/images/slider/4.jpg" alt="Slide 1"></li>
	</ul>
	</div>
	</div>
	<div class="particles" style="height:40%"> </div><!---particles-->
	<div class="slider-caption" style="top:80px;">
	<div class="homewrapper">
	<div class="hometitle">
	<a href="/">
	<img src="/images/feather.png" height="80px">
	</a>
	</div>
	<div class="hometext">
	<h2>Analyze Big Data Platforms For Security and Performance</h2>
	<div class="social-buttons">
	<a href="https://github.com/apache/eagle"><i class="fa fa-github"></i></a>
	<a href="http://twitter.com/TheApacheEagle"><i class="fa fa-twitter"></i></a>
	<a href="https://www.facebook.com/TheApacheEagle/"><i class="fa fa-facebook"></i></a>
	<a href="#"><i class="fa fa-weixin"></i></a>
	<!-- <a href="https://www.weibo.com/ApacheEagle/"><i class="fa fa-weibo"></i></a> -->
	</div>
	</div>
	</div>
	</div>
	</div>
	<!-- header end -->
	<div class="container-fluid page-content">
	<div class="row">
	<div class="col-md-10 col-md-offset-1">
	<!-- sidebar -->
	<div class="col-xs-6 col-sm-3" id="sidebar" role="navigation">
	<ul class="nav" id="adminnav">

	<li class="heading">Getting Started</li>

	<li class="sidenavli "><a href="/docs/index.html" data-permalink="/docs/deployment-in-sandbox.html" id="">Introduction</a></li>

	<li class="sidenavli "><a href="/docs/usecases.html" data-permalink="/docs/deployment-in-sandbox.html" id="">Use Cases</a></li>

	<li class="sidenavli "><a href="/docs/terminology.html" data-permalink="/docs/deployment-in-sandbox.html" id="">Terminology</a></li>

	<li class="sidenavli "><a href="/docs/ecosystem.html" data-permalink="/docs/deployment-in-sandbox.html" id="">Ecosystem</a></li>

	<li class="sidenavli "><a href="/docs/community.html" data-permalink="/docs/deployment-in-sandbox.html" id="">Community</a></li>

	<li class="sidenavli "><a href="/docs/FAQ.html" data-permalink="/docs/deployment-in-sandbox.html" id="">FAQ</a></li>

	<li class="divider"></li>

	<li class="heading">Documentations</li>

	<li class="sidenavli "><a href="/docs/latest/" data-permalink="/docs/deployment-in-sandbox.html" id="">Latest version (v0.5.0)</a></li>

	<li class="divider"></li>

	<li class="heading">Download</li>

	<li class="sidenavli "><a href="/docs/download-latest.html" data-permalink="/docs/deployment-in-sandbox.html" id="">Latest version (v0.5.0)</a></li>

	<li class="sidenavli "><a href="/docs/download.html" data-permalink="/docs/deployment-in-sandbox.html" id="">Archived</a></li>

	<li class="divider"></li>

	<li class="heading">Supplement</li>

	<li class="sidenavli "><a href="/docs/security.html" data-permalink="/docs/deployment-in-sandbox.html" id="">Security</a></li>

	<li class="divider"></li>

	<li class="sidenavli">
	<a href="mailto:dev@eagle.apache.org" target="_blank">Need Help?</a>
	</li>
	</ul>
	</div>
	<div class="col-xs-6 col-sm-9 page-main-content" style="margin-left: -15px" id="loadcontent">
	<h1 class="page-header" style="margin-top: 0px">Get Started with Sandbox</h1>
	<p>Here is the summary of the steps for setting up Apache Eagle (called Eagle in the following) in Hortonworks sandbox:</p>

	<ul>
	<li>Step 1: Setup sandbox image in a virtual machine</li>
	<li>Step 2: Setup Hadoop<sup id="fnref:HADOOP"><a href="#fn:HADOOP" class="footnote">1</a></sup> environment in sandbox</li>
	<li>Step 3: Download and extract a Eagle release to sandbox</li>
	<li>Step 4: Install Eagle</li>
	<li>Step 5: Stream HDFS audit log</li>
	</ul>

	<h3 id="step-1-setup-sandbox-image-in-a-virtual-machine"><strong>Step 1: Setup sandbox image in a virtual machine</strong></h3>

	<p>To install Eagle on a sandbox you need to run a HDP sandbox image in a virtual machine with 8GB memory recommended.</p>

	<ol>
	<li>Get Virtual Box or VMware <a href="http://hortonworks.com/products/hortonworks-sandbox/#install">Virtualization environment</a></li>
	<li>Get <a href="http://hortonworks.com/products/hortonworks-sandbox/#archive">Hortonworks Sandbox v 2.2.4</a></li>
	</ol>

	<h3 id="step-2-setup-hadoop-environment-in-sandbox"><strong>Step 2: Setup Hadoop environment in sandbox</strong></h3>

	<ol>
	<li>Launch Ambari<sup id="fnref:AMBARI"><a href="#fn:AMBARI" class="footnote">2</a></sup> to manage the Hadoop environment
	<ul>
	<li>Enable Ambari in sandbox http://127.0.0.1:8000 (Click on Enable Button)</li>
	<li>Login to Ambari UI http://127.0.0.1:8080/ with username and password as “admin”</li>
	</ul>
	</li>
	<li>Grant root as HBase<sup id="fnref:HBASE"><a href="#fn:HBASE" class="footnote">3</a></sup> superuser via Ambari
	<img src="/images/docs/hbase-superuser.png" alt="add superuser" /></li>
	<li>Start Storm<sup id="fnref:STORM"><a href="#fn:STORM" class="footnote">4</a></sup>, HBase & Kafka<sup id="fnref:KAFKA"><a href="#fn:KAFKA" class="footnote">5</a></sup>, Ambari. Showing Storm as an example below.
	<img src="/images/docs/start-storm.png" alt="Restart Services" title="Services" /></li>
	</ol>

	<h3 id="step-3-download-and-extract-a-eagle-release-to-sandbox"><strong>Step 3: Download and extract a Eagle release to sandbox</strong></h3>

	<ul>
	<li>
	<p><strong>Download</strong></p>

	<ul>
	<li>
	<p><strong>Option 1</strong>: Download eagle jar from <a href="http://66.211.190.194/eagle-0.1.0.tar.gz">here</a>.</p>
	</li>
	<li>
	<p><strong>Option 2</strong>: Build form source code <a href="https://github.com/apache/eagle">eagle github</a>. After successful build, ‘eagle-xxx-bin.tar.gz’ will be generated under <code class="highlighter-rouge">./eagle-assembly/target</code></p>

	<div class="highlighter-rouge"><pre class="highlight"><code># installed npm is required before compiling
	$ mvn clean install -DskipTests=true
	</code></pre>
	</div>
	</li>
	</ul>
	</li>
	<li>
	<p><strong>Copy and extract the package to sandbox</strong></p>

	<div class="highlighter-rouge"><pre class="highlight"><code>#extract
	$ tar -zxvf eagle-0.1.0-bin.tar.gz
	$ mv eagle-0.1.0 /usr/hdp/current/eagle
	</code></pre>
	</div>
	</li>
	</ul>

	<p><br /></p>

	<h3 id="step-4-install-eagle-in-sandbox"><strong>Step 4: Install Eagle in Sandbox</strong></h3>

	<p>The following installation actually contains installing and setting up a sandbox site with three data sources HdfsAuditLog, HiveQueryLog, and <a href="/docs/tutorial/userprofile.html">User Profiles</a></p>

	<ul>
	<li>
	<p><strong>Option 1</strong>: Install Eagle using command line</p>

	<div class="highlighter-rouge"><pre class="highlight"><code>$ cd /usr/hdp/current/eagle
	$ examples/eagle-sandbox-starter.sh
	</code></pre>
	</div>
	</li>
	<li>
	<p><strong>Option 2</strong>: Install Eagle using <a href="/docs/ambari-plugin-install.html">Eagle Ambari plugin</a></p>
	</li>
	</ul>

	<h3 id="step-5-stream-hdfs-audit-log"><strong>Step 5: Stream HDFS audit log</strong></h3>

	<p>To stream HDFS audit log into Kafka, the last step is to install a namenode log4j Kafka appender (another option Logstash is <a href="/docs/import-hdfs-auditLog.html">here</a>).</p>

	<ul>
	<li>
	<p><strong>Step 1</strong>: Configure Advanced hadoop-log4j via <a href="http://localhost:8080/#/main/services/HDFS/configs" target="_blank">Ambari UI</a>, and add below “KAFKA_HDFS_AUDIT” log4j appender to hdfs audit logging.</p>

	<div class="highlighter-rouge"><pre class="highlight"><code>log4j.appender.KAFKA_HDFS_AUDIT=org.apache.eagle.log4j.kafka.KafkaLog4jAppender
	log4j.appender.KAFKA_HDFS_AUDIT.Topic=sandbox_hdfs_audit_log
	log4j.appender.KAFKA_HDFS_AUDIT.BrokerList=sandbox.hortonworks.com:6667
	log4j.appender.KAFKA_HDFS_AUDIT.KeyClass=org.apache.eagle.log4j.kafka.hadoop.AuditLogKeyer
	log4j.appender.KAFKA_HDFS_AUDIT.Layout=org.apache.log4j.PatternLayout
	log4j.appender.KAFKA_HDFS_AUDIT.Layout.ConversionPattern=%d{ISO8601} %p %c{2}: %m%n
	log4j.appender.KAFKA_HDFS_AUDIT.ProducerType=async
	#log4j.appender.KAFKA_HDFS_AUDIT.BatchSize=1
	#log4j.appender.KAFKA_HDFS_AUDIT.QueueSize=1
	</code></pre>
	</div>

	<p><img src="/images/docs/hdfs-log4j-conf.png" alt="HDFS LOG4J Configuration" title="hdfslog4jconf" /></p>
	</li>
	<li>
	<p><strong>Step 3</strong>: Edit Advanced hadoop-env via <a href="http://localhost:8080/#/main/services/HDFS/configs" target="_blank">Ambari UI</a>, and add the reference to KAFKA_HDFS_AUDIT to HADOOP_NAMENODE_OPTS.</p>

	<div class="highlighter-rouge"><pre class="highlight"><code>-Dhdfs.audit.logger=INFO,DRFAAUDIT,KAFKA_HDFS_AUDIT
	</code></pre>
	</div>

	<p><img src="/images/docs/hdfs-env-conf.png" alt="HDFS Environment Configuration" title="hdfsenvconf" /></p>
	</li>
	<li>
	<p><strong>Step 4</strong>: Edit Advanced hadoop-env via <a href="http://localhost:8080/#/main/services/HDFS/configs" target="_blank">Ambari UI</a>, and append the following command to it.</p>

	<div class="highlighter-rouge"><pre class="highlight"><code>export HADOOP_CLASSPATH=${HADOOP_CLASSPATH}:/usr/hdp/current/eagle/lib/log4jkafka/lib/*
	</code></pre>
	</div>

	<p><img src="/images/docs/hdfs-env-conf2.png" alt="HDFS Environment Configuration" title="hdfsenvconf2" /></p>
	</li>
	<li>
	<p><strong>Step 5</strong>: save the changes and restart the namenode.</p>
	</li>
	<li>
	<p><strong>Step 6</strong>: Check whether logs are flowing into topic <code class="highlighter-rouge">sandbox_hdfs_audit_log</code></p>

	<div class="highlighter-rouge"><pre class="highlight"><code>$ /usr/hdp/current/kafka-broker/bin/kafka-console-consumer.sh --zookeeper localhost:2181 --topic sandbox_hdfs_audit_log
	</code></pre>
	</div>
	</li>
	</ul>

	<p>Now please login to Eagle web http://localhost:9099/eagle-service with account <code class="highlighter-rouge">admin/secret</code>, and try the sample demos on
	<a href="/docs/quick-start.html">Quick Starer</a></p>

	<p>(If the NAT network is used in a virtual machine, it’s required to add port 9099 to forwarding ports)
	<img src="/images/docs/eagle-service.png" alt="Forwarding Port" />
	<img src="/images/docs/login.png" alt="login" /></p>

	<hr />

	<h4 id="footnotes"><em>Footnotes</em></h4>

	<div class="footnotes">
	<ol>
	<li id="fn:HADOOP">
	<p><em>All mentions of “hadoop” on this page represent Apache Hadoop.</em> <a href="#fnref:HADOOP" class="reversefootnote">↩</a></p>
	</li>
	<li id="fn:AMBARI">
	<p><em>All mentions of “ambari” on this page represent Apache Ambari.</em> <a href="#fnref:AMBARI" class="reversefootnote">↩</a></p>
	</li>
	<li id="fn:HBASE">
	<p><em>All mentions of “hbase” on this page represent Apache HBase.</em> <a href="#fnref:HBASE" class="reversefootnote">↩</a></p>
	</li>
	<li id="fn:STORM">
	<p><em>All mentions of “storm” on this page represent Apache Storm.</em> <a href="#fnref:STORM" class="reversefootnote">↩</a></p>
	</li>
	<li id="fn:KAFKA">
	<p><em>All mentions of “kafka” on this page represent Apache Kafka.</em> <a href="#fnref:KAFKA" class="reversefootnote">↩</a></p>
	</li>
	</ol>
	</div>

	</div><!--end of loadcontent-->
	</div>
	<!--end of centered content-->
	</div>
	</div>
	<!--end of container-->

	<!-- footer start -->
	<div class="footerwrapper">
	<div class="container">
	<div class="row">
	<div class="col-md-12"><div style="margin-left:auto; margin-right:auto; text-align:center;font-size: 12px">
	<div>
	</div>
	<div>
	<a href="http://www.apache.org">
	<img id="asf-logo" alt="Apache Software Foundation" src="/images/apache-logo-small.gif">
	</a>
	</div>
	<div>
	Copyright © 2015 <a href="http://www.apache.org">The Apache Software Foundation</a>, Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
	</div>
	<div>
	Apache Eagle, Eagle, Apache Hadoop, Hadoop, Apache HBase, HBase, Apache Hive, Hive, Apache Ambari, Ambari, Apache Spark, Spark, Apache Kafka, Kafka, Apache Storm, Storm, Apache Maven, Maven, Apache Tomcat, Tomcat, Apache Derby, Derby, Apache Cassandra, Cassandra, Apache ZooKeeper, ZooKeeper, Apache, the Apache feather logo, and the Apache project logo are trademarks of The Apache Software Foundation.
	</div>
	</div></div>
	</div>
	</div>
	</div>
	<!-- footer end -->

	<!-- JavaScripts -->
	<script src="/js/jquery-1.11.1.min.js"></script>
	<script src="/js/jquery.singlePageNav.js"></script>
	<script src="/js/jquery.flexslider.js"></script>
	<script src="/js/modernizr.min.js"></script>
	<script src="/js/svg.js"></script>
	<script>
	/************ FlexSlider *******************/
	$('.flexslider').flexslider({
	animation: "fade",
	directionNav: false
	});
	</script>

	<script>
	/************ FlexSlider *******************/
	$('.flexslider').flexslider({
	animation: "fade",
	directionNav: false
	});
	</script>
	</body>
	</html>