http://git-wip-us.apache.org/repos/asf/storm-site/blob/6e122a12/content/releases/1.2.1/STORM-UI-REST-API.html ---------------------------------------------------------------------- diff --git a/content/releases/1.2.1/STORM-UI-REST-API.html b/content/releases/1.2.1/STORM-UI-REST-API.html deleted file mode 100644 index 2bdd138..0000000 --- a/content/releases/1.2.1/STORM-UI-REST-API.html +++ /dev/null @@ -1,3014 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <meta charset="utf-8"> - <meta http-equiv="X-UA-Compatible" content="IE=edge"> - <meta name="viewport" content="width=device-width, initial-scale=1"> - - <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon"> - <link rel="icon" href="/favicon.ico" type="image/x-icon"> - - <title>Storm UI REST API</title> - - <!-- Bootstrap core CSS --> - <link href="/assets/css/bootstrap.min.css" rel="stylesheet"> - <!-- Bootstrap theme --> - <link href="/assets/css/bootstrap-theme.min.css" rel="stylesheet"> - - <!-- Custom styles for this template --> - <link rel="stylesheet" href="http://fortawesome.github.io/Font-Awesome/assets/font-awesome/css/font-awesome.css";> - <link href="/css/style.css" rel="stylesheet"> - <link href="/assets/css/owl.theme.css" rel="stylesheet"> - <link href="/assets/css/owl.carousel.css" rel="stylesheet"> - <script type="text/javascript" src="/assets/js/jquery.min.js"></script> - <script type="text/javascript" src="/assets/js/bootstrap.min.js"></script> - <script type="text/javascript" src="/assets/js/owl.carousel.min.js"></script> - <script type="text/javascript" src="/assets/js/storm.js"></script> - <!-- Just for debugging purposes. Don't actually copy these 2 lines! --> - <!--[if lt IE 9]><script src="../../assets/js/ie8-responsive-file-warning.js"></script><![endif]--> - - <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> - <!--[if lt IE 9]> - <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js";></script> - <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script> - <![endif]--> - </head> - - - <body> - <header> - <div class="container-fluid"> - <div class="row"> - <div class="col-md-5"> - <a href="/index.html"><img src="/images/logo.png" class="logo" /></a> - </div> - <div class="col-md-5"> - - <h1>Version: 1.2.1</h1> - - </div> - <div class="col-md-2"> - <a href="/downloads.html" class="btn-std btn-block btn-download">Download</a> - </div> - </div> - </div> -</header> -<!--Header End--> -<!--Navigation Begin--> -<div class="navbar" role="banner"> - <div class="container-fluid"> - <div class="navbar-header"> - <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bs-navbar-collapse"> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> - </div> - <nav class="collapse navbar-collapse bs-navbar-collapse" role="navigation"> - <ul class="nav navbar-nav"> - <li><a href="/index.html" id="home">Home</a></li> - <li><a href="/getting-help.html" id="getting-help">Getting Help</a></li> - <li><a href="/about/integrates.html" id="project-info">Project Information</a></li> - <li class="dropdown"> - <a href="#" class="dropdown-toggle" data-toggle="dropdown" id="documentation">Documentation <b class="caret"></b></a> - <ul class="dropdown-menu"> - - - <li><a href="/releases/2.0.0-SNAPSHOT/index.html">2.0.0-SNAPSHOT</a></li> - - - - <li><a href="/releases/1.2.1/index.html">1.2.1</a></li> - - - - <li><a href="/releases/1.1.2/index.html">1.1.2</a></li> - - - - - - <li><a href="/releases/1.0.6/index.html">1.0.6</a></li> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - </ul> - </li> - <li><a href="/talksAndVideos.html">Talks and Slideshows</a></li> - <li class="dropdown"> - <a href="#" class="dropdown-toggle" data-toggle="dropdown" id="contribute">Community <b class="caret"></b></a> - <ul class="dropdown-menu"> - <li><a href="/contribute/Contributing-to-Storm.html">Contributing</a></li> - <li><a href="/contribute/People.html">People</a></li> - <li><a href="/contribute/BYLAWS.html">ByLaws</a></li> - </ul> - </li> - <li><a href="/2018/06/04/storm122-released.html" id="news">News</a></li> - </ul> - </nav> - </div> -</div> - - - - <div class="container-fluid"> - <h1 class="page-title">Storm UI REST API</h1> - <div class="row"> - <div class="col-md-12"> - <!-- Documentation --> - -<p class="post-meta"></p> - -<div class="documentation-content"><p>The Storm UI daemon provides a REST API that allows you to interact with a Storm cluster, which includes retrieving -metrics data and configuration information as well as management operations such as starting or stopping topologies.</p> - -<h1 id="data-format">Data format</h1> - -<p>The REST API returns JSON responses and supports JSONP. -Clients can pass a callback query parameter to wrap JSON in the callback function. -<strong>REST API allows CORS by default.</strong></p> - -<h1 id="using-the-ui-rest-api">Using the UI REST API</h1> - -<p><em>Note: It is recommended to ignore undocumented elements in the JSON response because future versions of Storm may not</em> -<em>support those elements anymore.</em></p> - -<h2 id="rest-api-base-url">REST API Base URL</h2> - -<p>The REST API is part of the UI daemon of Storm (started by <code>storm ui</code>) and thus runs on the same host and port as the -Storm UI (the UI daemon is often run on the same host as the Nimbus daemon). The port is configured by <code>ui.port</code>, -which is set to <code>8080</code> by default (see <a href="conf/defaults.yaml">defaults.yaml</a>).</p> - -<p>The API base URL would thus be:</p> -<div class="highlight"><pre><code class="language-" data-lang="">http://<ui-host>:<ui-port>/api/v1/... -</code></pre></div> -<p>You can use a tool such as <code>curl</code> to talk to the REST API:</p> -<div class="highlight"><pre><code class="language-" data-lang=""># Request the cluster configuration. -# Note: We assume ui.port is configured to the default value of 8080. -$ curl http://<ui-host>:8080/api/v1/cluster/configuration -</code></pre></div> -<h2 id="impersonating-a-user-in-secure-environment">Impersonating a user in secure environment</h2> - -<p>In a secure environment an authenticated user can impersonate another user. To impersonate a user the caller must pass -<code>doAsUser</code> param or header with value set to the user that the request needs to be performed as. Please see SECURITY.MD -to learn more about how to setup impersonation ACLs and authorization. The rest API uses the same configs and acls that -are used by nimbus.</p> - -<p>Examples:</p> -<div class="highlight"><pre><code class="language-no-highlight" data-lang="no-highlight"> 1. http://ui-daemon-host-name:8080/api/v1/topology/wordcount-1-1425844354\?doAsUser=testUSer1 - 2. curl 'http://localhost:8080/api/v1/topology/wordcount-1-1425844354/activate' -X POST -H 'doAsUser:testUSer1' -</code></pre></div> -<h2 id="get-operations">GET Operations</h2> - -<h3 id="api-v1-cluster-configuration-get">/api/v1/cluster/configuration (GET)</h3> - -<p>Returns the cluster configuration.</p> - -<p>Sample response (does not include all the data fields):</p> -<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="w"> </span><span class="p">{</span><span class="w"> - </span><span class="s2">"dev.zookeeper.path"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/tmp/dev-storm-zookeeper"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"topology.tick.tuple.freq.secs"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w"> - </span><span class="s2">"topology.builtin.metrics.bucket.size.secs"</span><span class="p">:</span><span class="w"> </span><span class="mi">60</span><span class="p">,</span><span class="w"> - </span><span class="s2">"topology.fall.back.on.java.serialization"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w"> - </span><span class="s2">"topology.max.error.report.per.interval"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span><span class="w"> - </span><span class="s2">"zmq.linger.millis"</span><span class="p">:</span><span class="w"> </span><span class="mi">5000</span><span class="p">,</span><span class="w"> - </span><span class="s2">"topology.skip.missing.kryo.registrations"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w"> - </span><span class="s2">"storm.messaging.netty.client_worker_threads"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> - </span><span class="s2">"ui.childopts"</span><span class="p">:</span><span class="w"> </span><span class="s2">"-Xmx768m"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"storm.zookeeper.session.timeout"</span><span class="p">:</span><span class="w"> </span><span class="mi">20000</span><span class="p">,</span><span class="w"> - </span><span class="s2">"nimbus.reassign"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w"> - </span><span class="s2">"topology.trident.batch.emit.interval.millis"</span><span class="p">:</span><span class="w"> </span><span class="mi">500</span><span class="p">,</span><span class="w"> - </span><span class="s2">"storm.messaging.netty.flush.check.interval.ms"</span><span class="p">:</span><span class="w"> </span><span class="mi">10</span><span class="p">,</span><span class="w"> - </span><span class="s2">"nimbus.monitor.freq.secs"</span><span class="p">:</span><span class="w"> </span><span class="mi">10</span><span class="p">,</span><span class="w"> - </span><span class="s2">"logviewer.childopts"</span><span class="p">:</span><span class="w"> </span><span class="s2">"-Xmx128m"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"java.library.path"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/usr/local/lib:/opt/local/lib:/usr/lib"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"topology.executor.send.buffer.size"</span><span class="p">:</span><span class="w"> </span><span class="mi">1024</span><span class="p">,</span><span class="w"> - </span><span class="p">}</span><span class="w"> -</span></code></pre></div> -<h3 id="api-v1-cluster-summary-get">/api/v1/cluster/summary (GET)</h3> - -<p>Returns cluster summary information such as nimbus uptime or number of supervisors.</p> - -<p>Response fields:</p> - -<table><thead> -<tr> -<th>Field</th> -<th>Value</th> -<th>Description</th> -</tr> -</thead><tbody> -<tr> -<td>stormVersion</td> -<td>String</td> -<td>Storm version</td> -</tr> -<tr> -<td>supervisors</td> -<td>Integer</td> -<td>Number of supervisors running</td> -</tr> -<tr> -<td>topologies</td> -<td>Integer</td> -<td>Number of topologies running</td> -</tr> -<tr> -<td>slotsTotal</td> -<td>Integer</td> -<td>Total number of available worker slots</td> -</tr> -<tr> -<td>slotsUsed</td> -<td>Integer</td> -<td>Number of worker slots used</td> -</tr> -<tr> -<td>slotsFree</td> -<td>Integer</td> -<td>Number of worker slots available</td> -</tr> -<tr> -<td>executorsTotal</td> -<td>Integer</td> -<td>Total number of executors</td> -</tr> -<tr> -<td>tasksTotal</td> -<td>Integer</td> -<td>Total tasks</td> -</tr> -<tr> -<td>schedulerDisplayResource</td> -<td>Boolean</td> -<td>Whether to display scheduler resource information</td> -</tr> -<tr> -<td>totalMem</td> -<td>Double</td> -<td>The total amount of memory in the cluster in MB</td> -</tr> -<tr> -<td>totalCpu</td> -<td>Double</td> -<td>The total amount of CPU in the cluster</td> -</tr> -<tr> -<td>availMem</td> -<td>Double</td> -<td>The amount of available memory in the cluster in MB</td> -</tr> -<tr> -<td>availCpu</td> -<td>Double</td> -<td>The amount of available cpu in the cluster</td> -</tr> -<tr> -<td>memAssignedPercentUtil</td> -<td>Double</td> -<td>The percent utilization of assigned memory resources in cluster</td> -</tr> -<tr> -<td>cpuAssignedPercentUtil</td> -<td>Double</td> -<td>The percent utilization of assigned CPU resources in cluster</td> -</tr> -</tbody></table> - -<p>Sample response:</p> -<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="w"> </span><span class="p">{</span><span class="w"> - </span><span class="s2">"stormVersion"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.9.2-incubating-SNAPSHOT"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"supervisors"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> - </span><span class="s2">"slotsTotal"</span><span class="p">:</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span><span class="w"> - </span><span class="s2">"slotsUsed"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span><span class="w"> - </span><span class="s2">"slotsFree"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> - </span><span class="s2">"executorsTotal"</span><span class="p">:</span><span class="w"> </span><span class="mi">28</span><span class="p">,</span><span class="w"> - </span><span class="s2">"tasksTotal"</span><span class="p">:</span><span class="w"> </span><span class="mi">28</span><span class="p">,</span><span class="w"> - </span><span class="s2">"schedulerDisplayResource"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w"> - </span><span class="s2">"totalMem"</span><span class="p">:</span><span class="w"> </span><span class="mf">4096.0</span><span class="p">,</span><span class="w"> - </span><span class="s2">"totalCpu"</span><span class="p">:</span><span class="w"> </span><span class="mf">400.0</span><span class="p">,</span><span class="w"> - </span><span class="s2">"availMem"</span><span class="p">:</span><span class="w"> </span><span class="mf">1024.0</span><span class="p">,</span><span class="w"> - </span><span class="s2">"availCPU"</span><span class="p">:</span><span class="w"> </span><span class="mf">250.0</span><span class="p">,</span><span class="w"> - </span><span class="s2">"memAssignedPercentUtil"</span><span class="p">:</span><span class="w"> </span><span class="mf">75.0</span><span class="p">,</span><span class="w"> - </span><span class="s2">"cpuAssignedPercentUtil"</span><span class="p">:</span><span class="w"> </span><span class="mf">37.5</span><span class="w"> - </span><span class="p">}</span><span class="w"> -</span></code></pre></div> -<h3 id="api-v1-supervisor-summary-get">/api/v1/supervisor/summary (GET)</h3> - -<p>Returns summary information for all supervisors.</p> - -<p>Response fields:</p> - -<table><thead> -<tr> -<th>Field</th> -<th>Value</th> -<th>Description</th> -</tr> -</thead><tbody> -<tr> -<td>id</td> -<td>String</td> -<td>Supervisor's id</td> -</tr> -<tr> -<td>host</td> -<td>String</td> -<td>Supervisor's host name</td> -</tr> -<tr> -<td>uptime</td> -<td>String</td> -<td>Shows how long the supervisor is running</td> -</tr> -<tr> -<td>uptimeSeconds</td> -<td>Integer</td> -<td>Shows how long the supervisor is running in seconds</td> -</tr> -<tr> -<td>slotsTotal</td> -<td>Integer</td> -<td>Total number of available worker slots for this supervisor</td> -</tr> -<tr> -<td>slotsUsed</td> -<td>Integer</td> -<td>Number of worker slots used on this supervisor</td> -</tr> -<tr> -<td>schedulerDisplayResource</td> -<td>Boolean</td> -<td>Whether to display scheduler resource information</td> -</tr> -<tr> -<td>totalMem</td> -<td>Double</td> -<td>Total memory capacity on this supervisor</td> -</tr> -<tr> -<td>totalCpu</td> -<td>Double</td> -<td>Total CPU capacity on this supervisor</td> -</tr> -<tr> -<td>usedMem</td> -<td>Double</td> -<td>Used memory capacity on this supervisor</td> -</tr> -<tr> -<td>usedCpu</td> -<td>Double</td> -<td>Used CPU capacity on this supervisor</td> -</tr> -</tbody></table> - -<p>Sample response:</p> -<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> - </span><span class="s2">"supervisors"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"> - </span><span class="p">{</span><span class="w"> - </span><span class="s2">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0b879808-2a26-442b-8f7d-23101e0c3696"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"host"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10.11.1.7"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"uptime"</span><span class="p">:</span><span class="w"> </span><span class="s2">"5m 58s"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"uptimeSeconds"</span><span class="p">:</span><span class="w"> </span><span class="mi">358</span><span class="p">,</span><span class="w"> - </span><span class="s2">"slotsTotal"</span><span class="p">:</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span><span class="w"> - </span><span class="s2">"slotsUsed"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span><span class="w"> - </span><span class="s2">"totalMem"</span><span class="p">:</span><span class="w"> </span><span class="mi">3000</span><span class="p">,</span><span class="w"> - </span><span class="s2">"totalCpu"</span><span class="p">:</span><span class="w"> </span><span class="mi">400</span><span class="p">,</span><span class="w"> - </span><span class="s2">"usedMem"</span><span class="p">:</span><span class="w"> </span><span class="mi">1280</span><span class="p">,</span><span class="w"> - </span><span class="s2">"usedCPU"</span><span class="p">:</span><span class="w"> </span><span class="mi">160</span><span class="w"> - </span><span class="p">}</span><span class="w"> - </span><span class="p">],</span><span class="w"> - </span><span class="s2">"schedulerDisplayResource"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"> -</span><span class="p">}</span><span class="w"> -</span></code></pre></div> -<h3 id="api-v1-nimbus-summary-get">/api/v1/nimbus/summary (GET)</h3> - -<p>Returns summary information for all nimbus hosts.</p> - -<p>Response fields:</p> - -<table><thead> -<tr> -<th>Field</th> -<th>Value</th> -<th>Description</th> -</tr> -</thead><tbody> -<tr> -<td>host</td> -<td>String</td> -<td>Nimbus' host name</td> -</tr> -<tr> -<td>port</td> -<td>int</td> -<td>Nimbus' port number</td> -</tr> -<tr> -<td>status</td> -<td>String</td> -<td>Possible values are Leader, Not a Leader, Dead</td> -</tr> -<tr> -<td>nimbusUpTime</td> -<td>String</td> -<td>Shows since how long the nimbus has been running</td> -</tr> -<tr> -<td>nimbusUpTimeSeconds</td> -<td>String</td> -<td>Shows since how long the nimbus has been running in seconds</td> -</tr> -<tr> -<td>nimbusLogLink</td> -<td>String</td> -<td>Logviewer url to view the nimbus.log</td> -</tr> -<tr> -<td>version</td> -<td>String</td> -<td>Version of storm this nimbus host is running</td> -</tr> -</tbody></table> - -<p>Sample response:</p> -<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> - </span><span class="s2">"nimbuses"</span><span class="p">:[</span><span class="w"> - </span><span class="p">{</span><span class="w"> - </span><span class="s2">"host"</span><span class="p">:</span><span class="s2">"192.168.202.1"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"port"</span><span class="p">:</span><span class="mi">6627</span><span class="p">,</span><span class="w"> - </span><span class="s2">"nimbusLogLink"</span><span class="p">:</span><span class="s2">"http:</span><span class="se">\/\/</span><span class="s2">192.168.202.1:8000</span><span class="se">\/</span><span class="s2">log?file=nimbus.log"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"status"</span><span class="p">:</span><span class="err">Leader</span><span class="p">,</span><span class="w"> - </span><span class="s2">"version"</span><span class="p">:</span><span class="s2">"0.10.0-SNAPSHOT"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"nimbusUpTime"</span><span class="p">:</span><span class="s2">"3m 33s"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"nimbusUpTimeSeconds"</span><span class="p">:</span><span class="s2">"213"</span><span class="w"> - </span><span class="p">}</span><span class="w"> - </span><span class="p">]</span><span class="w"> -</span><span class="p">}</span><span class="w"> -</span></code></pre></div> -<h3 id="api-v1-history-summary-get">/api/v1/history/summary (GET)</h3> - -<p>Returns a list of all running topologies' IDs submitted by the current user.</p> - -<p>Response fields:</p> - -<table><thead> -<tr> -<th>Field</th> -<th>Value</th> -<th>Description</th> -</tr> -</thead><tbody> -<tr> -<td>topo-history</td> -<td>List</td> -<td>List of Topologies' IDs</td> -</tr> -</tbody></table> - -<p>Sample response:</p> -<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> - </span><span class="s2">"topo-history"</span><span class="p">:[</span><span class="w"> - </span><span class="s2">"wc6-1-1446571009"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"wc8-2-1446587178"</span><span class="w"> - </span><span class="p">]</span><span class="w"> -</span><span class="p">}</span><span class="w"> -</span></code></pre></div> -<h3 id="api-v1-supervisor-get">/api/v1/supervisor (GET)</h3> - -<p>Returns summary for a supervisor by id, or all supervisors running on a host.</p> - -<p>Examples:</p> -<div class="highlight"><pre><code class="language-no-highlight" data-lang="no-highlight"> 1. By host: http://ui-daemon-host-name:8080/api/v1/supervisor?host=supervisor-daemon-host-name - 2. By id: http://ui-daemon-host-name:8080/api/v1/supervisor?id=f5449110-1daa-43e2-89e3-69917b16dec9-192.168.1.1 -</code></pre></div> -<p>Request parameters:</p> - -<table><thead> -<tr> -<th>Parameter</th> -<th>Value</th> -<th>Description</th> -</tr> -</thead><tbody> -<tr> -<td>id</td> -<td>String. Supervisor id</td> -<td>If specified, respond with the supervisor and worker stats with id. Note that when id is specified, the host argument is ignored.</td> -</tr> -<tr> -<td>host</td> -<td>String. Host name</td> -<td>If specified, respond with all supervisors and worker stats in the host (normally just one)</td> -</tr> -<tr> -<td>sys</td> -<td>String. Values 1 or 0. Default value 0</td> -<td>Controls including sys stats part of the response</td> -</tr> -</tbody></table> - -<p>Response fields:</p> - -<table><thead> -<tr> -<th>Field</th> -<th>Value</th> -<th>Description</th> -</tr> -</thead><tbody> -<tr> -<td>supervisors</td> -<td>Array</td> -<td>Array of supervisor summaries</td> -</tr> -<tr> -<td>workers</td> -<td>Array</td> -<td>Array of worker summaries</td> -</tr> -<tr> -<td>schedulerDisplayResource</td> -<td>Boolean</td> -<td>Whether to display scheduler resource information</td> -</tr> -</tbody></table> - -<p>Each supervisor is defined by:</p> - -<table><thead> -<tr> -<th>Field</th> -<th>Value</th> -<th>Description</th> -</tr> -</thead><tbody> -<tr> -<td>id</td> -<td>String</td> -<td>Supervisor's id</td> -</tr> -<tr> -<td>host</td> -<td>String</td> -<td>Supervisor's host name</td> -</tr> -<tr> -<td>uptime</td> -<td>String</td> -<td>Shows how long the supervisor is running</td> -</tr> -<tr> -<td>uptimeSeconds</td> -<td>Integer</td> -<td>Shows how long the supervisor is running in seconds</td> -</tr> -<tr> -<td>slotsTotal</td> -<td>Integer</td> -<td>Total number of worker slots for this supervisor</td> -</tr> -<tr> -<td>slotsUsed</td> -<td>Integer</td> -<td>Number of worker slots used on this supervisor</td> -</tr> -<tr> -<td>schedulerDisplayResource</td> -<td>Boolean</td> -<td>Whether to display scheduler resource information</td> -</tr> -<tr> -<td>totalMem</td> -<td>Double</td> -<td>Total memory capacity on this supervisor</td> -</tr> -<tr> -<td>totalCpu</td> -<td>Double</td> -<td>Total CPU capacity on this supervisor</td> -</tr> -<tr> -<td>usedMem</td> -<td>Double</td> -<td>Used memory capacity on this supervisor</td> -</tr> -<tr> -<td>usedCpu</td> -<td>Double</td> -<td>Used CPU capacity on this supervisor</td> -</tr> -</tbody></table> - -<p>Each worker is defined by:</p> - -<table><thead> -<tr> -<th>Field</th> -<th>Value</th> -<th>Description</th> -</tr> -</thead><tbody> -<tr> -<td>supervisorId</td> -<td>String</td> -<td>Supervisor's id</td> -</tr> -<tr> -<td>host</td> -<td>String</td> -<td>Worker's host name</td> -</tr> -<tr> -<td>port</td> -<td>Integer</td> -<td>Worker's port</td> -</tr> -<tr> -<td>topologyId</td> -<td>String</td> -<td>Topology Id</td> -</tr> -<tr> -<td>topologyName</td> -<td>String</td> -<td>Topology Name</td> -</tr> -<tr> -<td>executorsTotal</td> -<td>Integer</td> -<td>Number of executors used by the topology in this worker</td> -</tr> -<tr> -<td>assignedMemOnHeap</td> -<td>Double</td> -<td>Assigned On-Heap Memory by Scheduler (MB)</td> -</tr> -<tr> -<td>assignedMemOffHeap</td> -<td>Double</td> -<td>Assigned Off-Heap Memory by Scheduler (MB)</td> -</tr> -<tr> -<td>assignedCpu</td> -<td>Number</td> -<td>Assigned CPU by Scheduler (%)</td> -</tr> -<tr> -<td>componentNumTasks</td> -<td>Dictionary</td> -<td>Components -> # of executing tasks</td> -</tr> -<tr> -<td>uptime</td> -<td>String</td> -<td>Shows how long the worker is running</td> -</tr> -<tr> -<td>uptimeSeconds</td> -<td>Integer</td> -<td>Shows how long the worker is running in seconds</td> -</tr> -<tr> -<td>workerLogLink</td> -<td>String</td> -<td>Link to worker log viewer page</td> -</tr> -</tbody></table> - -<p>Sample response:</p> -<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> - </span><span class="s2">"supervisors"</span><span class="p">:</span><span class="w"> </span><span class="p">[{</span><span class="w"> - </span><span class="s2">"totalMem"</span><span class="p">:</span><span class="w"> </span><span class="mf">4096.0</span><span class="p">,</span><span class="w"> - </span><span class="s2">"host"</span><span class="p">:</span><span class="s2">"192.168.10.237"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"id"</span><span class="p">:</span><span class="s2">"bdfe8eff-f1d8-4bce-81f5-9d3ae1bf432e-169.254.129.212"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"uptime"</span><span class="p">:</span><span class="s2">"7m 8s"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"totalCpu"</span><span class="p">:</span><span class="mf">400.0</span><span class="p">,</span><span class="w"> - </span><span class="s2">"usedCpu"</span><span class="p">:</span><span class="mf">495.0</span><span class="p">,</span><span class="w"> - </span><span class="s2">"usedMem"</span><span class="p">:</span><span class="mf">3432.0</span><span class="p">,</span><span class="w"> - </span><span class="s2">"slotsUsed"</span><span class="p">:</span><span class="mi">2</span><span class="p">,</span><span class="w"> - </span><span class="s2">"version"</span><span class="p">:</span><span class="s2">"0.10.1"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"slotsTotal"</span><span class="p">:</span><span class="mi">4</span><span class="p">,</span><span class="w"> - </span><span class="s2">"uptimeSeconds"</span><span class="p">:</span><span class="mi">428</span><span class="w"> - </span><span class="p">}],</span><span class="w"> - </span><span class="s2">"schedulerDisplayResource"</span><span class="p">:</span><span class="kc">true</span><span class="p">,</span><span class="w"> - </span><span class="s2">"workers"</span><span class="p">:[{</span><span class="w"> - </span><span class="s2">"topologyName"</span><span class="p">:</span><span class="s2">"ras"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"topologyId"</span><span class="p">:</span><span class="s2">"ras-4-1460229987"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"host"</span><span class="p">:</span><span class="s2">"192.168.10.237"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"supervisorId"</span><span class="p">:</span><span class="s2">"bdfe8eff-f1d8-4bce-81f5-9d3ae1bf432e-169.254.129.212"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"assignedMemOnHeap"</span><span class="p">:</span><span class="mf">704.0</span><span class="p">,</span><span class="w"> - </span><span class="s2">"uptime"</span><span class="p">:</span><span class="s2">"2m 47s"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"uptimeSeconds"</span><span class="p">:</span><span class="mi">167</span><span class="p">,</span><span class="w"> - </span><span class="s2">"port"</span><span class="p">:</span><span class="mi">6707</span><span class="p">,</span><span class="w"> - </span><span class="s2">"workerLogLink"</span><span class="p">:</span><span class="s2">"http:</span><span class="se">\/\/</span><span class="s2">192.168.10.237:8000</span><span class="se">\/</span><span class="s2">log?file=ras-4-1460229987%2F6707%2Fworker.log"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"componentNumTasks"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> - </span><span class="s2">"word"</span><span class="p">:</span><span class="mi">5</span><span class="w"> - </span><span class="p">},</span><span class="w"> - </span><span class="s2">"executorsTotal"</span><span class="p">:</span><span class="mi">8</span><span class="p">,</span><span class="w"> - </span><span class="s2">"assignedCpu"</span><span class="p">:</span><span class="mf">130.0</span><span class="p">,</span><span class="w"> - </span><span class="s2">"assignedMemOffHeap"</span><span class="p">:</span><span class="mf">80.0</span><span class="w"> - </span><span class="p">},</span><span class="w"> - </span><span class="p">{</span><span class="w"> - </span><span class="s2">"topologyName"</span><span class="p">:</span><span class="s2">"ras"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"topologyId"</span><span class="p">:</span><span class="s2">"ras-4-1460229987"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"host"</span><span class="p">:</span><span class="s2">"192.168.10.237"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"supervisorId"</span><span class="p">:</span><span class="s2">"bdfe8eff-f1d8-4bce-81f5-9d3ae1bf432e-169.254.129.212"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"assignedMemOnHeap"</span><span class="p">:</span><span class="mf">904.0</span><span class="p">,</span><span class="w"> - </span><span class="s2">"uptime"</span><span class="p">:</span><span class="s2">"2m 53s"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"port"</span><span class="p">:</span><span class="mi">6706</span><span class="p">,</span><span class="w"> - </span><span class="s2">"workerLogLink"</span><span class="p">:</span><span class="s2">"http:</span><span class="se">\/\/</span><span class="s2">192.168.10.237:8000</span><span class="se">\/</span><span class="s2">log?file=ras-4-1460229987%2F6706%2Fworker.log"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"componentNumTasks"</span><span class="p">:{</span><span class="w"> - </span><span class="s2">"exclaim2"</span><span class="p">:</span><span class="mi">2</span><span class="p">,</span><span class="w"> - </span><span class="s2">"exclaim1"</span><span class="p">:</span><span class="mi">3</span><span class="p">,</span><span class="w"> - </span><span class="s2">"word"</span><span class="p">:</span><span class="mi">5</span><span class="w"> - </span><span class="p">},</span><span class="w"> - </span><span class="s2">"executorsTotal"</span><span class="p">:</span><span class="mi">10</span><span class="p">,</span><span class="w"> - </span><span class="s2">"uptimeSeconds"</span><span class="p">:</span><span class="mi">173</span><span class="p">,</span><span class="w"> - </span><span class="s2">"assignedCpu"</span><span class="p">:</span><span class="mf">165.0</span><span class="p">,</span><span class="w"> - </span><span class="s2">"assignedMemOffHeap"</span><span class="p">:</span><span class="mf">80.0</span><span class="w"> - </span><span class="p">}]</span><span class="w"> -</span><span class="p">}</span><span class="w"> -</span></code></pre></div> -<h3 id="api-v1-topology-summary-get">/api/v1/topology/summary (GET)</h3> - -<p>Returns summary information for all topologies.</p> - -<p>Response fields:</p> - -<table><thead> -<tr> -<th>Field</th> -<th>Value</th> -<th>Description</th> -</tr> -</thead><tbody> -<tr> -<td>id</td> -<td>String</td> -<td>Topology Id</td> -</tr> -<tr> -<td>name</td> -<td>String</td> -<td>Topology Name</td> -</tr> -<tr> -<td>status</td> -<td>String</td> -<td>Topology Status</td> -</tr> -<tr> -<td>uptime</td> -<td>String</td> -<td>Shows how long the topology is running</td> -</tr> -<tr> -<td>uptimeSeconds</td> -<td>Integer</td> -<td>Shows how long the topology is running in seconds</td> -</tr> -<tr> -<td>tasksTotal</td> -<td>Integer</td> -<td>Total number of tasks for this topology</td> -</tr> -<tr> -<td>workersTotal</td> -<td>Integer</td> -<td>Number of workers used for this topology</td> -</tr> -<tr> -<td>executorsTotal</td> -<td>Integer</td> -<td>Number of executors used for this topology</td> -</tr> -<tr> -<td>replicationCount</td> -<td>Integer</td> -<td>Number of nimbus hosts on which this topology code is replicated</td> -</tr> -<tr> -<td>requestedMemOnHeap</td> -<td>Double</td> -<td>Requested On-Heap Memory by User (MB)</td> -</tr> -<tr> -<td>requestedMemOffHeap</td> -<td>Double</td> -<td>Requested Off-Heap Memory by User (MB)</td> -</tr> -<tr> -<td>requestedTotalMem</td> -<td>Double</td> -<td>Requested Total Memory by User (MB)</td> -</tr> -<tr> -<td>requestedCpu</td> -<td>Double</td> -<td>Requested CPU by User (%)</td> -</tr> -<tr> -<td>assignedMemOnHeap</td> -<td>Double</td> -<td>Assigned On-Heap Memory by Scheduler (MB)</td> -</tr> -<tr> -<td>assignedMemOffHeap</td> -<td>Double</td> -<td>Assigned Off-Heap Memory by Scheduler (MB)</td> -</tr> -<tr> -<td>assignedTotalMem</td> -<td>Double</td> -<td>Assigned Total Memory by Scheduler (MB)</td> -</tr> -<tr> -<td>assignedCpu</td> -<td>Double</td> -<td>Assigned CPU by Scheduler (%)</td> -</tr> -<tr> -<td>schedulerDisplayResource</td> -<td>Boolean</td> -<td>Whether to display scheduler resource information</td> -</tr> -</tbody></table> - -<p>Sample response:</p> -<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> - </span><span class="s2">"topologies"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"> - </span><span class="p">{</span><span class="w"> - </span><span class="s2">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"WordCount3-1-1402960825"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"WordCount3"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ACTIVE"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"uptime"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6m 5s"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"uptimeSeconds"</span><span class="p">:</span><span class="w"> </span><span class="mi">365</span><span class="p">,</span><span class="w"> - </span><span class="s2">"tasksTotal"</span><span class="p">:</span><span class="w"> </span><span class="mi">28</span><span class="p">,</span><span class="w"> - </span><span class="s2">"workersTotal"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span><span class="w"> - </span><span class="s2">"executorsTotal"</span><span class="p">:</span><span class="w"> </span><span class="mi">28</span><span class="p">,</span><span class="w"> - </span><span class="s2">"replicationCount"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> - </span><span class="s2">"requestedMemOnHeap"</span><span class="p">:</span><span class="w"> </span><span class="mi">640</span><span class="p">,</span><span class="w"> - </span><span class="s2">"requestedMemOffHeap"</span><span class="p">:</span><span class="w"> </span><span class="mi">128</span><span class="p">,</span><span class="w"> - </span><span class="s2">"requestedTotalMem"</span><span class="p">:</span><span class="w"> </span><span class="mi">768</span><span class="p">,</span><span class="w"> - </span><span class="s2">"requestedCpu"</span><span class="p">:</span><span class="w"> </span><span class="mi">80</span><span class="p">,</span><span class="w"> - </span><span class="s2">"assignedMemOnHeap"</span><span class="p">:</span><span class="w"> </span><span class="mi">640</span><span class="p">,</span><span class="w"> - </span><span class="s2">"assignedMemOffHeap"</span><span class="p">:</span><span class="w"> </span><span class="mi">128</span><span class="p">,</span><span class="w"> - </span><span class="s2">"assignedTotalMem"</span><span class="p">:</span><span class="w"> </span><span class="mi">768</span><span class="p">,</span><span class="w"> - </span><span class="s2">"assignedCpu"</span><span class="p">:</span><span class="w"> </span><span class="mi">80</span><span class="w"> - </span><span class="p">}</span><span class="w"> - </span><span class="p">],</span><span class="w"> - </span><span class="s2">"schedulerDisplayResource"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"> -</span><span class="p">}</span><span class="w"> -</span></code></pre></div> -<h3 id="api-v1-topology-workers-id-get">/api/v1/topology-workers/:id (GET)</h3> - -<p>Returns the worker' information (host and port) for a topology.</p> - -<p>Response fields:</p> - -<table><thead> -<tr> -<th>Field</th> -<th>Value</th> -<th>Description</th> -</tr> -</thead><tbody> -<tr> -<td>hostPortList</td> -<td>List</td> -<td>Workers' information for a topology</td> -</tr> -<tr> -<td>name</td> -<td>Integer</td> -<td>Logviewer Port</td> -</tr> -</tbody></table> - -<p>Sample response:</p> -<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> - </span><span class="s2">"hostPortList"</span><span class="p">:[</span><span class="w"> - </span><span class="p">{</span><span class="w"> - </span><span class="s2">"host"</span><span class="p">:</span><span class="s2">"192.168.202.2"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"port"</span><span class="p">:</span><span class="mi">6701</span><span class="w"> - </span><span class="p">},</span><span class="w"> - </span><span class="p">{</span><span class="w"> - </span><span class="s2">"host"</span><span class="p">:</span><span class="s2">"192.168.202.2"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"port"</span><span class="p">:</span><span class="mi">6702</span><span class="w"> - </span><span class="p">},</span><span class="w"> - </span><span class="p">{</span><span class="w"> - </span><span class="s2">"host"</span><span class="p">:</span><span class="s2">"192.168.202.3"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"port"</span><span class="p">:</span><span class="mi">6700</span><span class="w"> - </span><span class="p">}</span><span class="w"> - </span><span class="p">],</span><span class="w"> - </span><span class="s2">"logviewerPort"</span><span class="p">:</span><span class="mi">8000</span><span class="w"> -</span><span class="p">}</span><span class="w"> -</span></code></pre></div> -<h3 id="api-v1-topology-id-get">/api/v1/topology/:id (GET)</h3> - -<p>Returns topology information and statistics. Substitute id with topology id.</p> - -<p>Request parameters:</p> - -<table><thead> -<tr> -<th>Parameter</th> -<th>Value</th> -<th>Description</th> -</tr> -</thead><tbody> -<tr> -<td>id</td> -<td>String (required)</td> -<td>Topology Id</td> -</tr> -<tr> -<td>window</td> -<td>String. Default value :all-time</td> -<td>Window duration for metrics in seconds</td> -</tr> -<tr> -<td>sys</td> -<td>String. Values 1 or 0. Default value 0</td> -<td>Controls including sys stats part of the response</td> -</tr> -</tbody></table> - -<p>Response fields:</p> - -<table><thead> -<tr> -<th>Field</th> -<th>Value</th> -<th>Description</th> -</tr> -</thead><tbody> -<tr> -<td>id</td> -<td>String</td> -<td>Topology Id</td> -</tr> -<tr> -<td>name</td> -<td>String</td> -<td>Topology Name</td> -</tr> -<tr> -<td>uptime</td> -<td>String</td> -<td>How long the topology has been running</td> -</tr> -<tr> -<td>uptimeSeconds</td> -<td>Integer</td> -<td>How long the topology has been running in seconds</td> -</tr> -<tr> -<td>status</td> -<td>String</td> -<td>Current status of the topology, e.g. "ACTIVE"</td> -</tr> -<tr> -<td>tasksTotal</td> -<td>Integer</td> -<td>Total number of tasks for this topology</td> -</tr> -<tr> -<td>workersTotal</td> -<td>Integer</td> -<td>Number of workers used for this topology</td> -</tr> -<tr> -<td>executorsTotal</td> -<td>Integer</td> -<td>Number of executors used for this topology</td> -</tr> -<tr> -<td>msgTimeout</td> -<td>Integer</td> -<td>Number of seconds a tuple has before the spout considers it failed</td> -</tr> -<tr> -<td>windowHint</td> -<td>String</td> -<td>window param value in "hh mm ss" format. Default value is "All Time"</td> -</tr> -<tr> -<td>schedulerDisplayResource</td> -<td>Boolean</td> -<td>Whether to display scheduler resource information</td> -</tr> -<tr> -<td>replicationCount</td> -<td>Integer</td> -<td>Number of nimbus hosts on which this topology code is replicated</td> -</tr> -<tr> -<td>debug</td> -<td>Boolean</td> -<td>If debug is enabled for the topology</td> -</tr> -<tr> -<td>samplingPct</td> -<td>Double</td> -<td>Controls downsampling of events before they are sent to event log (percentage)</td> -</tr> -<tr> -<td>assignedMemOnHeap</td> -<td>Double</td> -<td>Assigned On-Heap Memory by Scheduler (MB)</td> -</tr> -<tr> -<td>assignedMemOffHeap</td> -<td>Double</td> -<td>Assigned Off-Heap Memory by Scheduler (MB)</td> -</tr> -<tr> -<td>assignedTotalMem</td> -<td>Double</td> -<td>Assigned Off-Heap + On-Heap Memory by Scheduler(MB)</td> -</tr> -<tr> -<td>assignedCpu</td> -<td>Double</td> -<td>Assigned CPU by Scheduler(%)</td> -</tr> -<tr> -<td>requestedMemOnHeap</td> -<td>Double</td> -<td>Requested On-Heap Memory by User (MB)</td> -</tr> -<tr> -<td>requestedMemOffHeap</td> -<td>Double</td> -<td>Requested Off-Heap Memory by User (MB)</td> -</tr> -<tr> -<td>requestedCpu</td> -<td>Double</td> -<td>Requested CPU by User (%)</td> -</tr> -<tr> -<td>topologyStats</td> -<td>Array</td> -<td>Array of all the topology related stats per time window</td> -</tr> -<tr> -<td>topologyStats.windowPretty</td> -<td>String</td> -<td>Duration passed in HH:MM:SS format</td> -</tr> -<tr> -<td>topologyStats.window</td> -<td>String</td> -<td>User requested time window for metrics</td> -</tr> -<tr> -<td>topologyStats.emitted</td> -<td>Long</td> -<td>Number of messages emitted in given window</td> -</tr> -<tr> -<td>topologyStats.trasferred</td> -<td>Long</td> -<td>Number messages transferred in given window</td> -</tr> -<tr> -<td>topologyStats.completeLatency</td> -<td>String (double value returned in String format)</td> -<td>Total latency for processing the message</td> -</tr> -<tr> -<td>topologyStats.acked</td> -<td>Long</td> -<td>Number of messages acked in given window</td> -</tr> -<tr> -<td>topologyStats.failed</td> -<td>Long</td> -<td>Number of messages failed in given window</td> -</tr> -<tr> -<td>workers</td> -<td>Array</td> -<td>Array of workers in topology</td> -</tr> -<tr> -<td>workers.supervisorId</td> -<td>String</td> -<td>Supervisor's id</td> -</tr> -<tr> -<td>workers.host</td> -<td>String</td> -<td>Worker's host name</td> -</tr> -<tr> -<td>workers.port</td> -<td>Integer</td> -<td>Worker's port</td> -</tr> -<tr> -<td>workers.topologyId</td> -<td>String</td> -<td>Topology Id</td> -</tr> -<tr> -<td>workers.topologyName</td> -<td>String</td> -<td>Topology Name</td> -</tr> -<tr> -<td>workers.executorsTotal</td> -<td>Integer</td> -<td>Number of executors used by the topology in this worker</td> -</tr> -<tr> -<td>workers.assignedMemOnHeap</td> -<td>Double</td> -<td>Assigned On-Heap Memory by Scheduler (MB)</td> -</tr> -<tr> -<td>workers.assignedMemOffHeap</td> -<td>Double</td> -<td>Assigned Off-Heap Memory by Scheduler (MB)</td> -</tr> -<tr> -<td>workers.assignedCpu</td> -<td>Number</td> -<td>Assigned CPU by Scheduler (%)</td> -</tr> -<tr> -<td>workers.componentNumTasks</td> -<td>Dictionary</td> -<td>Components -> # of executing tasks</td> -</tr> -<tr> -<td>workers.uptime</td> -<td>String</td> -<td>Shows how long the worker is running</td> -</tr> -<tr> -<td>workers.uptimeSeconds</td> -<td>Integer</td> -<td>Shows how long the worker is running in seconds</td> -</tr> -<tr> -<td>workers.workerLogLink</td> -<td>String</td> -<td>Link to worker log viewer page</td> -</tr> -<tr> -<td>spouts</td> -<td>Array</td> -<td>Array of all the spout components in the topology</td> -</tr> -<tr> -<td>spouts.spoutId</td> -<td>String</td> -<td>Spout id</td> -</tr> -<tr> -<td>spouts.executors</td> -<td>Integer</td> -<td>Number of executors for the spout</td> -</tr> -<tr> -<td>spouts.emitted</td> -<td>Long</td> -<td>Number of messages emitted in given window</td> -</tr> -<tr> -<td>spouts.completeLatency</td> -<td>String (double value returned in String format)</td> -<td>Total latency for processing the message</td> -</tr> -<tr> -<td>spouts.transferred</td> -<td>Long</td> -<td>Total number of messages transferred in given window</td> -</tr> -<tr> -<td>spouts.tasks</td> -<td>Integer</td> -<td>Total number of tasks for the spout</td> -</tr> -<tr> -<td>spouts.lastError</td> -<td>String</td> -<td>Shows the last error happened in a spout</td> -</tr> -<tr> -<td>spouts.errorLapsedSecs</td> -<td>Integer</td> -<td>Number of seconds elapsed since that last error happened in a spout</td> -</tr> -<tr> -<td>spouts.errorWorkerLogLink</td> -<td>String</td> -<td>Link to the worker log that reported the exception</td> -</tr> -<tr> -<td>spouts.acked</td> -<td>Long</td> -<td>Number of messages acked</td> -</tr> -<tr> -<td>spouts.failed</td> -<td>Long</td> -<td>Number of messages failed</td> -</tr> -<tr> -<td>spouts.requestedMemOnHeap</td> -<td>Double</td> -<td>Requested On-Heap Memory by User (MB)</td> -</tr> -<tr> -<td>spouts.requestedMemOffHeap</td> -<td>Double</td> -<td>Requested Off-Heap Memory by User (MB)</td> -</tr> -<tr> -<td>spouts.requestedCpu</td> -<td>Double</td> -<td>Requested CPU by User (%)</td> -</tr> -<tr> -<td>bolts</td> -<td>Array</td> -<td>Array of bolt components in the topology</td> -</tr> -<tr> -<td>bolts.boltId</td> -<td>String</td> -<td>Bolt id</td> -</tr> -<tr> -<td>bolts.capacity</td> -<td>String (double value returned in String format)</td> -<td>This value indicates number of messages executed * average execute latency / time window</td> -</tr> -<tr> -<td>bolts.processLatency</td> -<td>String (double value returned in String format)</td> -<td>Average time of the bolt to ack a message after it was received</td> -</tr> -<tr> -<td>bolts.executeLatency</td> -<td>String (double value returned in String format)</td> -<td>Average time to run the execute method of the bolt</td> -</tr> -<tr> -<td>bolts.executors</td> -<td>Integer</td> -<td>Number of executor tasks in the bolt component</td> -</tr> -<tr> -<td>bolts.tasks</td> -<td>Integer</td> -<td>Number of instances of bolt</td> -</tr> -<tr> -<td>bolts.acked</td> -<td>Long</td> -<td>Number of tuples acked by the bolt</td> -</tr> -<tr> -<td>bolts.failed</td> -<td>Long</td> -<td>Number of tuples failed by the bolt</td> -</tr> -<tr> -<td>bolts.lastError</td> -<td>String</td> -<td>Shows the last error occurred in the bolt</td> -</tr> -<tr> -<td>bolts.errorLapsedSecs</td> -<td>Integer</td> -<td>Number of seconds elapsed since that last error happened in a bolt</td> -</tr> -<tr> -<td>bolts.errorWorkerLogLink</td> -<td>String</td> -<td>Link to the worker log that reported the exception</td> -</tr> -<tr> -<td>bolts.emitted</td> -<td>Long</td> -<td>Number of tuples emitted</td> -</tr> -<tr> -<td>bolts.requestedMemOnHeap</td> -<td>Double</td> -<td>Requested On-Heap Memory by User (MB)</td> -</tr> -<tr> -<td>bolts.requestedMemOffHeap</td> -<td>Double</td> -<td>Requested Off-Heap Memory by User (MB)</td> -</tr> -<tr> -<td>bolts.requestedCpu</td> -<td>Double</td> -<td>Requested CPU by User (%)</td> -</tr> -</tbody></table> - -<p>Examples:</p> -<div class="highlight"><pre><code class="language-no-highlight" data-lang="no-highlight"> 1. http://ui-daemon-host-name:8080/api/v1/topology/WordCount3-1-1402960825 - 2. http://ui-daemon-host-name:8080/api/v1/topology/WordCount3-1-1402960825?sys=1 - 3. http://ui-daemon-host-name:8080/api/v1/topology/WordCount3-1-1402960825?window=600 -</code></pre></div> -<p>Sample response:</p> -<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="w"> </span><span class="p">{</span><span class="w"> - </span><span class="s2">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"WordCount3"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"WordCount3-1-1402960825"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"workersTotal"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span><span class="w"> - </span><span class="s2">"window"</span><span class="p">:</span><span class="w"> </span><span class="s2">"600"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ACTIVE"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"tasksTotal"</span><span class="p">:</span><span class="w"> </span><span class="mi">28</span><span class="p">,</span><span class="w"> - </span><span class="s2">"executorsTotal"</span><span class="p">:</span><span class="w"> </span><span class="mi">28</span><span class="p">,</span><span class="w"> - </span><span class="s2">"uptime"</span><span class="p">:</span><span class="w"> </span><span class="s2">"29m 19s"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"uptimeSeconds"</span><span class="p">:</span><span class="w"> </span><span class="mi">1759</span><span class="p">,</span><span class="w"> - </span><span class="s2">"msgTimeout"</span><span class="p">:</span><span class="w"> </span><span class="mi">30</span><span class="p">,</span><span class="w"> - </span><span class="s2">"windowHint"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10m 0s"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"schedulerDisplayResource"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w"> - </span><span class="s2">"topologyStats"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"> - </span><span class="p">{</span><span class="w"> - </span><span class="s2">"windowPretty"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10m 0s"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"window"</span><span class="p">:</span><span class="w"> </span><span class="s2">"600"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"emitted"</span><span class="p">:</span><span class="w"> </span><span class="mi">397960</span><span class="p">,</span><span class="w"> - </span><span class="s2">"transferred"</span><span class="p">:</span><span class="w"> </span><span class="mi">213380</span><span class="p">,</span><span class="w"> - </span><span class="s2">"completeLatency"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.000"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"acked"</span><span class="p">:</span><span class="w"> </span><span class="mi">213460</span><span class="p">,</span><span class="w"> - </span><span class="s2">"failed"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w"> - </span><span class="p">},</span><span class="w"> - </span><span class="p">{</span><span class="w"> - </span><span class="s2">"windowPretty"</span><span class="p">:</span><span class="w"> </span><span class="s2">"3h 0m 0s"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"window"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10800"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"emitted"</span><span class="p">:</span><span class="w"> </span><span class="mi">1190260</span><span class="p">,</span><span class="w"> - </span><span class="s2">"transferred"</span><span class="p">:</span><span class="w"> </span><span class="mi">638260</span><span class="p">,</span><span class="w"> - </span><span class="s2">"completeLatency"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.000"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"acked"</span><span class="p">:</span><span class="w"> </span><span class="mi">638280</span><span class="p">,</span><span class="w"> - </span><span class="s2">"failed"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w"> - </span><span class="p">},</span><span class="w"> - </span><span class="p">{</span><span class="w"> - </span><span class="s2">"windowPretty"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1d 0h 0m 0s"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"window"</span><span class="p">:</span><span class="w"> </span><span class="s2">"86400"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"emitted"</span><span class="p">:</span><span class="w"> </span><span class="mi">1190260</span><span class="p">,</span><span class="w"> - </span><span class="s2">"transferred"</span><span class="p">:</span><span class="w"> </span><span class="mi">638260</span><span class="p">,</span><span class="w"> - </span><span class="s2">"completeLatency"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.000"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"acked"</span><span class="p">:</span><span class="w"> </span><span class="mi">638280</span><span class="p">,</span><span class="w"> - </span><span class="s2">"failed"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w"> - </span><span class="p">},</span><span class="w"> - </span><span class="p">{</span><span class="w"> - </span><span class="s2">"windowPretty"</span><span class="p">:</span><span class="w"> </span><span class="s2">"All time"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"window"</span><span class="p">:</span><span class="w"> </span><span class="s2">":all-time"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"emitted"</span><span class="p">:</span><span class="w"> </span><span class="mi">1190260</span><span class="p">,</span><span class="w"> - </span><span class="s2">"transferred"</span><span class="p">:</span><span class="w"> </span><span class="mi">638260</span><span class="p">,</span><span class="w"> - </span><span class="s2">"completeLatency"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.000"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"acked"</span><span class="p">:</span><span class="w"> </span><span class="mi">638280</span><span class="p">,</span><span class="w"> - </span><span class="s2">"failed"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w"> - </span><span class="p">}</span><span class="w"> - </span><span class="p">],</span><span class="w"> - </span><span class="s2">"workers"</span><span class="p">:[{</span><span class="w"> - </span><span class="s2">"topologyName"</span><span class="p">:</span><span class="s2">"WordCount3"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"topologyId"</span><span class="p">:</span><span class="s2">"WordCount3-1-1402960825"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"host"</span><span class="p">:</span><span class="s2">"192.168.10.237"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"supervisorId"</span><span class="p">:</span><span class="s2">"bdfe8eff-f1d8-4bce-81f5-9d3ae1bf432e-169.254.129.212"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"uptime"</span><span class="p">:</span><span class="s2">"2m 47s"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"uptimeSeconds"</span><span class="p">:</span><span class="mi">167</span><span class="p">,</span><span class="w"> - </span><span class="s2">"port"</span><span class="p">:</span><span class="mi">6707</span><span class="p">,</span><span class="w"> - </span><span class="s2">"workerLogLink"</span><span class="p">:</span><span class="s2">"http:</span><span class="se">\/\/</span><span class="s2">192.168.10.237:8000</span><span class="se">\/</span><span class="s2">log?file=WordCount3-1-1402960825%2F6707%2Fworker.log"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"componentNumTasks"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> - </span><span class="s2">"spout"</span><span class="p">:</span><span class="mi">5</span><span class="w"> - </span><span class="p">},</span><span class="w"> - </span><span class="s2">"executorsTotal"</span><span class="p">:</span><span class="mi">8</span><span class="p">,</span><span class="w"> - </span><span class="s2">"assignedMemOnHeap"</span><span class="p">:</span><span class="mf">704.0</span><span class="p">,</span><span class="w"> - </span><span class="s2">"assignedCpu"</span><span class="p">:</span><span class="mf">130.0</span><span class="p">,</span><span class="w"> - </span><span class="s2">"assignedMemOffHeap"</span><span class="p">:</span><span class="mf">80.0</span><span class="w"> - </span><span class="p">}],</span><span class="w"> - </span><span class="s2">"spouts"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"> - </span><span class="p">{</span><span class="w"> - </span><span class="s2">"executors"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span><span class="w"> - </span><span class="s2">"emitted"</span><span class="p">:</span><span class="w"> </span><span class="mi">28880</span><span class="p">,</span><span class="w"> - </span><span class="s2">"completeLatency"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.000"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"transferred"</span><span class="p">:</span><span class="w"> </span><span class="mi">28880</span><span class="p">,</span><span class="w"> - </span><span class="s2">"acked"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> - </span><span class="s2">"spoutId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"spout"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"tasks"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span><span class="w"> - </span><span class="s2">"lastError"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w"> - </span><span class="s2">"errorLapsedSecs"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w"> - </span><span class="s2">"failed"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w"> - </span><span class="p">}</span><span class="w"> - </span><span class="p">],</span><span class="w"> - </span><span class="s2">"bolts"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"> - </span><span class="p">{</span><span class="w"> - </span><span class="s2">"executors"</span><span class="p">:</span><span class="w"> </span><span class="mi">12</span><span class="p">,</span><span class="w"> - </span><span class="s2">"emitted"</span><span class="p">:</span><span class="w"> </span><span class="mi">184580</span><span class="p">,</span><span class="w"> - </span><span class="s2">"transferred"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> - </span><span class="s2">"acked"</span><span class="p">:</span><span class="w"> </span><span class="mi">184640</span><span class="p">,</span><span class="w"> - </span><span class="s2">"executeLatency"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.048"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"tasks"</span><span class="p">:</span><span class="w"> </span><span class="mi">12</span><span class="p">,</span><span class="w"> - </span><span class="s2">"executed"</span><span class="p">:</span><span class="w"> </span><span class="mi">184620</span><span class="p">,</span><span class="w"> - </span><span class="s2">"processLatency"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.043"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"boltId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"count"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"lastError"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w"> - </span><span class="s2">"errorLapsedSecs"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w"> - </span><span class="s2">"capacity"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.003"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"failed"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w"> - </span><span class="p">},</span><span class="w"> - </span><span class="p">{</span><span class="w"> - </span><span class="s2">"executors"</span><span class="p">:</span><span class="w"> </span><span class="mi">8</span><span class="p">,</span><span class="w"> - </span><span class="s2">"emitted"</span><span class="p">:</span><span class="w"> </span><span class="mi">184500</span><span class="p">,</span><span class="w"> - </span><span class="s2">"transferred"</span><span class="p">:</span><span class="w"> </span><span class="mi">184500</span><span class="p">,</span><span class="w"> - </span><span class="s2">"acked"</span><span class="p">:</span><span class="w"> </span><span class="mi">28820</span><span class="p">,</span><span class="w"> - </span><span class="s2">"executeLatency"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.024"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"tasks"</span><span class="p">:</span><span class="w"> </span><span class="mi">8</span><span class="p">,</span><span class="w"> - </span><span class="s2">"executed"</span><span class="p">:</span><span class="w"> </span><span class="mi">28780</span><span class="p">,</span><span class="w"> - </span><span class="s2">"processLatency"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2.112"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"boltId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"split"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"lastError"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w"> - </span><span class="s2">"errorLapsedSecs"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w"> - </span><span class="s2">"capacity"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.000"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"failed"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w"> - </span><span class="p">}</span><span class="w"> - </span><span class="p">],</span><span class="w"> - </span><span class="s2">"configuration"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> - </span><span class="s2">"storm.id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"WordCount3-1-1402960825"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"dev.zookeeper.path"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/tmp/dev-storm-zookeeper"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"topology.tick.tuple.freq.secs"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w"> - </span><span class="s2">"topology.builtin.metrics.bucket.size.secs"</span><span class="p">:</span><span class="w"> </span><span class="mi">60</span><span class="p">,</span><span class="w"> - </span><span class="s2">"topology.fall.back.on.java.serialization"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w"> - </span><span class="s2">"topology.max.error.report.per.interval"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span><span class="w"> - </span><span class="s2">"zmq.linger.millis"</span><span class="p">:</span><span class="w"> </span><span class="mi">5000</span><span class="p">,</span><span class="w"> - </span><span class="s2">"topology.skip.missing.kryo.registrations"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w"> - </span><span class="s2">"storm.messaging.netty.client_worker_threads"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> - </span><span class="s2">"ui.childopts"</span><span class="p">:</span><span class="w"> </span><span class="s2">"-Xmx768m"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"storm.zookeeper.session.timeout"</span><span class="p">:</span><span class="w"> </span><span class="mi">20000</span><span class="p">,</span><span class="w"> - </span><span class="s2">"nimbus.reassign"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w"> - </span><span class="s2">"topology.trident.batch.emit.interval.millis"</span><span class="p">:</span><span class="w"> </span><span class="mi">500</span><span class="p">,</span><span class="w"> - </span><span class="s2">"storm.messaging.netty.flush.check.interval.ms"</span><span class="p">:</span><span class="w"> </span><span class="mi">10</span><span class="p">,</span><span class="w"> - </span><span class="s2">"nimbus.monitor.freq.secs"</span><span class="p">:</span><span class="w"> </span><span class="mi">10</span><span class="p">,</span><span class="w"> - </span><span class="s2">"logviewer.childopts"</span><span class="p">:</span><span class="w"> </span><span class="s2">"-Xmx128m"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"java.library.path"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/usr/local/lib:/opt/local/lib:/usr/lib"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"topology.executor.send.buffer.size"</span><span class="p">:</span><span class="w"> </span><span class="mi">1024</span><span class="p">,</span><span class="w"> - </span><span class="s2">"storm.local.dir"</span><span class="p">:</span><span class="w"> </span><span class="s2">"storm-local"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"storm.messaging.netty.buffer_size"</span><span class="p">:</span><span class="w"> </span><span class="mi">5242880</span><span class="p">,</span><span class="w"> - </span><span class="s2">"supervisor.worker.start.timeout.secs"</span><span class="p">:</span><span class="w"> </span><span class="mi">120</span><span class="p">,</span><span class="w"> - </span><span class="s2">"topology.enable.message.timeouts"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w"> - </span><span class="s2">"nimbus.cleanup.inbox.freq.secs"</span><span class="p">:</span><span class="w"> </span><span class="mi">600</span><span class="p">,</span><span class="w"> - </span><span class="s2">"nimbus.inbox.jar.expiration.secs"</span><span class="p">:</span><span class="w"> </span><span class="mi">3600</span><span class="p">,</span><span class="w"> - </span><span class="s2">"drpc.worker.threads"</span><span class="p">:</span><span class="w"> </span><span class="mi">64</span><span class="p">,</span><span class="w"> - </span><span class="s2">"topology.worker.shared.thread.pool.size"</span><span class="p">:</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span><span class="w"> - </span><span class="s2">"nimbus.seeds"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"> - </span><span class="s2">"hw10843.local"</span><span class="w"> - </span><span class="p">],</span><span class="w"> - </span><span class="s2">"storm.messaging.netty.min_wait_ms"</span><span class="p">:</span><span class="w"> </span><span class="mi">100</span><span class="p">,</span><span class="w"> - </span><span class="s2">"storm.zookeeper.port"</span><span class="p">:</span><span class="w"> </span><span class="mi">2181</span><span class="p">,</span><span class="w"> - </span><span class="s2">"transactional.zookeeper.port"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w"> - </span><span class="s2">"topology.executor.receive.buffer.size"</span><span class="p">:</span><span class="w"> </span><span class="mi">1024</span><span class="p">,</span><span class="w"> - </span><span class="s2">"transactional.zookeeper.servers"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w"> - </span><span class="s2">"storm.zookeeper.root"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/storm"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"storm.zookeeper.retry.intervalceiling.millis"</span><span class="p">:</span><span class="w"> </span><span class="mi">30000</span><span class="p">,</span><span class="w"> - </span><span class="s2">"supervisor.enable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w"> - </span><span class="s2">"storm.messaging.netty.server_worker_threads"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="w"> - </span><span class="p">},</span><span class="w"> - </span><span class="s2">"replicationCount"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="w"> -</span><span class="p">}</span><span class="w"> -</span></code></pre></div> -<h3 id="api-v1-topology-id-metrics">/api/v1/topology/:id/metrics</h3> - -<p>Returns detailed metrics for topology. It shows metrics per component, which are aggregated by stream.</p> - -<table><thead> -<tr> -<th>Parameter</th> -<th>Value</th> -<th>Description</th> -</tr> -</thead><tbody> -<tr> -<td>id</td> -<td>String (required)</td> -<td>Topology Id</td> -</tr> -<tr> -<td>window</td> -<td>String. Default value :all-time</td> -<td>window duration for metrics in seconds</td> -</tr> -<tr> -<td>sys</td> -<td>String. Values 1 or 0. Default value 0</td> -<td>Controls including sys stats part of the response</td> -</tr> -</tbody></table> - -<p>Response fields:</p> - -<table><thead> -<tr> -<th>Field</th> -<th>Value</th> -<th>Description</th> -</tr> -</thead><tbody> -<tr> -<td>window</td> -<td>String. Default value ":all-time"</td> -<td>window duration for metrics in seconds</td> -</tr> -<tr> -<td></td> -<td>windowHint</td> -<td>String</td> -</tr> -<tr> -<td>spouts</td> -<td>Array</td> -<td>Array of all the spout components in the topology</td> -</tr> -<tr> -<td>spouts.id</td> -<td>String</td> -<td>Spout id</td> -</tr> -<tr> -<td>spouts.emitted</td> -<td>Array</td> -<td>Array of all the output streams this spout emits messages</td> -</tr> -<tr> -<td>spouts.emitted.stream_id</td> -<td>String</td> -<td>Stream id for this stream</td> -</tr> -<tr> -<td>spouts.emitted.value</td> -<td>Long</td> -<td>Number of messages emitted in given window</td> -</tr> -<tr> -<td>spouts.transferred</td> -<td>Array</td> -<td>Array of all the output streams this spout transfers messages</td> -</tr> -<tr> -<td>spouts.transferred.stream_id</td> -<td>String</td> -<td>Stream id for this stream</td> -</tr> -<tr> -<td>spouts.transferred.value</td> -<td>Long</td> -<td>Number messages transferred in given window</td> -</tr> -<tr> -<td>spouts.acked</td> -<td>Array</td> -<td>Array of all the output streams this spout receives ack of messages</td> -</tr> -<tr> -<td>spouts.acked.stream_id</td> -<td>String</td> -<td>Stream id for this stream</td> -</tr> -<tr> -<td>spouts.acked.value</td> -<td>Long</td> -<td>Number of messages acked in given window</td> -</tr> -<tr> -<td>spouts.failed</td> -<td>Array</td> -<td>Array of all the output streams this spout receives fail of messages</td> -</tr> -<tr> -<td>spouts.failed.stream_id</td> -<td>String</td> -<td>Stream id for this stream</td> -</tr> -<tr> -<td>spouts.failed.value</td> -<td>Long</td> -<td>Number of messages failed in given window</td> -</tr> -<tr> -<td>spouts.complete_ms_avg</td> -<td>Array</td> -<td>Array of all the output streams this spout receives ack of messages</td> -</tr> -<tr> -<td>spouts.complete_ms_avg.stream_id</td> -<td>String</td> -<td>Stream id for this stream</td> -</tr> -<tr> -<td>spouts.complete_ms_avg.value</td> -<td>String (double value returned in String format)</td> -<td>Total latency for processing the message</td> -</tr> -<tr> -<td>bolts</td> -<td>Array</td> -<td>Array of all the bolt components in the topology</td> -</tr> -<tr> -<td>bolts.id</td> -<td>String</td> -<td>Bolt id</td> -</tr> -<tr> -<td>bolts.emitted</td> -<td>Array</td> -<td>Array of all the output streams this bolt emits messages</td> -</tr> -<tr> -<td>bolts.emitted.stream_id</td> -<td>String</td> -<td>Stream id for this stream</td> -</tr> -<tr> -<td>bolts.emitted.value</td> -<td>Long</td> -<td>Number of messages emitted in given window</td> -</tr> -<tr> -<td>bolts.transferred</td> -<td>Array</td> -<td>Array of all the output streams this bolt transfers messages</td> -</tr> -<tr> -<td>bolts.transferred.stream_id</td> -<td>String</td> -<td>Stream id for this stream</td> -</tr> -<tr> -<td>bolts.transferred.value</td> -<td>Long</td> -<td>Number messages transferred in given window</td> -</tr> -<tr> -<td>bolts.acked</td> -<td>Array</td> -<td>Array of all the input streams this bolt acknowledges of messages</td> -</tr> -<tr> -<td>bolts.acked.component_id</td> -<td>String</td> -<td>Component id for this stream</td> -</tr> -<tr> -<td>bolts.acked.stream_id</td> -<td>String</td> -<td>Stream id for this stream</td> -</tr> -<tr> -<td>bolts.acked.value</td> -<td>Long</td> -<td>Number of messages acked in given window</td> -</tr> -<tr> -<td>bolts.failed</td> -<td>Array</td> -<td>Array of all the input streams this bolt receives fail of messages</td> -</tr> -<tr> -<td>bolts.failed.component_id</td> -<td>String</td> -<td>Component id for this stream</td> -</tr> -<tr> -<td>bolts.failed.stream_id</td> -<td>String</td> -<td>Stream id for this stream</td> -</tr> -<tr> -<td>bolts.failed.value</td> -<td>Long</td> -<td>Number of messages failed in given window</td> -</tr> -<tr> -<td>bolts.process_ms_avg</td> -<td>Array</td> -<td>Array of all the input streams this spout acks messages</td> -</tr> -<tr> -<td>bolts.process_ms_avg.component_id</td> -<td>String</td> -<td>Component id for this stream</td> -</tr> -<tr> -<td>bolts.process_ms_avg.stream_id</td> -<td>String</td> -<td>Stream id for this stream</td> -</tr> -<tr> -<td>bolts.process_ms_avg.value</td> -<td>String (double value returned in String format)</td> -<td>Average time of the bolt to ack a message after it was received</td> -</tr> -<tr> -<td>bolts.executed</td> -<td>Array</td> -<td>Array of all the input streams this bolt executes messages</td> -</tr> -<tr> -<td>bolts.executed.component_id</td> -<td>String</td> -<td>Component id for this stream</td> -</tr> -<tr> -<td>bolts.executed.stream_id</td> -<td>String</td> -<td>Stream id for this stream</td> -</tr> -<tr> -<td>bolts.executed.value</td> -<td>Long</td> -<td>Number of messages executed in given window</td> -</tr> -<tr> -<td>bolts.executed_ms_avg</td> -<td>Array</td> -<td>Array of all the output streams this spout receives ack of messages</td> -</tr> -<tr> -<td>bolts.executed_ms_avg.component_id</td> -<td>String</td> -<td>Component id for this stream</td> -</tr> -<tr> -<td>bolts.executed_ms_avg.stream_id</td> -<td>String</td> -<td>Stream id for this stream</td> -</tr> -<tr> -<td>bolts.executed_ms_avg.value</td> -<td>String (double value returned in String format)</td> -<td>Average time to run the execute method of the bolt</td> -</tr> -</tbody></table> - -<p>Examples:</p> -<div class="highlight"><pre><code class="language-no-highlight" data-lang="no-highlight">1. http://ui-daemon-host-name:8080/api/v1/topology/WordCount3-1-1402960825/metrics -1. http://ui-daemon-host-name:8080/api/v1/topology/WordCount3-1-1402960825/metrics?sys=1 -2. http://ui-daemon-host-name:8080/api/v1/topology/WordCount3-1-1402960825/metrics?window=600 -</code></pre></div> -<p>Sample response:</p> -<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> - </span><span class="s2">"window"</span><span class="p">:</span><span class="s2">":all-time"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"window-hint"</span><span class="p">:</span><span class="s2">"All time"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"spouts"</span><span class="p">:[</span><span class="w"> - </span><span class="p">{</span><span class="w"> - </span><span class="s2">"id"</span><span class="p">:</span><span class="s2">"spout"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"emitted"</span><span class="p">:[</span><span class="w"> - </span><span class="p">{</span><span class="w"> - </span><span class="s2">"stream_id"</span><span class="p">:</span><span class="s2">"__metrics"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"value"</span><span class="p">:</span><span class="mi">20</span><span class="w"> - </span><span class="p">},</span><span class="w"> - </span><span class="p">{</span><span class="w"> - </span><span class="s2">"stream_id"</span><span class="p">:</span><span class="s2">"default"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"value"</span><span class="p">:</span><span class="mi">17350280</span><span class="w"> - </span><span class="p">},</span><span class="w"> - </span><span class="p">{</span><span class="w"> - </span><span class="s2">"stream_id"</span><span class="p">:</span><span class="s2">"__ack_init"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"value"</span><span class="p">:</span><span class="mi">17328160</span><span class="w"> - </span><span class="p">},</span><span class="w"> - </span><span class="p">{</span><span class="w"> - </span><span class="s2">"stream_id"</span><span class="p">:</span><span class="s2">"__system"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"value"</span><span class="p">:</span><span class="mi">20</span><span class="w"> - </span><span class="p">}</span><span class="w"> - </span><span class="p">],</span><span class="w"> - </span><span class="s2">"transferred"</span><span class="p">:[</span><span class="w"> - </span><span class="p">{</span><span class="w"> - </span><span class="s2">"stream_id"</span><span class="p">:</span><span class="s2">"__metrics"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"value"</span><span class="p">:</span><span class="mi">20</span><span class="w"> - </span><span class="p">},</span><span class="w"> - </span><span class="p">{</span><span class="w"> - </span><span class="s2">"stream_id"</span><span class="p">:</span><span class="s2">"default"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"value"</span><span class="p">:</span><span class="mi">17350280</span><span class="w"> - </span><span class="p">},</span><span class="w"> - </span><span class="p">{</span><span class="w"> - </span><span class="s2">"stream_id"</span><span class="p">:</span><span class="s2">"__ack_init"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"value"</span><span class="p">:</span><span class="mi">17328160</span><span class="w"> - </span><span class="p">},</span><span class="w"> - </span><span class="p">{</span><span class="w"> - </span><span class="s2">"stream_id"</span><span class="p">:</span><span class="s2">"__system"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"value"</span><span class="p">:</span><span class="mi">0</span><span class="w"> - </span><span class="p">}</span><span class="w"> - </span><span class="p">],</span><span class="w"> - </span><span class="s2">"acked"</span><span class="p">:[</span><span class="w"> - </span><span class="p">{</span><span class="w"> - </span><span class="s2">"stream_id"</span><span class="p">:</span><span class="s2">"default"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"value"</span><span class="p">:</span><span class="mi">17339180</span><span class="w"> - </span><span class="p">}</span><span class="w"> - </span><span class="p">],</span><span class="w"> - </span><span class="s2">"failed"</span><span class="p">:[</span><span class="w"> - - </span><span class="p">],</span><span class="w"> - </span><span class="s2">"complete_ms_avg"</span><span class="p">:[</span><span class="w"> - </span><span class="p">{</span><span class="w"> - </span><span class="s2">"stream_id"</span><span class="p">:</span><span class="s2">"default"</span><span class="p">,</span><span class="w"> - </span><span class="s2">"value"</span><span class="p">:</span><span class="s2">"920.497"</span><span class="w"> - </span><span class="p">}</span><span class="w"> - </span><span class="
<TRUNCATED>
