| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>SystemConfigKey (Heron Java API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2023-03-01"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.6.0.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SystemConfigKey (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":9,"i2":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#enum.constant.summary">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#enum.constant.detail">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.heron.common.config</a></div> |
| <h2 title="Enum SystemConfigKey" class="title">Enum SystemConfigKey</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>java.lang.Enum<<a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.heron.common.config.SystemConfigKey</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>java.io.Serializable</code>, <code>java.lang.Comparable<<a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a>></code></dd> |
| </dl> |
| <hr> |
| <pre>public enum <span class="typeNameLabel">SystemConfigKey</span> |
| extends java.lang.Enum<<a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a>></pre> |
| <div class="block">Keys to be used in the SystemConfigs</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SystemConfigKey.Type.html" title="enum in org.apache.heron.common.config">SystemConfigKey.Type</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- =========== ENUM CONSTANT SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="enum.constant.summary"> |
| <!-- --> |
| </a> |
| <h3>Enum Constant Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum Constant</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#HERON_LOGGING_DIRECTORY">HERON_LOGGING_DIRECTORY</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The relative path to the logging directory</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#HERON_LOGGING_ERR_THRESHOLD">HERON_LOGGING_ERR_THRESHOLD</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The threshold level to log error</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#HERON_LOGGING_MAXIMUM_FILES">HERON_LOGGING_MAXIMUM_FILES</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The maximum number of log files</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#HERON_LOGGING_MAXIMUM_SIZE_MB">HERON_LOGGING_MAXIMUM_SIZE_MB</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The maximum log file size in MB</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#HERON_METRICS_EXPORT_INTERVAL">HERON_METRICS_EXPORT_INTERVAL</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The interval in seconds to get and reset the system metrics.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#HERON_METRICS_MAX_EXCEPTIONS_PER_MESSAGE_COUNT">HERON_METRICS_MAX_EXCEPTIONS_PER_MESSAGE_COUNT</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The maximum number of exceptions in one MetricPublisherPublishMessage protobuf</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_ACK_BATCH_TIME">INSTANCE_ACK_BATCH_TIME</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The maximum time in ms for an spout to do acknowledgement per attempt</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_ACKNOWLEDGEMENT_NBUCKETS">INSTANCE_ACKNOWLEDGEMENT_NBUCKETS</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The lookForTimeout Interval in spout instance will be timeoutInSeconds / NBUCKETS |
| For instance, if a tuple's timeout is 30s, and NBUCKETS is 10 |
| The spout instance will check whether there are timeout tuples every 3 seconds</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_EMIT_BATCH_SIZE">INSTANCE_EMIT_BATCH_SIZE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The maximum batch size in bytes for an spout instance to emit tuples per attempt</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_EMIT_BATCH_TIME">INSTANCE_EMIT_BATCH_TIME</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The maximum time in ms for an spout instance to emit tuples per attempt</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_EXECUTE_BATCH_SIZE">INSTANCE_EXECUTE_BATCH_SIZE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The maximum batch size in bytes for an bolt instance to execute tuples per attempt</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_EXECUTE_BATCH_TIME">INSTANCE_EXECUTE_BATCH_TIME</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The maximum time in ms for an bolt instance to execute tuples per attempt</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_FORCE_EXIT_TIMEOUT">INSTANCE_FORCE_EXIT_TIMEOUT</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The time to wait before the instance exits forcibly when uncaught exception happens</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_INTERNAL_BOLT_READ_QUEUE_CAPACITY">INSTANCE_INTERNAL_BOLT_READ_QUEUE_CAPACITY</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The queue capacity (num of items) in bolt for buffer packets to read from stream manager</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_INTERNAL_BOLT_WRITE_QUEUE_CAPACITY">INSTANCE_INTERNAL_BOLT_WRITE_QUEUE_CAPACITY</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The queue capacity (num of items) in bolt for buffer packets to write to stream manager</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_INTERNAL_METRICS_WRITE_QUEUE_CAPACITY">INSTANCE_INTERNAL_METRICS_WRITE_QUEUE_CAPACITY</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The queue capacity (num of items) for metrics packets to write to metrics manager</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_INTERNAL_SPOUT_READ_QUEUE_CAPACITY">INSTANCE_INTERNAL_SPOUT_READ_QUEUE_CAPACITY</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The queue capacity (num of items) in spout for buffer packets to read from stream manager</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_INTERNAL_SPOUT_WRITE_QUEUE_CAPACITY">INSTANCE_INTERNAL_SPOUT_WRITE_QUEUE_CAPACITY</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The queue capacity (num of items) in spout for buffer packets to write to stream manager</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_METRICS_SYSTEM_SAMPLE_INTERVAL">INSTANCE_METRICS_SYSTEM_SAMPLE_INTERVAL</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The interval in seconds to sample a system metric, for instance, JVM used memory.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_NETWORK_OPTIONS_MAXIMUM_PACKETSIZE_BYTES">INSTANCE_NETWORK_OPTIONS_MAXIMUM_PACKETSIZE_BYTES</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The maximum size of heron packet that's allowed by the instance</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_NETWORK_OPTIONS_SOCKET_RECEIVED_BUFFER_SIZE">INSTANCE_NETWORK_OPTIONS_SOCKET_RECEIVED_BUFFER_SIZE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block"># The maximum socket's received buffer size in bytes of instance's network options</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_NETWORK_OPTIONS_SOCKET_SEND_BUFFER_SIZE">INSTANCE_NETWORK_OPTIONS_SOCKET_SEND_BUFFER_SIZE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The maximum socket's send buffer size in bytes</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_NETWORK_READ_BATCH_SIZE">INSTANCE_NETWORK_READ_BATCH_SIZE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Size based,the maximum batch size in bytes to read from stream manager</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_NETWORK_READ_BATCH_TIME">INSTANCE_NETWORK_READ_BATCH_TIME</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Time based, the maximum batch time in ms for instance to read from stream manager per attempt</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_NETWORK_WRITE_BATCH_SIZE">INSTANCE_NETWORK_WRITE_BATCH_SIZE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Size based, the maximum batch size in bytes to write to stream manager</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_NETWORK_WRITE_BATCH_TIME">INSTANCE_NETWORK_WRITE_BATCH_TIME</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Time based, the maximum batch time in ms for instance to read from stream manager per attempt</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_RECONNECT_METRICSMGR_INTERVAL">INSTANCE_RECONNECT_METRICSMGR_INTERVAL</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Interval in seconds to reconnect to the metrics manager</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_RECONNECT_STREAMMGR_INTERVAL">INSTANCE_RECONNECT_STREAMMGR_INTERVAL</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Interval in seconds to reconnect to the stream manager</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_SET_CONTROL_TUPLE_CAPACITY">INSTANCE_SET_CONTROL_TUPLE_CAPACITY</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The maximum # of control tuple to batch in a HeronControlTupleSet protobuf</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_SET_DATA_TUPLE_CAPACITY">INSTANCE_SET_DATA_TUPLE_CAPACITY</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The maximum # of data tuple to batch in a HeronDataTupleSet protobuf</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_SET_DATA_TUPLE_SIZE">INSTANCE_SET_DATA_TUPLE_SIZE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The maximum size in bytes of data tuple to batch in a HeronDataTupleSet protobuf</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_TUNING_CURRENT_SAMPLE_WEIGHT">INSTANCE_TUNING_CURRENT_SAMPLE_WEIGHT</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">During dynamically tuning, the weight of new sample size to calculate |
| the available capacity of queue.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_TUNING_EXPECTED_BOLT_READ_QUEUE_SIZE">INSTANCE_TUNING_EXPECTED_BOLT_READ_QUEUE_SIZE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The expected size on read queue in bolt</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_TUNING_EXPECTED_BOLT_WRITE_QUEUE_SIZE">INSTANCE_TUNING_EXPECTED_BOLT_WRITE_QUEUE_SIZE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The expected size on write queue in bolt</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_TUNING_EXPECTED_METRICS_WRITE_QUEUE_SIZE">INSTANCE_TUNING_EXPECTED_METRICS_WRITE_QUEUE_SIZE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The expected size on metrics write queue</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_TUNING_EXPECTED_SPOUT_READ_QUEUE_SIZE">INSTANCE_TUNING_EXPECTED_SPOUT_READ_QUEUE_SIZE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The expected size on read queue in spout</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_TUNING_EXPECTED_SPOUT_WRITE_QUEUE_SIZE">INSTANCE_TUNING_EXPECTED_SPOUT_WRITE_QUEUE_SIZE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The exepected size on write queue in spout</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE_TUNING_INTERVAL">INSTANCE_TUNING_INTERVAL</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Interval in ms to tune the size of in & out data queue in instance</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#METRICSMGR_NETWORK_OPTIONS_MAXIMUM_PACKETSIZE_BYTES">METRICSMGR_NETWORK_OPTIONS_MAXIMUM_PACKETSIZE_BYTES</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The maximum size of heron packet that's allowed by the instance</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#METRICSMGR_NETWORK_OPTIONS_SOCKET_RECEIVED_BUFFER_SIZE">METRICSMGR_NETWORK_OPTIONS_SOCKET_RECEIVED_BUFFER_SIZE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The maximum socket's received buffer size in bytes</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#METRICSMGR_NETWORK_OPTIONS_SOCKET_SEND_BUFFER_SIZE">METRICSMGR_NETWORK_OPTIONS_SOCKET_SEND_BUFFER_SIZE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The maximum socket's send buffer size in bytes</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#METRICSMGR_NETWORK_READ_BATCH_SIZE">METRICSMGR_NETWORK_READ_BATCH_SIZE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Size based,the maximum batch size in bytes to read from socket</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#METRICSMGR_NETWORK_READ_BATCH_TIME">METRICSMGR_NETWORK_READ_BATCH_TIME</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The size of packets read from socket will be determined by the minimal of: |
| (a) time based (b) size based</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#METRICSMGR_NETWORK_WRITE_BATCH_SIZE">METRICSMGR_NETWORK_WRITE_BATCH_SIZE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Size based, the maximum batch size in bytes to write to socket</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#METRICSMGR_NETWORK_WRITE_BATCH_TIME">METRICSMGR_NETWORK_WRITE_BATCH_TIME</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The size of packets written to socket will be determined by the minimal of |
| (a) time based (b) size based</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#TMANAGER_METRICS_COLLECTOR_MAXIMUM_EXCEPTION">TMANAGER_METRICS_COLLECTOR_MAXIMUM_EXCEPTION</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The maximum exception count be kept in tmanager</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#TMANAGER_METRICS_COLLECTOR_MAXIMUM_INTERVAL">TMANAGER_METRICS_COLLECTOR_MAXIMUM_INTERVAL</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The maximum interval in minutes of metrics to be kept in tmanager</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#TMANAGER_METRICS_COLLECTOR_PURGE_INTERVAL">TMANAGER_METRICS_COLLECTOR_PURGE_INTERVAL</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The interval for tmanager to purge metrics from socket</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDefaultString()">getDefaultString</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#valueOf(java.lang.String)">valueOf</a></span>​(java.lang.String name)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the enum constant of this type with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#values()">values</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Enum"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Enum</h3> |
| <code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>getClass, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ ENUM CONSTANT DETAIL =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="enum.constant.detail"> |
| <!-- --> |
| </a> |
| <h3>Enum Constant Detail</h3> |
| <a id="HERON_LOGGING_DIRECTORY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HERON_LOGGING_DIRECTORY</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> HERON_LOGGING_DIRECTORY</pre> |
| <div class="block">The relative path to the logging directory</div> |
| </li> |
| </ul> |
| <a id="HERON_LOGGING_MAXIMUM_SIZE_MB"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HERON_LOGGING_MAXIMUM_SIZE_MB</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> HERON_LOGGING_MAXIMUM_SIZE_MB</pre> |
| <div class="block">The maximum log file size in MB</div> |
| </li> |
| </ul> |
| <a id="HERON_LOGGING_MAXIMUM_FILES"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HERON_LOGGING_MAXIMUM_FILES</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> HERON_LOGGING_MAXIMUM_FILES</pre> |
| <div class="block">The maximum number of log files</div> |
| </li> |
| </ul> |
| <a id="HERON_LOGGING_ERR_THRESHOLD"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HERON_LOGGING_ERR_THRESHOLD</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> HERON_LOGGING_ERR_THRESHOLD</pre> |
| <div class="block">The threshold level to log error</div> |
| </li> |
| </ul> |
| <a id="HERON_METRICS_EXPORT_INTERVAL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HERON_METRICS_EXPORT_INTERVAL</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> HERON_METRICS_EXPORT_INTERVAL</pre> |
| <div class="block">The interval in seconds to get and reset the system metrics. |
| The metrics collected will be sent to metrics manager</div> |
| </li> |
| </ul> |
| <a id="HERON_METRICS_MAX_EXCEPTIONS_PER_MESSAGE_COUNT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HERON_METRICS_MAX_EXCEPTIONS_PER_MESSAGE_COUNT</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> HERON_METRICS_MAX_EXCEPTIONS_PER_MESSAGE_COUNT</pre> |
| <div class="block">The maximum number of exceptions in one MetricPublisherPublishMessage protobuf</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_NETWORK_OPTIONS_MAXIMUM_PACKETSIZE_BYTES"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_NETWORK_OPTIONS_MAXIMUM_PACKETSIZE_BYTES</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_NETWORK_OPTIONS_MAXIMUM_PACKETSIZE_BYTES</pre> |
| <div class="block">The maximum size of heron packet that's allowed by the instance</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_INTERNAL_BOLT_READ_QUEUE_CAPACITY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_INTERNAL_BOLT_READ_QUEUE_CAPACITY</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_INTERNAL_BOLT_READ_QUEUE_CAPACITY</pre> |
| <div class="block">The queue capacity (num of items) in bolt for buffer packets to read from stream manager</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_INTERNAL_BOLT_WRITE_QUEUE_CAPACITY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_INTERNAL_BOLT_WRITE_QUEUE_CAPACITY</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_INTERNAL_BOLT_WRITE_QUEUE_CAPACITY</pre> |
| <div class="block">The queue capacity (num of items) in bolt for buffer packets to write to stream manager</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_INTERNAL_SPOUT_READ_QUEUE_CAPACITY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_INTERNAL_SPOUT_READ_QUEUE_CAPACITY</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_INTERNAL_SPOUT_READ_QUEUE_CAPACITY</pre> |
| <div class="block">The queue capacity (num of items) in spout for buffer packets to read from stream manager</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_INTERNAL_SPOUT_WRITE_QUEUE_CAPACITY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_INTERNAL_SPOUT_WRITE_QUEUE_CAPACITY</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_INTERNAL_SPOUT_WRITE_QUEUE_CAPACITY</pre> |
| <div class="block">The queue capacity (num of items) in spout for buffer packets to write to stream manager</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_INTERNAL_METRICS_WRITE_QUEUE_CAPACITY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_INTERNAL_METRICS_WRITE_QUEUE_CAPACITY</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_INTERNAL_METRICS_WRITE_QUEUE_CAPACITY</pre> |
| <div class="block">The queue capacity (num of items) for metrics packets to write to metrics manager</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_NETWORK_READ_BATCH_TIME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_NETWORK_READ_BATCH_TIME</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_NETWORK_READ_BATCH_TIME</pre> |
| <div class="block">Time based, the maximum batch time in ms for instance to read from stream manager per attempt</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_NETWORK_READ_BATCH_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_NETWORK_READ_BATCH_SIZE</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_NETWORK_READ_BATCH_SIZE</pre> |
| <div class="block">Size based,the maximum batch size in bytes to read from stream manager</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_NETWORK_WRITE_BATCH_TIME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_NETWORK_WRITE_BATCH_TIME</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_NETWORK_WRITE_BATCH_TIME</pre> |
| <div class="block">Time based, the maximum batch time in ms for instance to read from stream manager per attempt</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_NETWORK_WRITE_BATCH_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_NETWORK_WRITE_BATCH_SIZE</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_NETWORK_WRITE_BATCH_SIZE</pre> |
| <div class="block">Size based, the maximum batch size in bytes to write to stream manager</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_NETWORK_OPTIONS_SOCKET_RECEIVED_BUFFER_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_NETWORK_OPTIONS_SOCKET_RECEIVED_BUFFER_SIZE</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_NETWORK_OPTIONS_SOCKET_RECEIVED_BUFFER_SIZE</pre> |
| <div class="block"># The maximum socket's received buffer size in bytes of instance's network options</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_NETWORK_OPTIONS_SOCKET_SEND_BUFFER_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_NETWORK_OPTIONS_SOCKET_SEND_BUFFER_SIZE</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_NETWORK_OPTIONS_SOCKET_SEND_BUFFER_SIZE</pre> |
| <div class="block">The maximum socket's send buffer size in bytes</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_SET_DATA_TUPLE_CAPACITY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_SET_DATA_TUPLE_CAPACITY</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_SET_DATA_TUPLE_CAPACITY</pre> |
| <div class="block">The maximum # of data tuple to batch in a HeronDataTupleSet protobuf</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_SET_DATA_TUPLE_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_SET_DATA_TUPLE_SIZE</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_SET_DATA_TUPLE_SIZE</pre> |
| <div class="block">The maximum size in bytes of data tuple to batch in a HeronDataTupleSet protobuf</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_SET_CONTROL_TUPLE_CAPACITY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_SET_CONTROL_TUPLE_CAPACITY</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_SET_CONTROL_TUPLE_CAPACITY</pre> |
| <div class="block">The maximum # of control tuple to batch in a HeronControlTupleSet protobuf</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_ACK_BATCH_TIME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_ACK_BATCH_TIME</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_ACK_BATCH_TIME</pre> |
| <div class="block">The maximum time in ms for an spout to do acknowledgement per attempt</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_EMIT_BATCH_TIME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_EMIT_BATCH_TIME</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_EMIT_BATCH_TIME</pre> |
| <div class="block">The maximum time in ms for an spout instance to emit tuples per attempt</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_EMIT_BATCH_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_EMIT_BATCH_SIZE</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_EMIT_BATCH_SIZE</pre> |
| <div class="block">The maximum batch size in bytes for an spout instance to emit tuples per attempt</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_EXECUTE_BATCH_TIME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_EXECUTE_BATCH_TIME</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_EXECUTE_BATCH_TIME</pre> |
| <div class="block">The maximum time in ms for an bolt instance to execute tuples per attempt</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_EXECUTE_BATCH_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_EXECUTE_BATCH_SIZE</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_EXECUTE_BATCH_SIZE</pre> |
| <div class="block">The maximum batch size in bytes for an bolt instance to execute tuples per attempt</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_FORCE_EXIT_TIMEOUT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_FORCE_EXIT_TIMEOUT</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_FORCE_EXIT_TIMEOUT</pre> |
| <div class="block">The time to wait before the instance exits forcibly when uncaught exception happens</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_RECONNECT_STREAMMGR_INTERVAL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_RECONNECT_STREAMMGR_INTERVAL</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_RECONNECT_STREAMMGR_INTERVAL</pre> |
| <div class="block">Interval in seconds to reconnect to the stream manager</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_RECONNECT_METRICSMGR_INTERVAL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_RECONNECT_METRICSMGR_INTERVAL</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_RECONNECT_METRICSMGR_INTERVAL</pre> |
| <div class="block">Interval in seconds to reconnect to the metrics manager</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_METRICS_SYSTEM_SAMPLE_INTERVAL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_METRICS_SYSTEM_SAMPLE_INTERVAL</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_METRICS_SYSTEM_SAMPLE_INTERVAL</pre> |
| <div class="block">The interval in seconds to sample a system metric, for instance, JVM used memory.</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_ACKNOWLEDGEMENT_NBUCKETS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_ACKNOWLEDGEMENT_NBUCKETS</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_ACKNOWLEDGEMENT_NBUCKETS</pre> |
| <div class="block">The lookForTimeout Interval in spout instance will be timeoutInSeconds / NBUCKETS |
| For instance, if a tuple's timeout is 30s, and NBUCKETS is 10 |
| The spout instance will check whether there are timeout tuples every 3 seconds</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_TUNING_EXPECTED_BOLT_READ_QUEUE_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_TUNING_EXPECTED_BOLT_READ_QUEUE_SIZE</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_TUNING_EXPECTED_BOLT_READ_QUEUE_SIZE</pre> |
| <div class="block">The expected size on read queue in bolt</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_TUNING_EXPECTED_BOLT_WRITE_QUEUE_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_TUNING_EXPECTED_BOLT_WRITE_QUEUE_SIZE</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_TUNING_EXPECTED_BOLT_WRITE_QUEUE_SIZE</pre> |
| <div class="block">The expected size on write queue in bolt</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_TUNING_EXPECTED_SPOUT_READ_QUEUE_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_TUNING_EXPECTED_SPOUT_READ_QUEUE_SIZE</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_TUNING_EXPECTED_SPOUT_READ_QUEUE_SIZE</pre> |
| <div class="block">The expected size on read queue in spout</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_TUNING_EXPECTED_SPOUT_WRITE_QUEUE_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_TUNING_EXPECTED_SPOUT_WRITE_QUEUE_SIZE</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_TUNING_EXPECTED_SPOUT_WRITE_QUEUE_SIZE</pre> |
| <div class="block">The exepected size on write queue in spout</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_TUNING_EXPECTED_METRICS_WRITE_QUEUE_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_TUNING_EXPECTED_METRICS_WRITE_QUEUE_SIZE</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_TUNING_EXPECTED_METRICS_WRITE_QUEUE_SIZE</pre> |
| <div class="block">The expected size on metrics write queue</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_TUNING_CURRENT_SAMPLE_WEIGHT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_TUNING_CURRENT_SAMPLE_WEIGHT</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_TUNING_CURRENT_SAMPLE_WEIGHT</pre> |
| <div class="block">During dynamically tuning, the weight of new sample size to calculate |
| the available capacity of queue. |
| We use Exponential moving average: En = (1-w) * En-1 + w * An |
| http://en.wikipedia.org/wiki/Moving_average#Exponential_moving_average</div> |
| </li> |
| </ul> |
| <a id="INSTANCE_TUNING_INTERVAL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INSTANCE_TUNING_INTERVAL</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> INSTANCE_TUNING_INTERVAL</pre> |
| <div class="block">Interval in ms to tune the size of in & out data queue in instance</div> |
| </li> |
| </ul> |
| <a id="METRICSMGR_NETWORK_READ_BATCH_TIME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>METRICSMGR_NETWORK_READ_BATCH_TIME</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> METRICSMGR_NETWORK_READ_BATCH_TIME</pre> |
| <div class="block">The size of packets read from socket will be determined by the minimal of: |
| (a) time based (b) size based |
| <p> |
| Time based, the maximum batch time in ms for instance to read from socket per attempt</div> |
| </li> |
| </ul> |
| <a id="METRICSMGR_NETWORK_READ_BATCH_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>METRICSMGR_NETWORK_READ_BATCH_SIZE</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> METRICSMGR_NETWORK_READ_BATCH_SIZE</pre> |
| <div class="block">Size based,the maximum batch size in bytes to read from socket</div> |
| </li> |
| </ul> |
| <a id="METRICSMGR_NETWORK_WRITE_BATCH_TIME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>METRICSMGR_NETWORK_WRITE_BATCH_TIME</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> METRICSMGR_NETWORK_WRITE_BATCH_TIME</pre> |
| <div class="block">The size of packets written to socket will be determined by the minimal of |
| (a) time based (b) size based |
| <p> |
| Time based, the maximum batch time in ms to write to socket</div> |
| </li> |
| </ul> |
| <a id="METRICSMGR_NETWORK_WRITE_BATCH_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>METRICSMGR_NETWORK_WRITE_BATCH_SIZE</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> METRICSMGR_NETWORK_WRITE_BATCH_SIZE</pre> |
| <div class="block">Size based, the maximum batch size in bytes to write to socket</div> |
| </li> |
| </ul> |
| <a id="METRICSMGR_NETWORK_OPTIONS_SOCKET_RECEIVED_BUFFER_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>METRICSMGR_NETWORK_OPTIONS_SOCKET_RECEIVED_BUFFER_SIZE</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> METRICSMGR_NETWORK_OPTIONS_SOCKET_RECEIVED_BUFFER_SIZE</pre> |
| <div class="block">The maximum socket's received buffer size in bytes</div> |
| </li> |
| </ul> |
| <a id="METRICSMGR_NETWORK_OPTIONS_SOCKET_SEND_BUFFER_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>METRICSMGR_NETWORK_OPTIONS_SOCKET_SEND_BUFFER_SIZE</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> METRICSMGR_NETWORK_OPTIONS_SOCKET_SEND_BUFFER_SIZE</pre> |
| <div class="block">The maximum socket's send buffer size in bytes</div> |
| </li> |
| </ul> |
| <a id="METRICSMGR_NETWORK_OPTIONS_MAXIMUM_PACKETSIZE_BYTES"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>METRICSMGR_NETWORK_OPTIONS_MAXIMUM_PACKETSIZE_BYTES</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> METRICSMGR_NETWORK_OPTIONS_MAXIMUM_PACKETSIZE_BYTES</pre> |
| <div class="block">The maximum size of heron packet that's allowed by the instance</div> |
| </li> |
| </ul> |
| <a id="TMANAGER_METRICS_COLLECTOR_MAXIMUM_EXCEPTION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TMANAGER_METRICS_COLLECTOR_MAXIMUM_EXCEPTION</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> TMANAGER_METRICS_COLLECTOR_MAXIMUM_EXCEPTION</pre> |
| <div class="block">The maximum exception count be kept in tmanager</div> |
| </li> |
| </ul> |
| <a id="TMANAGER_METRICS_COLLECTOR_MAXIMUM_INTERVAL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TMANAGER_METRICS_COLLECTOR_MAXIMUM_INTERVAL</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> TMANAGER_METRICS_COLLECTOR_MAXIMUM_INTERVAL</pre> |
| <div class="block">The maximum interval in minutes of metrics to be kept in tmanager</div> |
| </li> |
| </ul> |
| <a id="TMANAGER_METRICS_COLLECTOR_PURGE_INTERVAL"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TMANAGER_METRICS_COLLECTOR_PURGE_INTERVAL</h4> |
| <pre>public static final <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> TMANAGER_METRICS_COLLECTOR_PURGE_INTERVAL</pre> |
| <div class="block">The interval for tmanager to purge metrics from socket</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="values()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>values</h4> |
| <pre class="methodSignature">public static <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a>[] values()</pre> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared. This method may be used to iterate |
| over the constants as follows: |
| <pre> |
| for (SystemConfigKey c : SystemConfigKey.values()) |
| System.out.println(c); |
| </pre></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an array containing the constants of this enum type, in the order they are declared</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="valueOf(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>valueOf</h4> |
| <pre class="methodSignature">public static <a href="SystemConfigKey.html" title="enum in org.apache.heron.common.config">SystemConfigKey</a> valueOf​(java.lang.String name)</pre> |
| <div class="block">Returns the enum constant of this type with the specified name. |
| The string must match <i>exactly</i> an identifier used to declare an |
| enum constant in this type. (Extraneous whitespace characters are |
| not permitted.)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the enum constant to be returned.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the enum constant with the specified name</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd> |
| <dd><code>java.lang.NullPointerException</code> - if the argument is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDefaultString()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getDefaultString</h4> |
| <pre class="methodSignature">public java.lang.String getDefaultString()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#enum.constant.summary">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#enum.constant.detail">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |