http://git-wip-us.apache.org/repos/asf/metron/blob/87ff7b73/site/current-book/metron-interface/metron-alerts/index.html ---------------------------------------------------------------------- diff --git a/site/current-book/metron-interface/metron-alerts/index.html b/site/current-book/metron-interface/metron-alerts/index.html new file mode 100644 index 0000000..cbfbe36 --- /dev/null +++ b/site/current-book/metron-interface/metron-alerts/index.html @@ -0,0 +1,338 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2017-09-15 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20170915" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Metron – </title> + <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../../css/site.css" /> + <link rel="stylesheet" href="../../css/print.css" media="print" /> + + + <script type="text/javascript" src="../../js/apache-maven-fluido-1.3.0.min.js"></script> + + + +<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> + + </head> + <body class="topBarDisabled"> + + + + + <div class="container-fluid"> + <div id="banner"> + <div class="pull-left"> + <a href="http://metron.apache.org/"; id="bannerLeft"> + <img src="../../images/metron-logo.png" alt="Apache Metron" width="148px" height="48px"/> + </a> + </div> + <div class="pull-right"> </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="http://www.apache.org"; class="externalLink" title="Apache"> + Apache</a> + </li> + <li class="divider ">/</li> + <li class=""> + <a href="http://metron.apache.org/"; class="externalLink" title="Metron"> + Metron</a> + </li> + <li class="divider ">/</li> + <li class=""> + <a href="../../index.html" title="Documentation"> + Documentation</a> + </li> + <li class="divider ">/</li> + <li class=""></li> + + + + <li id="publishDate" class="pull-right">Last Published: 2017-09-15</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.4.1</li> + + </ul> + </div> + + + <div class="row-fluid"> + <div id="leftColumn" class="span3"> + <div class="well sidebar-nav"> + + + <ul class="nav nav-list"> + <li class="nav-header">User Documentation</li> + + <li> + + <a href="../../index.html" title="Metron"> + <i class="icon-chevron-down"></i> + Metron</a> + <ul class="nav nav-list"> + + <li> + + <a href="../../Upgrading.html" title="Upgrading"> + <i class="none"></i> + Upgrading</a> + </li> + + <li> + + <a href="../../metron-analytics/index.html" title="Analytics"> + <i class="icon-chevron-right"></i> + Analytics</a> + </li> + + <li> + + <a href="../../metron-contrib/metron-docker/index.html" title="Docker"> + <i class="none"></i> + Docker</a> + </li> + + <li> + + <a href="../../metron-deployment/index.html" title="Deployment"> + <i class="icon-chevron-right"></i> + Deployment</a> + </li> + + <li class="active"> + + <a href="#"><i class="none"></i>Alerts</a> + </li> + + <li> + + <a href="../../metron-interface/metron-config/index.html" title="Config"> + <i class="none"></i> + Config</a> + </li> + + <li> + + <a href="../../metron-interface/metron-rest/index.html" title="Rest"> + <i class="none"></i> + Rest</a> + </li> + + <li> + + <a href="../../metron-platform/index.html" title="Platform"> + <i class="icon-chevron-right"></i> + Platform</a> + </li> + + <li> + + <a href="../../metron-sensors/index.html" title="Sensors"> + <i class="icon-chevron-right"></i> + Sensors</a> + </li> + + <li> + + <a href="../../metron-stellar/stellar-common/index.html" title="Stellar-common"> + <i class="icon-chevron-right"></i> + Stellar-common</a> + </li> + + <li> + + <a href="../../use-cases/index.html" title="Use-cases"> + <i class="icon-chevron-right"></i> + Use-cases</a> + </li> + </ul> + </li> + </ul> + + + + <hr class="divider" /> + + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="builtBy" alt="Built by Maven" src="../../images/logos/maven-feather.png" /> + </a> + </div> + </div> + </div> + + + <div id="bodyColumn" class="span9" > + + <ul> + +<li><a href="#Caveats">Caveats</a></li> + +<li><a href="#Prerequisites">Prerequisites</a></li> + +<li><a href="#Development_Setup">Development Setup</a></li> + +<li><a href="#E2E_Tests">E2E Tests</a></li> + +<li><a href="#Mpack_Integration">Mpack Integration</a></li> + +<li><a href="#Installing_on_an_existing_Cluster">Installing on an existing Cluster</a></li> +</ul> +<div class="section"> +<h2><a name="Caveats"></a>Caveats</h2> + +<ul> + +<li>UI doesn’t have an authentication module yet</li> + +<li>UI uses local storage to save all the data. A middleware needs to be designed and developed for persisting the data</li> +</ul></div> +<div class="section"> +<h2><a name="Prerequisites"></a>Prerequisites</h2> + +<ul> + +<li>Elastic search should be up and running and should have some alerts populated by metron topologies</li> + +<li>The alerts can be populated using Quick Dev, Full Dev or any other setup</li> + +<li>UI is developed using angular4 and uses angular-cli</li> + +<li>node.JS >= 7.8.0</li> +</ul></div> +<div class="section"> +<h2><a name="Development_Setup"></a>Development Setup</h2> + +<ol style="list-style-type: decimal"> + +<li> +<p>Install all the dependent node_modules using the following command</p> + +<div class="source"> +<div class="source"> +<pre>cd metron/metron-interface/metron-alerts +npm install +</pre></div></div></li> + +<li> +<p>UI can be run by using the following command</p> + +<div class="source"> +<div class="source"> +<pre>./scripts/start-dev.sh +</pre></div></div></li> + +<li>You can view the GUI @http://localhost:4200 . The default credentials for login are admin/password</li> +</ol> +<p><b>NOTE</b>: <i>In the development mode ui by default connects to ES at <a class="externalLink" href="http://node1:9200";>http://node1:9200</a> for fetching data. If you wish to change it you can change the ES url at metron/metron-interface/metron-alerts/proxy.conf.json</i></p></div> +<div class="section"> +<h2><a name="E2E_Tests"></a>E2E Tests</h2> +<p>An expressjs server is available for mocking the elastic search api.</p> + +<ol style="list-style-type: decimal"> + +<li> +<p>Run e2e webserver :</p> + +<div class="source"> +<div class="source"> +<pre>cd metron/metron-interface/metron-alerts +sh ./scripts/start-server-for-e2e.sh +</pre></div></div></li> + +<li> +<p>run e2e test using the following command</p> + +<div class="source"> +<div class="source"> +<pre>cd metron/metron-interface/metron-alerts +npm run e2e +</pre></div></div></li> + +<li> +<p>E2E tests uses data from full-dev wherever applicable. The tests assume rest-api’s are available @http://node1:8082</p></li> +</ol> +<p><b>NOTE</b>: <i>e2e tests covers all the general workflows and we will extend them as we need</i></p></div> +<div class="section"> +<h2><a name="Mpack_Integration"></a>Mpack Integration</h2> +<p>Yet to come</p></div> +<div class="section"> +<h2><a name="Installing_on_an_existing_Cluster"></a>Installing on an existing Cluster</h2> + +<ol style="list-style-type: decimal"> + +<li> +<p>Build Metron:</p> + +<div class="source"> +<div class="source"> +<pre>mvn clean package -DskipTests +</pre></div></div></li> + +<li> +<p>Copy <tt>metron/metron-interface/metron-alerts/target/metron-alerts-METRON_VERSION-archive.tar.gz</tt> to the desired host.</p></li> + +<li> +<p>Untar the archive in the target directory. The directory structure will look like:</p> + +<div class="source"> +<div class="source"> +<pre>bin + start_alerts_ui.sh +web + alerts-ui + package.json + server.js + web assets (html, css, js, ...) +</pre></div></div></li> + +<li> +<p><a class="externalLink" href="https://github.com/expressjs/express";>Expressjs</a> webserver script is included in the build that will serve the application. (The script has few rewrite rules and we can replace expressjs with any other webserver)</p></li> + +<li> +<p>Then start the application with the script:</p> + +<div class="source"> +<div class="source"> +<pre>./bin/start_alerts_ui.sh +Usage: server.js -p [port] -r [restUrl] +Options: + -p Port to run metron alerts ui [required] + -r, --resturl Url where elastic search rest api is available [required] +</pre></div></div></li> +</ol></div> + </div> + </div> + </div> + + <hr/> + + <footer> + <div class="container-fluid"> + <div class="row span12">Copyright © 2017 + <a href="https://www.apache.org";>The Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + + </div> + </footer> + </body> +</html>
http://git-wip-us.apache.org/repos/asf/metron/blob/87ff7b73/site/current-book/metron-interface/metron-config/index.html ---------------------------------------------------------------------- diff --git a/site/current-book/metron-interface/metron-config/index.html b/site/current-book/metron-interface/metron-config/index.html index ad4b320..e3bf4b6 100644 --- a/site/current-book/metron-interface/metron-config/index.html +++ b/site/current-book/metron-interface/metron-config/index.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-06-27 + | Generated by Apache Maven Doxia at 2017-09-15 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20170627" /> + <meta name="Date-Revision-yyyymmdd" content="20170915" /> <meta http-equiv="Content-Language" content="en" /> <title>Metron – Metron Management UI</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" /> @@ -61,8 +61,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-06-27</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.4.0</li> + <li id="publishDate" class="pull-right">Last Published: 2017-09-15</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.4.1</li> </ul> </div> @@ -75,7 +75,7 @@ <ul class="nav nav-list"> <li class="nav-header">User Documentation</li> - + <li> <a href="../../index.html" title="Metron"> @@ -96,7 +96,14 @@ <i class="icon-chevron-right"></i> Analytics</a> </li> - + + <li> + + <a href="../../metron-contrib/metron-docker/index.html" title="Docker"> + <i class="none"></i> + Docker</a> + </li> + <li> <a href="../../metron-deployment/index.html" title="Deployment"> @@ -106,9 +113,9 @@ <li> - <a href="../../metron-docker/index.html" title="Docker"> + <a href="../../metron-interface/metron-alerts/index.html" title="Alerts"> <i class="none"></i> - Docker</a> + Alerts</a> </li> <li class="active"> @@ -122,7 +129,7 @@ <i class="none"></i> Rest</a> </li> - + <li> <a href="../../metron-platform/index.html" title="Platform"> @@ -136,6 +143,20 @@ <i class="icon-chevron-right"></i> Sensors</a> </li> + + <li> + + <a href="../../metron-stellar/stellar-common/index.html" title="Stellar-common"> + <i class="icon-chevron-right"></i> + Stellar-common</a> + </li> + + <li> + + <a href="../../use-cases/index.html" title="Use-cases"> + <i class="icon-chevron-right"></i> + Use-cases</a> + </li> </ul> </li> </ul> @@ -227,14 +248,6 @@ web <div class="source"> <pre>rpm -ih metron-config-$METRON_VERSION-*.noarch.rpm </pre></div></div></li> - -<li> -<p>Install the <a class="externalLink" href="https://expressjs.com/";>Express</a> web framework from the <tt>package.json</tt> file in <tt>$METRON_HOME/web/expressjs</tt>:</p> - -<div class="source"> -<div class="source"> -<pre>npm --prefix $METRON_HOME/web/expressjs/ install -</pre></div></div></li> </ol></div></div> <div class="section"> <h2><a name="Configuration"></a>Configuration</h2> http://git-wip-us.apache.org/repos/asf/metron/blob/87ff7b73/site/current-book/metron-interface/metron-rest/index.html ---------------------------------------------------------------------- diff --git a/site/current-book/metron-interface/metron-rest/index.html b/site/current-book/metron-interface/metron-rest/index.html index 5955c5f..8f549d5 100644 --- a/site/current-book/metron-interface/metron-rest/index.html +++ b/site/current-book/metron-interface/metron-rest/index.html @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-06-27 + | Generated by Apache Maven Doxia at 2017-09-15 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20170627" /> + <meta name="Date-Revision-yyyymmdd" content="20170915" /> <meta http-equiv="Content-Language" content="en" /> <title>Metron – Metron REST</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" /> @@ -61,8 +61,8 @@ - <li id="publishDate" class="pull-right">Last Published: 2017-06-27</li> <li class="divider pull-right">|</li> - <li id="projectVersion" class="pull-right">Version: 0.4.0</li> + <li id="publishDate" class="pull-right">Last Published: 2017-09-15</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.4.1</li> </ul> </div> @@ -75,7 +75,7 @@ <ul class="nav nav-list"> <li class="nav-header">User Documentation</li> - + <li> <a href="../../index.html" title="Metron"> @@ -96,7 +96,14 @@ <i class="icon-chevron-right"></i> Analytics</a> </li> - + + <li> + + <a href="../../metron-contrib/metron-docker/index.html" title="Docker"> + <i class="none"></i> + Docker</a> + </li> + <li> <a href="../../metron-deployment/index.html" title="Deployment"> @@ -106,9 +113,9 @@ <li> - <a href="../../metron-docker/index.html" title="Docker"> + <a href="../../metron-interface/metron-alerts/index.html" title="Alerts"> <i class="none"></i> - Docker</a> + Alerts</a> </li> <li> @@ -122,7 +129,7 @@ <a href="#"><i class="none"></i>Rest</a> </li> - + <li> <a href="../../metron-platform/index.html" title="Platform"> @@ -136,6 +143,20 @@ <i class="icon-chevron-right"></i> Sensors</a> </li> + + <li> + + <a href="../../metron-stellar/stellar-common/index.html" title="Stellar-common"> + <i class="icon-chevron-right"></i> + Stellar-common</a> + </li> + + <li> + + <a href="../../use-cases/index.html" title="Use-cases"> + <i class="icon-chevron-right"></i> + Use-cases</a> + </li> </ul> </li> </ul> @@ -599,7 +620,7 @@ METRON_SERVICE_KEYTAB="/etc/security/keytabs/metron.keytab" <td>docker </td> -<td>sets configuration variables to match the Metron dcoker environment </td> +<td>sets configuration variables to match the Metron docker environment </td> </tr> </tbody> </table> @@ -625,274 +646,314 @@ METRON_SERVICE_KEYTAB="/etc/security/keytabs/metron.keytab" <tr class="b"> -<td><a href="#GET_apiv1globalconfig"> <tt>GET /api/v1/global/config</tt></a></td> +<td><a href="#get-apiv1alertescalate"> <tt>POST /api/v1/alert/escalate</tt></a></td> </tr> <tr class="a"> -<td><a href="#DELETE_apiv1globalconfig"> <tt>DELETE /api/v1/global/config</tt></a></td> +<td><a href="#GET_apiv1globalconfig"> <tt>GET /api/v1/global/config</tt></a></td> </tr> <tr class="b"> -<td><a href="#POST_apiv1globalconfig"> <tt>POST /api/v1/global/config</tt></a></td> +<td><a href="#DELETE_apiv1globalconfig"> <tt>DELETE /api/v1/global/config</tt></a></td> </tr> <tr class="a"> -<td><a href="#GET_apiv1grokgetstatement"> <tt>GET /api/v1/grok/get/statement</tt></a></td> +<td><a href="#POST_apiv1globalconfig"> <tt>POST /api/v1/global/config</tt></a></td> </tr> <tr class="b"> -<td><a href="#GET_apiv1groklist"> <tt>GET /api/v1/grok/list</tt></a></td> +<td><a href="#GET_apiv1grokgetstatement"> <tt>GET /api/v1/grok/get/statement</tt></a></td> </tr> <tr class="a"> -<td><a href="#POST_apiv1grokvalidate"> <tt>POST /api/v1/grok/validate</tt></a></td> +<td><a href="#GET_apiv1groklist"> <tt>GET /api/v1/grok/list</tt></a></td> </tr> <tr class="b"> -<td><a href="#POST_apiv1hdfs"> <tt>POST /api/v1/hdfs</tt></a></td> +<td><a href="#POST_apiv1grokvalidate"> <tt>POST /api/v1/grok/validate</tt></a></td> </tr> <tr class="a"> -<td><a href="#GET_apiv1hdfs"> <tt>GET /api/v1/hdfs</tt></a></td> +<td><a href="#POST_apiv1hdfs"> <tt>POST /api/v1/hdfs</tt></a></td> </tr> <tr class="b"> -<td><a href="#DELETE_apiv1hdfs"> <tt>DELETE /api/v1/hdfs</tt></a></td> +<td><a href="#GET_apiv1hdfs"> <tt>GET /api/v1/hdfs</tt></a></td> </tr> <tr class="a"> -<td><a href="#GET_apiv1hdfslist"> <tt>GET /api/v1/hdfs/list</tt></a></td> +<td><a href="#DELETE_apiv1hdfs"> <tt>DELETE /api/v1/hdfs</tt></a></td> </tr> <tr class="b"> -<td><a href="#GET_apiv1kafkatopic"> <tt>GET /api/v1/kafka/topic</tt></a></td> +<td><a href="#GET_apiv1hdfslist"> <tt>GET /api/v1/hdfs/list</tt></a></td> </tr> <tr class="a"> -<td><a href="#POST_apiv1kafkatopic"> <tt>POST /api/v1/kafka/topic</tt></a></td> +<td><a href="#GET_apiv1kafkatopic"> <tt>GET /api/v1/kafka/topic</tt></a></td> </tr> <tr class="b"> -<td><a href="#GET_apiv1kafkatopicname"> <tt>GET /api/v1/kafka/topic/{name}</tt></a></td> +<td><a href="#POST_apiv1kafkatopic"> <tt>POST /api/v1/kafka/topic</tt></a></td> </tr> <tr class="a"> -<td><a href="#DELETE_apiv1kafkatopicname"> <tt>DELETE /api/v1/kafka/topic/{name}</tt></a></td> +<td><a href="#GET_apiv1kafkatopicname"> <tt>GET /api/v1/kafka/topic/{name}</tt></a></td> </tr> <tr class="b"> +<td><a href="#DELETE_apiv1kafkatopicname"> <tt>DELETE /api/v1/kafka/topic/{name}</tt></a></td> + </tr> + +<tr class="a"> + <td><a href="#GET_apiv1kafkatopicnamesample"> <tt>GET /api/v1/kafka/topic/{name}/sample</tt></a></td> </tr> +<tr class="b"> + +<td><a href="#GET_apiv1searchsearch"> <tt>GET /api/v1/search/search</tt></a></td> + </tr> + <tr class="a"> -<td><a href="#GET_apiv1sensorenrichmentconfig"> <tt>GET /api/v1/sensor/enrichment/config</tt></a></td> +<td><a href="#GET_apiv1searchfindOne"> <tt>GET /api/v1/search/findOne</tt></a></td> </tr> <tr class="b"> -<td><a href="#GET_apiv1sensorenrichmentconfiglistavailableenrichments"> <tt>GET /api/v1/sensor/enrichment/config/list/available/enrichments</tt></a></td> +<td><a href="#get-apiv1searchcolumnmetadata"> <tt>GET /api/v1/search/search</tt></a></td> </tr> <tr class="a"> -<td><a href="#GET_apiv1sensorenrichmentconfiglistavailablethreattriageaggregators"> <tt>GET /api/v1/sensor/enrichment/config/list/available/threat/triage/aggregators</tt></a></td> +<td><a href="#get-apiv1searchcolumnmetadatacommon"> <tt>GET /api/v1/search/search</tt></a></td> </tr> <tr class="b"> -<td><a href="#DELETE_apiv1sensorenrichmentconfigname"> <tt>DELETE /api/v1/sensor/enrichment/config/{name}</tt></a></td> +<td><a href="#GET_apiv1sensorenrichmentconfig"> <tt>GET /api/v1/sensor/enrichment/config</tt></a></td> </tr> <tr class="a"> -<td><a href="#POST_apiv1sensorenrichmentconfigname"> <tt>POST /api/v1/sensor/enrichment/config/{name}</tt></a></td> +<td><a href="#GET_apiv1sensorenrichmentconfiglistavailableenrichments"> <tt>GET /api/v1/sensor/enrichment/config/list/available/enrichments</tt></a></td> </tr> <tr class="b"> -<td><a href="#GET_apiv1sensorenrichmentconfigname"> <tt>GET /api/v1/sensor/enrichment/config/{name}</tt></a></td> +<td><a href="#GET_apiv1sensorenrichmentconfiglistavailablethreattriageaggregators"> <tt>GET /api/v1/sensor/enrichment/config/list/available/threat/triage/aggregators</tt></a></td> </tr> <tr class="a"> -<td><a href="#GET_apiv1sensorindexingconfig"> <tt>GET /api/v1/sensor/indexing/config</tt></a></td> +<td><a href="#DELETE_apiv1sensorenrichmentconfigname"> <tt>DELETE /api/v1/sensor/enrichment/config/{name}</tt></a></td> </tr> <tr class="b"> -<td><a href="#DELETE_apiv1sensorindexingconfigname"> <tt>DELETE /api/v1/sensor/indexing/config/{name}</tt></a></td> +<td><a href="#POST_apiv1sensorenrichmentconfigname"> <tt>POST /api/v1/sensor/enrichment/config/{name}</tt></a></td> </tr> <tr class="a"> -<td><a href="#POST_apiv1sensorindexingconfigname"> <tt>POST /api/v1/sensor/indexing/config/{name}</tt></a></td> +<td><a href="#GET_apiv1sensorenrichmentconfigname"> <tt>GET /api/v1/sensor/enrichment/config/{name}</tt></a></td> </tr> <tr class="b"> -<td><a href="#GET_apiv1sensorindexingconfigname"> <tt>GET /api/v1/sensor/indexing/config/{name}</tt></a></td> +<td><a href="#GET_apiv1sensorindexingconfig"> <tt>GET /api/v1/sensor/indexing/config</tt></a></td> </tr> <tr class="a"> -<td><a href="#POST_apiv1sensorparserconfig"> <tt>POST /api/v1/sensor/parser/config</tt></a></td> +<td><a href="#DELETE_apiv1sensorindexingconfigname"> <tt>DELETE /api/v1/sensor/indexing/config/{name}</tt></a></td> </tr> <tr class="b"> -<td><a href="#GET_apiv1sensorparserconfig"> <tt>GET /api/v1/sensor/parser/config</tt></a></td> +<td><a href="#POST_apiv1sensorindexingconfigname"> <tt>POST /api/v1/sensor/indexing/config/{name}</tt></a></td> </tr> <tr class="a"> -<td><a href="#GET_apiv1sensorparserconfiglistavailable"> <tt>GET /api/v1/sensor/parser/config/list/available</tt></a></td> +<td><a href="#GET_apiv1sensorindexingconfigname"> <tt>GET /api/v1/sensor/indexing/config/{name}</tt></a></td> </tr> <tr class="b"> -<td><a href="#POST_apiv1sensorparserconfigparseMessage"> <tt>POST /api/v1/sensor/parser/config/parseMessage</tt></a></td> +<td><a href="#POST_apiv1sensorparserconfig"> <tt>POST /api/v1/sensor/parser/config</tt></a></td> </tr> <tr class="a"> -<td><a href="#GET_apiv1sensorparserconfigreloadavailable"> <tt>GET /api/v1/sensor/parser/config/reload/available</tt></a></td> +<td><a href="#GET_apiv1sensorparserconfig"> <tt>GET /api/v1/sensor/parser/config</tt></a></td> </tr> <tr class="b"> -<td><a href="#DELETE_apiv1sensorparserconfigname"> <tt>DELETE /api/v1/sensor/parser/config/{name}</tt></a></td> +<td><a href="#GET_apiv1sensorparserconfiglistavailable"> <tt>GET /api/v1/sensor/parser/config/list/available</tt></a></td> </tr> <tr class="a"> -<td><a href="#GET_apiv1sensorparserconfigname"> <tt>GET /api/v1/sensor/parser/config/{name}</tt></a></td> +<td><a href="#POST_apiv1sensorparserconfigparseMessage"> <tt>POST /api/v1/sensor/parser/config/parseMessage</tt></a></td> </tr> <tr class="b"> -<td><a href="#POST_apiv1stellarapplytransformations"> <tt>POST /api/v1/stellar/apply/transformations</tt></a></td> +<td><a href="#GET_apiv1sensorparserconfigreloadavailable"> <tt>GET /api/v1/sensor/parser/config/reload/available</tt></a></td> </tr> <tr class="a"> -<td><a href="#GET_apiv1stellarlist"> <tt>GET /api/v1/stellar/list</tt></a></td> +<td><a href="#DELETE_apiv1sensorparserconfigname"> <tt>DELETE /api/v1/sensor/parser/config/{name}</tt></a></td> </tr> <tr class="b"> -<td><a href="#GET_apiv1stellarlistfunctions"> <tt>GET /api/v1/stellar/list/functions</tt></a></td> +<td><a href="#GET_apiv1sensorparserconfigname"> <tt>GET /api/v1/sensor/parser/config/{name}</tt></a></td> </tr> <tr class="a"> -<td><a href="#GET_apiv1stellarlistsimplefunctions"> <tt>GET /api/v1/stellar/list/simple/functions</tt></a></td> +<td><a href="#POST_apiv1stellarapplytransformations"> <tt>POST /api/v1/stellar/apply/transformations</tt></a></td> </tr> <tr class="b"> -<td><a href="#POST_apiv1stellarvalidaterules"> <tt>POST /api/v1/stellar/validate/rules</tt></a></td> +<td><a href="#GET_apiv1stellarlist"> <tt>GET /api/v1/stellar/list</tt></a></td> </tr> <tr class="a"> -<td><a href="#GET_apiv1storm"> <tt>GET /api/v1/storm</tt></a></td> +<td><a href="#GET_apiv1stellarlistfunctions"> <tt>GET /api/v1/stellar/list/functions</tt></a></td> </tr> <tr class="b"> -<td><a href="#GET_apiv1stormclientstatus"> <tt>GET /api/v1/storm/client/status</tt></a></td> +<td><a href="#GET_apiv1stellarlistsimplefunctions"> <tt>GET /api/v1/stellar/list/simple/functions</tt></a></td> </tr> <tr class="a"> -<td><a href="#GET_apiv1stormenrichment"> <tt>GET /api/v1/storm/enrichment</tt></a></td> +<td><a href="#POST_apiv1stellarvalidaterules"> <tt>POST /api/v1/stellar/validate/rules</tt></a></td> </tr> <tr class="b"> -<td><a href="#GET_apiv1stormenrichmentactivate"> <tt>GET /api/v1/storm/enrichment/activate</tt></a></td> +<td><a href="#GET_apiv1storm"> <tt>GET /api/v1/storm</tt></a></td> </tr> <tr class="a"> -<td><a href="#GET_apiv1stormenrichmentdeactivate"> <tt>GET /api/v1/storm/enrichment/deactivate</tt></a></td> +<td><a href="#GET_apiv1stormclientstatus"> <tt>GET /api/v1/storm/client/status</tt></a></td> </tr> <tr class="b"> -<td><a href="#GET_apiv1stormenrichmentstart"> <tt>GET /api/v1/storm/enrichment/start</tt></a></td> +<td><a href="#GET_apiv1stormenrichment"> <tt>GET /api/v1/storm/enrichment</tt></a></td> </tr> <tr class="a"> -<td><a href="#GET_apiv1stormenrichmentstop"> <tt>GET /api/v1/storm/enrichment/stop</tt></a></td> +<td><a href="#GET_apiv1stormenrichmentactivate"> <tt>GET /api/v1/storm/enrichment/activate</tt></a></td> </tr> <tr class="b"> -<td><a href="#GET_apiv1stormindexing"> <tt>GET /api/v1/storm/indexing</tt></a></td> +<td><a href="#GET_apiv1stormenrichmentdeactivate"> <tt>GET /api/v1/storm/enrichment/deactivate</tt></a></td> </tr> <tr class="a"> -<td><a href="#GET_apiv1stormindexingactivate"> <tt>GET /api/v1/storm/indexing/activate</tt></a></td> +<td><a href="#GET_apiv1stormenrichmentstart"> <tt>GET /api/v1/storm/enrichment/start</tt></a></td> </tr> <tr class="b"> -<td><a href="#GET_apiv1stormindexingdeactivate"> <tt>GET /api/v1/storm/indexing/deactivate</tt></a></td> +<td><a href="#GET_apiv1stormenrichmentstop"> <tt>GET /api/v1/storm/enrichment/stop</tt></a></td> </tr> <tr class="a"> -<td><a href="#GET_apiv1stormindexingstart"> <tt>GET /api/v1/storm/indexing/start</tt></a></td> +<td><a href="#GET_apiv1stormindexing"> <tt>GET /api/v1/storm/indexing</tt></a></td> </tr> <tr class="b"> -<td><a href="#GET_apiv1stormindexingstop"> <tt>GET /api/v1/storm/indexing/stop</tt></a></td> +<td><a href="#GET_apiv1stormindexingactivate"> <tt>GET /api/v1/storm/indexing/activate</tt></a></td> </tr> <tr class="a"> -<td><a href="#GET_apiv1stormparseractivatename"> <tt>GET /api/v1/storm/parser/activate/{name}</tt></a></td> +<td><a href="#GET_apiv1stormindexingdeactivate"> <tt>GET /api/v1/storm/indexing/deactivate</tt></a></td> </tr> <tr class="b"> -<td><a href="#GET_apiv1stormparserdeactivatename"> <tt>GET /api/v1/storm/parser/deactivate/{name}</tt></a></td> +<td><a href="#GET_apiv1stormindexingstart"> <tt>GET /api/v1/storm/indexing/start</tt></a></td> </tr> <tr class="a"> -<td><a href="#GET_apiv1stormparserstartname"> <tt>GET /api/v1/storm/parser/start/{name}</tt></a></td> +<td><a href="#GET_apiv1stormindexingstop"> <tt>GET /api/v1/storm/indexing/stop</tt></a></td> </tr> <tr class="b"> -<td><a href="#GET_apiv1stormparserstopname"> <tt>GET /api/v1/storm/parser/stop/{name}</tt></a></td> +<td><a href="#GET_apiv1stormparseractivatename"> <tt>GET /api/v1/storm/parser/activate/{name}</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#GET_apiv1stormparserdeactivatename"> <tt>GET /api/v1/storm/parser/deactivate/{name}</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#GET_apiv1stormparserstartname"> <tt>GET /api/v1/storm/parser/start/{name}</tt></a></td> </tr> <tr class="a"> +<td><a href="#GET_apiv1stormparserstopname"> <tt>GET /api/v1/storm/parser/stop/{name}</tt></a></td> + </tr> + +<tr class="b"> + <td><a href="#GET_apiv1stormname"> <tt>GET /api/v1/storm/{name}</tt></a></td> </tr> +<tr class="a"> + +<td><a href="#GET_apiv1stormsupervisors"> <tt>GET /api/v1/storm/supervisors</tt></a></td> + </tr> + +<tr class="b"> + +<td><a href="#PATCH_apiv1updatepatch"> <tt>PATCH /api/v1/update/patch</tt></a></td> + </tr> + +<tr class="a"> + +<td><a href="#patch-apiv1updatereplace"> <tt>PUT /api/v1/update/replace</tt></a></td> + </tr> + <tr class="b"> <td><a href="#GET_apiv1user"> <tt>GET /api/v1/user</tt></a></td> @@ -900,6 +961,27 @@ METRON_SERVICE_KEYTAB="/etc/security/keytabs/metron.keytab" </tbody> </table> <div class="section"> +<h3><a name="POST_apiv1alertescalate"></a><tt>POST /api/v1/alert/escalate</tt></h3> + +<ul> + +<li>Description: Escalates a list of alerts by producing it to the Kafka escalate topic</li> + +<li>Input: + +<ul> + +<li>alerts - The alerts to be escalated</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - Alerts were escalated</li> + </ul></li> +</ul></div> +<div class="section"> <h3><a name="GET_apiv1globalconfig"></a><tt>GET /api/v1/global/config</tt></h3> <ul> @@ -1205,6 +1287,112 @@ METRON_SERVICE_KEYTAB="/etc/security/keytabs/metron.keytab" </ul></li> </ul></div> <div class="section"> +<h3><a name="GET_apiv1searchfindOne"></a><tt>GET /api/v1/search/findOne</tt></h3> + +<ul> + +<li>Description: Returns latest document for a guid and sensor</li> + +<li>Input: + +<ul> + +<li>getRequest - Get request + +<ul> + +<li>guid - message UUID</li> + +<li>sensorType - Sensor Type</li> + </ul></li> + +<li>Example: Return <tt>bro</tt> document with UUID of <tt>000-000-0000</tt></li> + </ul></li> +</ul> + +<div class="source"> +<div class="source"> +<pre>{ + "guid" : "000-000-0000", + "sensorType" : "bro" +} +</pre></div></div> + +<ul> + +<li>Returns: + +<ul> + +<li>200 - Document representing the output</li> + +<li>404 - Document with UUID and sensor type not found</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1searchsearch"></a><tt>GET /api/v1/search/search</tt></h3> + +<ul> + +<li>Description: Searches the indexing store</li> + +<li>Input: + +<ul> + +<li>searchRequest - Search request</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - Search results</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1searchcolumnmetadata"></a><tt>GET /api/v1/search/column/metadata</tt></h3> + +<ul> + +<li>Description: Get column metadata for each index in the list of indicies</li> + +<li>Input: + +<ul> + +<li>indices - Indices</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - Column Metadata</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="GET_apiv1searchcolumnmetadatacommon"></a><tt>GET /api/v1/search/column/metadata/common</tt></h3> + +<ul> + +<li>Description: Get metadata for columns shared by the list of indices</li> + +<li>Input: + +<ul> + +<li>indices - Indices</li> + </ul></li> + +<li>Returns: + +<ul> + +<li>200 - Common Column Metadata</li> + </ul></li> +</ul></div> +<div class="section"> <h3><a name="GET_apiv1sensorenrichmentconfig"></a><tt>GET /api/v1/sensor/enrichment/config</tt></h3> <ul> @@ -1914,6 +2102,123 @@ METRON_SERVICE_KEYTAB="/etc/security/keytabs/metron.keytab" </ul></li> </ul></div> <div class="section"> +<h3><a name="GET_apiv1stormsupervisors"></a><tt>GET /api/v1/storm/supervisors</tt></h3> + +<ul> + +<li>Description: Retrieves the status of all Storm Supervisors</li> + +<li>Returns: + +<ul> + +<li>200 - Returns a list of the status of all Storm Supervisors</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="PATCH_apiv1updatepatch"></a><tt>PATCH /api/v1/update/patch</tt></h3> + +<ul> + +<li>Description: Update a document with a patch</li> + +<li>Input: + +<ul> + +<li>request - Patch Request + +<ul> + +<li>guid - The Patch UUID</li> + +<li>sensorType - The sensor type</li> + +<li>patch - An array of <a class="externalLink" href="https://tools.ietf.org/html/rfc6902";>RFC 6902</a> patches.</li> + </ul></li> + +<li>Example adding a field called <tt>project</tt> with value <tt>metron</tt> to the <tt>bro</tt> message with UUID of <tt>000-000-0000</tt> :</li> + </ul></li> +</ul> + +<div class="source"> +<div class="source"> +<pre> { + "guid" : "000-000-0000", + "sensorType" : "bro", + "patch" : [ + { + "op": "add" + , "path": "/project" + , "value": "metron" + } + ] + } +</pre></div></div> + +<ul> + +<li>Returns: + +<ul> + +<li>200 - nothing</li> + +<li>404 - document not found</li> + </ul></li> +</ul></div> +<div class="section"> +<h3><a name="PUT_apiv1updatereplace"></a><tt>PUT /api/v1/update/replace</tt></h3> + +<ul> + +<li>Description: Replace a document</li> + +<li>Input: + +<ul> + +<li>request - Replacement request + +<ul> + +<li>guid - The Patch UUID</li> + +<li>sensorType - The sensor type</li> + +<li>replacement - A Map representing the replaced document</li> + </ul></li> + +<li>Example replacing a <tt>bro</tt> message with guid of <tt>000-000-0000</tt></li> + </ul></li> +</ul> + +<div class="source"> +<div class="source"> +<pre> { + "guid" : "000-000-0000", + "sensorType" : "bro", + "replacement" : { + "source:type": "bro", + "guid" : "bro_index_2017.01.01.01:1", + "ip_src_addr":"192.168.1.2", + "ip_src_port": 8009, + "timestamp":200, + "rejected":false + } + } +</pre></div></div> + +<ul> + +<li>Returns: + +<ul> + +<li>200 - Current user</li> + </ul></li> +</ul></div> +<div class="section"> <h3><a name="GET_apiv1user"></a><tt>GET /api/v1/user</tt></h3> <ul> http://git-wip-us.apache.org/repos/asf/metron/blob/87ff7b73/site/current-book/metron-platform/Performance-tuning-guide.html ---------------------------------------------------------------------- diff --git a/site/current-book/metron-platform/Performance-tuning-guide.html b/site/current-book/metron-platform/Performance-tuning-guide.html new file mode 100644 index 0000000..e985bdd --- /dev/null +++ b/site/current-book/metron-platform/Performance-tuning-guide.html @@ -0,0 +1,677 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2017-09-15 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20170915" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Metron – Metron Performance Tuning Guide</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + + + <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> + + + +<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> + + </head> + <body class="topBarDisabled"> + + + + + <div class="container-fluid"> + <div id="banner"> + <div class="pull-left"> + <a href="http://metron.apache.org/"; id="bannerLeft"> + <img src="../images/metron-logo.png" alt="Apache Metron" width="148px" height="48px"/> + </a> + </div> + <div class="pull-right"> </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="http://www.apache.org"; class="externalLink" title="Apache"> + Apache</a> + </li> + <li class="divider ">/</li> + <li class=""> + <a href="http://metron.apache.org/"; class="externalLink" title="Metron"> + Metron</a> + </li> + <li class="divider ">/</li> + <li class=""> + <a href="../index.html" title="Documentation"> + Documentation</a> + </li> + <li class="divider ">/</li> + <li class="">Metron Performance Tuning Guide</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2017-09-15</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.4.1</li> + + </ul> + </div> + + + <div class="row-fluid"> + <div id="leftColumn" class="span3"> + <div class="well sidebar-nav"> + + + <ul class="nav nav-list"> + <li class="nav-header">User Documentation</li> + + <li> + + <a href="../index.html" title="Metron"> + <i class="icon-chevron-down"></i> + Metron</a> + <ul class="nav nav-list"> + + <li> + + <a href="../Upgrading.html" title="Upgrading"> + <i class="none"></i> + Upgrading</a> + </li> + + <li> + + <a href="../metron-analytics/index.html" title="Analytics"> + <i class="icon-chevron-right"></i> + Analytics</a> + </li> + + <li> + + <a href="../metron-contrib/metron-docker/index.html" title="Docker"> + <i class="none"></i> + Docker</a> + </li> + + <li> + + <a href="../metron-deployment/index.html" title="Deployment"> + <i class="icon-chevron-right"></i> + Deployment</a> + </li> + + <li> + + <a href="../metron-interface/metron-alerts/index.html" title="Alerts"> + <i class="none"></i> + Alerts</a> + </li> + + <li> + + <a href="../metron-interface/metron-config/index.html" title="Config"> + <i class="none"></i> + Config</a> + </li> + + <li> + + <a href="../metron-interface/metron-rest/index.html" title="Rest"> + <i class="none"></i> + Rest</a> + </li> + + <li> + + <a href="../metron-platform/index.html" title="Platform"> + <i class="icon-chevron-down"></i> + Platform</a> + <ul class="nav nav-list"> + + <li class="active"> + + <a href="#"><i class="none"></i>Performance-tuning-guide</a> + </li> + + <li> + + <a href="../metron-platform/metron-api/index.html" title="Api"> + <i class="none"></i> + Api</a> + </li> + + <li> + + <a href="../metron-platform/metron-common/index.html" title="Common"> + <i class="none"></i> + Common</a> + </li> + + <li> + + <a href="../metron-platform/metron-data-management/index.html" title="Data-management"> + <i class="none"></i> + Data-management</a> + </li> + + <li> + + <a href="../metron-platform/metron-enrichment/index.html" title="Enrichment"> + <i class="none"></i> + Enrichment</a> + </li> + + <li> + + <a href="../metron-platform/metron-indexing/index.html" title="Indexing"> + <i class="none"></i> + Indexing</a> + </li> + + <li> + + <a href="../metron-platform/metron-management/index.html" title="Management"> + <i class="none"></i> + Management</a> + </li> + + <li> + + <a href="../metron-platform/metron-parsers/index.html" title="Parsers"> + <i class="icon-chevron-right"></i> + Parsers</a> + </li> + + <li> + + <a href="../metron-platform/metron-pcap-backend/index.html" title="Pcap-backend"> + <i class="none"></i> + Pcap-backend</a> + </li> + + <li> + + <a href="../metron-platform/metron-writer/index.html" title="Writer"> + <i class="none"></i> + Writer</a> + </li> + </ul> + </li> + + <li> + + <a href="../metron-sensors/index.html" title="Sensors"> + <i class="icon-chevron-right"></i> + Sensors</a> + </li> + + <li> + + <a href="../metron-stellar/stellar-common/index.html" title="Stellar-common"> + <i class="icon-chevron-right"></i> + Stellar-common</a> + </li> + + <li> + + <a href="../use-cases/index.html" title="Use-cases"> + <i class="icon-chevron-right"></i> + Use-cases</a> + </li> + </ul> + </li> + </ul> + + + + <hr class="divider" /> + + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> + </a> + </div> + </div> + </div> + + + <div id="bodyColumn" class="span9" > + + <h1>Metron Performance Tuning Guide</h1> +<p><a name="Metron_Performance_Tuning_Guide"></a></p> +<div class="section"> +<h2><a name="Overview"></a>Overview</h2> +<p>This document provides guidance from our experiences tuning the Apache Metron Storm topologies for maximum performance. You’ll find suggestions for optimum configurations under a 1 gbps load along with some guidance around the tooling we used to monitor and assess our throughput.</p> +<p>In the simplest terms, Metron is a streaming architecture created on top of Kafka and three main types of Storm topologies: parsers, enrichment, and indexing. Each parser has it’s own topology and there is also a highly performant, specialized spout-only topology for streaming PCAP data to HDFS. We found that the architecture can be tuned almost exclusively through using a few primary Storm and Kafka parameters along with a few Metron-specific options. You can think of the data flow as being similar to water flowing through a pipe, and the majority of these options assist in tweaking the various pipe widths in the system.</p></div> +<div class="section"> +<h2><a name="General_Tuning_Suggestions"></a>General Tuning Suggestions</h2> +<p>Note that there is currently no method for specifying the number of tasks from the number of executors in Flux topologies (enrichment, indexing). By default, the number of tasks will equal the number of executors. Logically, setting the number of tasks equal to the number of executors is sensible. Storm enforces num executors <= num tasks. The reason you might set the number of tasks higher than the number of executors is for future performance tuning and rebalancing without the need to bring down your topologies. The number of tasks is fixed at topology startup time whereas the number of executors can be increased up to a maximum value equal to the number of tasks.</p> +<p>When configuring Storm Kafka spouts, we found that the default values for poll.timeout.ms, offset.commit.period.ms, and max.uncommitted.offsets worked well in nearly all cases. As a general rule, it was optimal to set spout parallelism equal to the number of partitions used in your Kafka topic. Any greater parallelism will leave you with idle consumers since Kafka limits the max number of consumers to the number of partitions. This is important because Kafka has certain ordering guarantees for message delivery per partition that would not be possible if more than one consumer in a given consumer group were able to read from that partition.</p></div> +<div class="section"> +<h2><a name="Component_Tuning_Levers"></a>Component Tuning Levers</h2> + +<ul> + +<li>Kafka + +<ul> + +<li>Number partitions</li> + </ul></li> + +<li>Storm + +<ul> + +<li>Kafka spout + +<ul> + +<li>Polling frequency</li> + +<li>Polling timeouts</li> + +<li>Offset commit period</li> + +<li>Max uncommitted offsets</li> + </ul></li> + +<li>Number workers (OS processes)</li> + +<li>Number executors (threads in a process)</li> + +<li>Number ackers</li> + +<li>Max spout pending</li> + +<li>Spout and bolt parallelism</li> + </ul></li> + +<li>HDFS + +<ul> + +<li>Replication factor</li> + </ul></li> +</ul> +<div class="section"> +<h3><a name="Kafka_Tuning"></a>Kafka Tuning</h3> +<p>The main lever you’re going to work with when tuning Kafka throughput will be the number of partitions. A handy method for deciding how many partitions to use is to first calculate the throughput for a single producer (p) and a single consumer (c), and then use that with the desired throughput (t) to roughly estimate the number of partitions to use. You would want at least max(t/p, t/c) partitions to attain the desired throughput. See <a class="externalLink" href="https://www.confluent.io/blog/how-to-choose-the-number-of-topicspartitions-in-a-kafka-cluster/";>https://www.confluent.io/blog/how-to-choose-the-number-of-topicspartitions-in-a-kafka-cluster/</a> for more details.</p></div> +<div class="section"> +<h3><a name="Storm_Tuning"></a>Storm Tuning</h3> +<p>There are quite a few options you will be confronted with when tuning your Storm topologies and this is largely trial and error. As a general rule of thumb, we recommend starting with the defaults and smaller numbers in terms of parallelism while iteratively working up until the desired performance is achieved. You will find the offset lag tool indispensable while verifying your settings.</p> +<p>We won’t go into a full discussion about Storm’s architecture - see references section for more info - but there are some general rules of thumb that should be followed. It’s first important to understand the ways you can impact parallelism in a Storm topology.</p> + +<ul> + +<li>num tasks</li> + +<li>num executors (parallelism hint)</li> + +<li>num workers</li> +</ul> +<p>Tasks are instances of a given spout or bolt, executors are threads in a process, and workers are jvm processes. You’ll want the number of tasks as a multiple of the number of executors, the number of executors as multiple of the number of workers, and the number of workers as a multiple of the number of machines. The main reason for this approach is that it will give a uniform distribution of work to each machine and jvm process. More often than not, your number of tasks will be equal to the number of executors, which is the default in Storm. Flux does not actually provide a way to independently set number of tasks, so for enrichments and indexing which use Flux, num tasks will always equal num executors.</p> +<p>You can change the number of workers via the property <tt>topology.workers</tt></p> +<p><b>Other Storm Settings</b></p> + +<div class="source"> +<div class="source"> +<pre>topology.max.spout.pending +</pre></div></div> +<p>This is the maximum number of tuples that can be in flight (ie, not yet acked) at any given time within your topology. You set this as a form of backpressure to ensure you don’t flood your topology.</p> + +<div class="source"> +<div class="source"> +<pre>topology.ackers.executors +</pre></div></div> +<p>This specifies how many threads should be dedicated to tuple acking. We found that setting this equal to the number of partitions in your inbound Kafka topic worked well.</p> +<p><b>spout-config.json</b></p> + +<div class="source"> +<div class="source"> +<pre>{ + ... + "spout.pollTimeoutMs" : 200, + "spout.maxUncommittedOffsets" : 10000000, + "spout.offsetCommitPeriodMs" : 30000 +} +</pre></div></div> +<p>These are the spout recommended defaults from Storm and are currently the defaults provided in the Kafka spout itself. In fact, if you find the recommended defaults work fine for you, then you can omit these settings altogether.</p></div></div> +<div class="section"> +<h2><a name="Use_Case_Specific_Tuning_Suggestions"></a>Use Case Specific Tuning Suggestions</h2> +<p>The below discussion outlines a specific tuning exercise we went through for driving 1 Gbps of traffic through a Metron cluster running with 4 Kafka brokers and 4 Storm Supervisors.</p> +<p>General machine specs</p> + +<ul> + +<li>10 Gb network cards</li> + +<li>256 GB memory</li> + +<li>12 disks</li> + +<li>32 cores</li> +</ul> +<div class="section"> +<h3><a name="Performance_Monitoring_Tools"></a>Performance Monitoring Tools</h3> +<p>Before we get to tuning our cluster, it helps to describe what we might actually want to monitor as well as any potential pain points. Prior to switching over to the new Storm Kafka client, which leverages the new Kafka consumer API under the hood, offsets were stored in Zookeeper. While the broker hosts are still stored in Zookeeper, this is no longer true for the offsets which are now stored in Kafka itself. This is a configurable option, and you may switch back to Zookeeper if you choose, but Metron is currently using the new defaults. With this in mind, there are some useful tools that come with Storm and Kafka that we can use to monitor our topologies.</p> +<div class="section"> +<h4><a name="Tooling"></a>Tooling</h4> +<p>Kafka</p> + +<ul> + +<li>consumer group offset lag viewer</li> + +<li>There is a GUI tool to make creating, modifying, and generally managing your Kafka topics a bit easier - see <a class="externalLink" href="https://github.com/yahoo/kafka-manager";>https://github.com/yahoo/kafka-manager</a></li> + +<li>console consumer - useful for quickly verifying topic contents</li> +</ul> +<p>Storm</p> + +<ul> + +<li>Storm UI - <a class="externalLink" href="http://www.malinga.me/reading-and-understanding-the-storm-ui-storm-ui-explained/";>http://www.malinga.me/reading-and-understanding-the-storm-ui-storm-ui-explained/</a></li> +</ul></div> +<div class="section"> +<h4><a name="Example_-_Viewing_Kafka_Offset_Lags"></a>Example - Viewing Kafka Offset Lags</h4> +<p>First we need to setup some environment variables</p> + +<div class="source"> +<div class="source"> +<pre>export BROKERLIST=<your broker comma-delimated list of host:ports> +export ZOOKEEPER=<your zookeeper comma-delimated list of host:ports> +export KAFKA_HOME=<kafka home dir> +export METRON_HOME=<your metron home> +export HDP_HOME=<your HDP home> +</pre></div></div> +<p>If you have Kerberos enabled, setup the security protocol</p> + +<div class="source"> +<div class="source"> +<pre>$ cat /tmp/consumergroup.config +security.protocol=SASL_PLAINTEXT +</pre></div></div> +<p>Now run the following command for a running topology’s consumer group. In this example we are using enrichments.</p> + +<div class="source"> +<div class="source"> +<pre>${KAFKA_HOME}/bin/kafka-consumer-groups.sh \ + --command-config=/tmp/consumergroup.config \ + --describe \ + --group enrichments \ + --bootstrap-server $BROKERLIST \ + --new-consumer +</pre></div></div> +<p>This will return a table with the following output depicting offsets for all partitions and consumers associated with the specified consumer group:</p> + +<div class="source"> +<div class="source"> +<pre>GROUP TOPIC PARTITION CURRENT-OFFSET LOG-END-OFFSET LAG OWNER +enrichments enrichments 9 29746066 29746067 1 consumer-2_/xxx.xxx.xxx.xxx +enrichments enrichments 3 29754325 29754326 1 consumer-1_/xxx.xxx.xxx.xxx +enrichments enrichments 43 29754331 29754332 1 consumer-6_/xxx.xxx.xxx.xxx +... +</pre></div></div> +<p><i>Note</i>: You won’t see any output until a topology is actually running because the consumer groups only exist while consumers in the spouts are up and running.</p> +<p>The primary column we’re concerned with paying attention to is the LAG column, which is the current delta calculation between the current and end offset for the partition. This tells us how close we are to keeping up with incoming data. And, as we found through multiple trials, whether there are any problems with specific consumers getting stuck.</p> +<p>Taking this one step further, it’s probably more useful if we can watch the offsets and lags change over time. In order to do this we’ll add a “watch” command and set the refresh rate to 10 seconds.</p> + +<div class="source"> +<div class="source"> +<pre>watch -n 10 -d ${KAFKA_HOME}/bin/kafka-consumer-groups.sh \ + --command-config=/tmp/consumergroup.config \ + --describe \ + --group enrichments \ + --bootstrap-server $BROKERLIST \ + --new-consumer +</pre></div></div> +<p>Every 10 seconds the command will re-run and the screen will be refreshed with new information. The most useful bit is that the watch command will highlight the differences from the current output and the last output screens.</p></div></div> +<div class="section"> +<h3><a name="Parser_Tuning"></a>Parser Tuning</h3> +<p>We’ll be using the bro sensor in this example. Note that the parsers and PCAP use a builder utility, as opposed to enrichments and indexing, which use Flux.</p> +<p>We started with a single partition for the inbound Kafka topics and eventually worked our way up to 48. And We’re using the following pending value, as shown below. The default is ‘null’ which would result in no limit.</p> +<p><b>storm-bro.config</b></p> + +<div class="source"> +<div class="source"> +<pre>{ + ... + "topology.max.spout.pending" : 2000 + ... +} +</pre></div></div> +<p>And the following default spout settings. Again, this can be ommitted entirely since we are using the defaults.</p> +<p><b>spout-bro.config</b></p> + +<div class="source"> +<div class="source"> +<pre>{ + ... + "spout.pollTimeoutMs" : 200, + "spout.maxUncommittedOffsets" : 10000000, + "spout.offsetCommitPeriodMs" : 30000 +} +</pre></div></div> +<p>And we ran our bro parser topology with the following options. We did not need to fully match the number of Kafka partitions with our parallelism in this case, though you could certainly do so if necessary. Notice that we only needed 1 worker.</p> + +<div class="source"> +<div class="source"> +<pre>/usr/metron/0.4.0/bin/start_parser_topology.sh -k $BROKERLIST -z $ZOOKEEPER -s bro -ksp SASL_PLAINTEXT + -ot enrichments + -e ~metron/.storm/storm-bro.config \ + -esc ~/.storm/spout-bro.config \ + -sp 24 \ + -snt 24 \ + -nw 1 \ + -pnt 24 \ + -pp 24 \ +</pre></div></div> +<p>From the usage docs, here are the options we’ve used. The full reference can be found here - <a class="externalLink" href="https://github.com/apache/metron/blob/master/metron-platform/metron-parsers/README.md";>https://github.com/apache/metron/blob/master/metron-platform/metron-parsers/README.md</a></p> + +<div class="source"> +<div class="source"> +<pre>-e,--extra_topology_options <JSON_FILE> Extra options in the form + of a JSON file with a map + for content. +-esc,--extra_kafka_spout_config <JSON_FILE> Extra spout config options + in the form of a JSON file + with a map for content. + Possible keys are: + retryDelayMaxMs,retryDelay + Multiplier,retryInitialDel + ayMs,stateUpdateIntervalMs + ,bufferSizeBytes,fetchMaxW + ait,fetchSizeBytes,maxOffs + etBehind,metricsTimeBucket + SizeInSecs,socketTimeoutMs +-sp,--spout_p <SPOUT_PARALLELISM_HINT> Spout Parallelism Hint +-snt,--spout_num_tasks <NUM_TASKS> Spout Num Tasks +-nw,--num_workers <NUM_WORKERS> Number of Workers +-pnt,--parser_num_tasks <NUM_TASKS> Parser Num Tasks +-pp,--parser_p <PARALLELISM_HINT> Parser Parallelism Hint +</pre></div></div></div> +<div class="section"> +<h3><a name="Enrichment_Tuning"></a>Enrichment Tuning</h3> +<p>We landed on the same number of partitions for enrichemnt and indexing as we did for bro - 48.</p> +<p>For configuring Storm, there is a flux file and properties file that we modified. Here are the settings we changed for bro in Flux. Note that the main Metron-specific option we’ve changed to accomodate the desired rate of data throughput is max cache size in the join bolts. More information on Flux can be found here - <a class="externalLink" href="http://storm.apache.org/releases/1.0.1/flux.html";>http://storm.apache.org/releases/1.0.1/flux.html</a></p> +<p><b>General storm settings</b></p> + +<div class="source"> +<div class="source"> +<pre>topology.workers: 8 +topology.acker.executors: 48 +topology.max.spout.pending: 2000 +</pre></div></div> +<p><b>Spout and Bolt Settings</b></p> + +<div class="source"> +<div class="source"> +<pre>kafkaSpout + parallelism=48 + session.timeout.ms=29999 + enable.auto.commit=false + setPollTimeoutMs=200 + setMaxUncommittedOffsets=10000000 + setOffsetCommitPeriodMs=30000 +enrichmentSplitBolt + parallelism=4 +enrichmentJoinBolt + parallelism=8 + withMaxCacheSize=200000 + withMaxTimeRetain=10 +threatIntelSplitBolt + parallelism=4 +threatIntelJoinBolt + parallelism=4 + withMaxCacheSize=200000 + withMaxTimeRetain=10 +outputBolt + parallelism=48 +</pre></div></div></div> +<div class="section"> +<h3><a name="Indexing_HDFS_Tuning"></a>Indexing (HDFS) Tuning</h3> +<p>There are 48 partitions set for the indexing partition, per the enrichment exercise above.</p> +<p>These are the batch size settings for the bro index</p> + +<div class="source"> +<div class="source"> +<pre>cat ${METRON_HOME}/config/zookeeper/indexing/bro.json +{ + "hdfs" : { + "index": "bro", + "batchSize": 50, + "enabled" : true + }... +} +</pre></div></div> +<p>And here are the settings we used for the indexing topology</p> +<p><b>General storm settings</b></p> + +<div class="source"> +<div class="source"> +<pre>topology.workers: 4 +topology.acker.executors: 24 +topology.max.spout.pending: 2000 +</pre></div></div> +<p><b>Spout and Bolt Settings</b></p> + +<div class="source"> +<div class="source"> +<pre>hdfsSyncPolicy + org.apache.storm.hdfs.bolt.sync.CountSyncPolicy + constructor arg=100000 +hdfsRotationPolicy + bolt.hdfs.rotation.policy.units=DAYS + bolt.hdfs.rotation.policy.count=1 +kafkaSpout + parallelism: 24 + session.timeout.ms=29999 + enable.auto.commit=false + setPollTimeoutMs=200 + setMaxUncommittedOffsets=10000000 + setOffsetCommitPeriodMs=30000 +hdfsIndexingBolt + parallelism: 24 +</pre></div></div></div> +<div class="section"> +<h3><a name="PCAP_Tuning"></a>PCAP Tuning</h3> +<p>PCAP is a specialized topology that is a Spout-only topology. Both Kafka topic consumption and HDFS writing is done within a spout to avoid the additional network hop required if using an additional bolt.</p> +<p><b>General Storm topology properties</b></p> + +<div class="source"> +<div class="source"> +<pre>topology.workers=16 +topology.ackers.executors: 0 +</pre></div></div> +<p><b>Spout and Bolt properties</b></p> + +<div class="source"> +<div class="source"> +<pre>kafkaSpout + parallelism: 128 + poll.timeout.ms=100 + offset.commit.period.ms=30000 + session.timeout.ms=39000 + max.uncommitted.offsets=200000000 + max.poll.interval.ms=10 + max.poll.records=200000 + receive.buffer.bytes=431072 + max.partition.fetch.bytes=10000000 + enable.auto.commit=false + setMaxUncommittedOffsets=20000000 + setOffsetCommitPeriodMs=30000 + +writerConfig + withNumPackets=1265625 + withMaxTimeMS=0 + withReplicationFactor=1 + withSyncEvery=80000 + withHDFSConfig + io.file.buffer.size=1000000 + dfs.blocksize=1073741824 +</pre></div></div></div></div> +<div class="section"> +<h2><a name="Issues"></a>Issues</h2> +<p><b>Error</b></p> + +<div class="source"> +<div class="source"> +<pre>org.apache.kafka.clients.consumer.CommitFailedException: Commit cannot be completed since the group has already rebalanced and assigned +the partitions to another member. This means that the time between subsequent calls to poll() was longer than the configured session.timeout.ms, +which typically implies that the poll loop is spending too much time message processing. You can address this either by increasing the +session timeout or by reducing the maximum size of batches returned in poll() with max.poll.records +</pre></div></div> +<p><b>Suggestions</b></p> +<p>This implies that the spout hasn’t been given enough time between polls before committing the offsets. In other words, the amount of time taken to process the messages is greater than the timeout window. In order to fix this, you can improve message throughput by modifying the options outlined above, increasing the poll timeout, or both.</p></div> +<div class="section"> +<h2><a name="Reference"></a>Reference</h2> + +<ul> + +<li><a class="externalLink" href="http://storm.apache.org/releases/1.0.1/flux.html";>http://storm.apache.org/releases/1.0.1/flux.html</a></li> + +<li><a class="externalLink" href="https://stackoverflow.com/questions/17257448/what-is-the-task-in-storm-parallelism";>https://stackoverflow.com/questions/17257448/what-is-the-task-in-storm-parallelism</a></li> + +<li><a class="externalLink" href="http://storm.apache.org/releases/current/Understanding-the-parallelism-of-a-Storm-topology.html";>http://storm.apache.org/releases/current/Understanding-the-parallelism-of-a-Storm-topology.html</a></li> + +<li><a class="externalLink" href="http://www.malinga.me/reading-and-understanding-the-storm-ui-storm-ui-explained/";>http://www.malinga.me/reading-and-understanding-the-storm-ui-storm-ui-explained/</a></li> + +<li><a class="externalLink" href="https://www.confluent.io/blog/how-to-choose-the-number-of-topicspartitions-in-a-kafka-cluster/";>https://www.confluent.io/blog/how-to-choose-the-number-of-topicspartitions-in-a-kafka-cluster/</a></li> + +<li><a class="externalLink" href="https://docs.hortonworks.com/HDPDocuments/HDP2/HDP-2.6.1/bk_storm-component-guide/content/storm-kafkaspout-perf.html";>https://docs.hortonworks.com/HDPDocuments/HDP2/HDP-2.6.1/bk_storm-component-guide/content/storm-kafkaspout-perf.html</a></li> +</ul></div> + </div> + </div> + </div> + + <hr/> + + <footer> + <div class="container-fluid"> + <div class="row span12">Copyright © 2017 + <a href="https://www.apache.org";>The Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + + </div> + </footer> + </body> +</html>
