yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
03e77f3e5b0080047fdcb72efdfd3333dd3bcf92
doc-exports/docs/css/umn/css_01_0140.html
zhengxiu 93d856d5c5 css umn 25.6.0 version 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: zhengxiu <zhengxiu@huawei.com>
Co-committed-by: zhengxiu <zhengxiu@huawei.com>
2025-11-25 11:34:43 +00:00

800 lines
89 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<a name="EN-US_TOPIC_0000001965416561"></a><a name="EN-US_TOPIC_0000001965416561"></a>
<h1 class="topictitle1">Configuring Flow Control 1.0 for an Elasticsearch Cluster</h1>
<div id="body0000001081798855"><p id="EN-US_TOPIC_0000001965416561__p352564532517">Configure flow control policies for your Elasticsearch cluster in both the inbound and outbound directions, ensuring cluster stability by safeguarding against abnormal traffic.</p>
<div class="p" id="EN-US_TOPIC_0000001965416561__p0807832122711">An Elasticsearch cluster can become overloaded due to traffic surges, malicious requests, and internal resource competition, which can even lead to node failures. Through policies like client request throttling, write backpressure, and traffic pattern analysis, flow control ensures proper resource allocation, thereby protecting clusters from overload. It covers the following scenarios:<ul id="EN-US_TOPIC_0000001965416561__ul617310410278"><li id="EN-US_TOPIC_0000001965416561__li417354192717">High-concurrency write handling: mitigates the risk of out-of-memory (OOM) exceptions under heavy write loads.</li><li id="EN-US_TOPIC_0000001965416561__li11731041112713">Security defense: controls access by IP address using both blacklists and whitelists.</li><li id="EN-US_TOPIC_0000001965416561__li1817316417271">Emergency response: blocks malicious or abnormal traffic in one click.</li><li id="EN-US_TOPIC_0000001965416561__li16173124172719">Performance optimization: optimizes flow control thresholds and policies based on collected statistics.</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001965416561__section20798162114246"><h4 class="sectiontitle">How the Feature Works</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001965416561__table184021944184915" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Flow control policies</caption><thead align="left"><tr id="EN-US_TOPIC_0000001965416561__row154031944104913"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.4.1.1"><p id="EN-US_TOPIC_0000001965416561__p8403104418494">Policy</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.00000000000001%" id="mcps1.3.3.2.2.4.1.2"><p id="EN-US_TOPIC_0000001965416561__p6403344154917">How It Works</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.2.4.1.3"><p id="EN-US_TOPIC_0000001965416561__p840364434913">Details</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001965416561__row140384444912"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__p740317443499">HTTP/HTTPS flow control</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.3.2.2.4.1.2 "><ul id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001268594569_ul7877151619443"><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001268594569_li162251814505">You can control cluster access by client IP address or subnet through the HTTP/HTTPS blacklist or whitelist. If an IP address is in the blacklist, the client is disconnected right away and all its requests are rejected. The whitelist takes precedence over the blacklist. If a client IP address is on both the blacklist and whitelist, requests from it will not be rejected.</li><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001268594569_li1515102425012">Flow control based on concurrent HTTP/HTTPS connections limits the total number of HTTP/HTTPS connections to a node per second.</li><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001268594569_li8866192713502">Flow control based on new HTTP/HTTPS connections limits the number of new connections to a node.</li></ul>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__p13202182115463"><a href="#EN-US_TOPIC_0000001965416561__section1023014371242">Enabling HTTP/HTTPS Flow Control per Node</a></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__row940304434916"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__p640374454910">Memory flow control</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__p7759320593">Memory flow control limits request paths based on heap memory usage. You can configure a whitelist for memory flow control, a global memory usage threshold, and per-path heap memory thresholds. The global memory flow control threshold takes precedence over the memory threshold of a single path. Paths on the whitelist are exempt from memory flow control.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__p1620182154619"><a href="#EN-US_TOPIC_0000001965416561__section12926193210818">Enabling Memory Flow Control</a></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__row946713477465"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__p134671747194611">Global path whitelist for flow control</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__p1372133575918">You can configure the global path whitelist for flow control as required when you need to use custom plug-ins.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__p94670476465"><a href="#EN-US_TOPIC_0000001965416561__section8250826148">Adding a Global Path Whitelist for Flow Control</a></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__row5403194410491"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__p154031344194910">Request sampling</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__p57091387598">Request sampling can record the number of access requests from client IP addresses and the request paths of sampled users. Based on the statistics, you can identify and analyze access traffic by client IP addresses and request paths.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__p1220042118468"><a href="#EN-US_TOPIC_0000001965416561__section846243514132">Enabling Request Sampling</a></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__row19403144413497"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__p640315445493">One-click traffic blocking</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__p114475145915">One-click traffic blocking blocks all client connections to a node. This, however, does not include connections for Kibana access or Elasticsearch monitor APIs.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__p141991321204613"><a href="#EN-US_TOPIC_0000001965416561__section364216459204">Enable One-Click Traffic Blocking</a></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__row1740318444495"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__p1140314444914">Flow control</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__p15100030124714">Flow control provides an independent API for checking traffic statistics and records the number API calls. You can evaluate the flow control threshold and analyze the cluster load based on these statistics.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__p161981213467"><a href="#EN-US_TOPIC_0000001965416561__section03781045277">Viewing Flow Control Information</a></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__row3403114494912"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__p1640384474919">Access logging</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__p6348145195913">Access logs record the URLs and bodies of HTTP/HTTPS requests received by nodes within a period of time. You can analyze the current traffic load based on the access logs.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__p1719722124612"><a href="#EN-US_TOPIC_0000001965416561__section1626791610277">Enabling and Viewing Access Logs</a></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__row191114017338"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__p2403134414491">Access logging in files</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__p640354434911">Any cluster access is recorded in the <strong id="EN-US_TOPIC_0000001965416561__b203773081383710">{<em id="EN-US_TOPIC_0000001965416561__i148358469583710">Cluster name</em>_access_log.log}</strong> file. You can use the log backup function to view detailed access logs on OBS.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__p4224083310"><a href="#EN-US_TOPIC_0000001965416561__section072285622916">Enabling Access Logging in Files</a></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__row640315447498"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__p71661447105918">CPU flow control</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__p513348145916">You can configure the node CPU usage threshold to limit inbound traffic for each node.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__p319382124614"><a href="#EN-US_TOPIC_0000001965416561__section159551120113420">Enabling CPU Flow Control</a></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001965416561__section16791032164320"><h4 class="sectiontitle">Constraints</h4><ul id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001268594569_ul1969619523572"><li id="EN-US_TOPIC_0000001965416561__li6429455204117"><span id="EN-US_TOPIC_0000001965416561__ph4459162313420">Elasticsearch 7.6.2 and Elasticsearch 7.10.2 clusters created after January 2023 support Flow Control 2.0 only, whereas those created before that support Flow Control 1.0 only.</span></li><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001268594569_li17382482587">Flow control may hurt the performance of some nodes.</li><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001268594569_li136961252135719">If flow control is enabled, user requests that exceed the flow control threshold will be rejected.</li><li id="EN-US_TOPIC_0000001965416561__li11758153101116">Enabling memory flow control may hurt the performance of some search requests or cause some Kibana search requests to fail.</li><li id="EN-US_TOPIC_0000001965416561__li546091212271">Enabling access logging may hurt cluster performance.</li><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001268594569_li1569675205710">Memory flow control and CPU flow control are based on request paths. Avoid configuring too many paths or paths that are too long, as they may hurt cluster performance.</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001965416561__section1023014371242"><a name="EN-US_TOPIC_0000001965416561__section1023014371242"></a><a name="section1023014371242"></a><h4 class="sectiontitle">Enabling HTTP/HTTPS Flow Control per Node</h4><ol id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_ol764618520817"><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_li96466521484">Run the following command to enable HTTP/HTTPS flow control for cluster nodes:<pre class="screen" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_screen4250194796">PUT /_cluster/settings
{
"persistent": {
"flowcontrol.http.enabled": true,
"flowcontrol.http.allow": ["<em id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_i2025014419912">192.168.0.1/24</em>", "<em id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_i52507417911">192.168.2.1/24</em>"],
"flowcontrol.http.deny": "<em id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_i125015418914">192.168.1.1/24</em>",
"flowcontrol.http.concurrent": <em id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_i92501246919">1000</em>,
"flowcontrol.http.newconnect": <em id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_i182501849911">1000</em>,
"flowcontrol.http.warmup_period": <em id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_i52504411917">0</em>
}
}</pre>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_table131951219400" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Configuration items for HTTP/HTTPS flow control</caption><thead align="left"><tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_row161965164016"><th align="left" class="cellrowborder" valign="top" width="31.290000000000003%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p61968134011">Configuration Item</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.44%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p71961116401">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.27%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p111961018403">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_row1319619174010"><td class="cellrowborder" valign="top" width="31.290000000000003%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p1119661194016">flowcontrol.http.enabled</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p51961214407">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="51.27%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p141961124012">Whether to enable HTTP/HTTPS flow control. HTTP/HTTPS flow control is disabled by default. Enabling it may affect node access performance.</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p419620110406">Value: <strong id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_b203268458043112">true</strong> or <strong id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_b142690683543112">false</strong></p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p11196201104018">Default value: <strong id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_b165840579543112">false</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_row1196201174015"><td class="cellrowborder" valign="top" width="31.290000000000003%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p5196813408">flowcontrol.http.allow</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p219613114408">List&lt;String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="51.27%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p1427748174618">IP address whitelist.</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p1219661174016">It can contain multiple IP addresses and subnet masks, or lists of IP addresses. Use commas (,) to separate different items. Example: <span class="parmvalue" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_parmvalue187181613191211"><b>xx.xx.xx.xx/24,xx.xx.xx.xx/24</b></span>, or <span class="parmvalue" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_parmvalue122871921151219"><b>xx.xx.xx.xx,xx.xx.xx.xx</b></span>.</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p191969174015">The default value is null.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_row171962111401"><td class="cellrowborder" valign="top" width="31.290000000000003%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p10196719403">flowcontrol.http.deny</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p11196151184013">List&lt;String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="51.27%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p16196191144011">IP address blacklist.</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p5196413406">It can contain multiple IP addresses and subnet masks, or lists of IP addresses. Use commas (,) to separate different items.</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p01962117405">The default value is null.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_row1619613194017"><td class="cellrowborder" valign="top" width="31.290000000000003%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p11968194014">flowcontrol.http.concurrent</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p819631194020">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="51.27%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p71967116401">Maximum concurrent HTTP/HTTPS connections.</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p31968184017">Default value: Number of available cores on a node x 600.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_row719671174016"><td class="cellrowborder" valign="top" width="31.290000000000003%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p171961513405">flowcontrol.http.newconnect</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p161969118405">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="51.27%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p18196111104010">Maximum new connections that can be created for HTTP/HTTPS requests per second.</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p219616118407">Default value: Number of available cores on a node x 200.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_row1519651144012"><td class="cellrowborder" valign="top" width="31.290000000000003%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p719612111408">flowcontrol.http.warmup_period</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p7196171144019">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="51.27%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p10196714405">Time required for the HTTP/HTTPS connection setup speed to reach the maximum. If <strong id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_b392253519336">flowcontrol.http.newconnect</strong> is set to <strong id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_b10923103543312">100</strong> and <strong id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_b2923193513319">flowcontrol.http.warmup_period</strong> is set to <strong id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_b6924203553310">5000ms</strong>, it indicates the system can create up to 100 connections per second 5 seconds later.</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p201961612402">Value range: 0–10000</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p18196131144020">Unit: ms</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_p101963124013">Default value: <strong id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_b80622560143112">0</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_note892892541116"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_p12929152551117">If all parameters are set to <strong id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_b14649174874111">null</strong>, they will be restored to their default values.</p>
</div></div>
</li><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_li96343413449">Run the following command to disable HTTP/HTTPS flow control for cluster nodes:<pre class="screen" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001485533945_en-us_topic_0000001228531978_screen463412415444">PUT /_cluster/settings
{
"persistent": {
"flowcontrol.http.enabled": false
}
}</pre>
</li></ol>
</div>
<div class="section" id="EN-US_TOPIC_0000001965416561__section12926193210818"><a name="EN-US_TOPIC_0000001965416561__section12926193210818"></a><a name="section12926193210818"></a><h4 class="sectiontitle">Enabling Memory Flow Control</h4><ol id="EN-US_TOPIC_0000001965416561__ol12925259131314"><li id="EN-US_TOPIC_0000001965416561__li619602045419">Enable memory flow control.<ul id="EN-US_TOPIC_0000001965416561__ul1793219611612"><li id="EN-US_TOPIC_0000001965416561__li89321565614">Run the following command to enable memory flow control:<pre class="screen" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_screen1857516140228">PUT /_cluster/settings
{
"persistent": {
"flowcontrol.memory.enabled": true,
"flowcontrol.memory.allow_path": "/index/_search",
"flowcontrol.memory.heap_limit": "85%"
}
}</pre>
</li><li id="EN-US_TOPIC_0000001965416561__li9720168764">Run the following command to enable memory flow control for a single request path.<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p48087317232"><a name="EN-US_TOPIC_0000001965416561__li9720168764"></a><a name="li9720168764"></a>Configure the heap memory usage threshold for a request path. You can configure priorities for such threshold rules.</p>
<pre class="screen" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_screen198083319239">PUT /_cluster/settings
{
"persistent": {
"flowcontrol.memory.enabled": true,
"flowcontrol.memory": {
"flowcontrol_search": {
"filter_path": "index1/_search",
"heap_limit": "50%"
},
"flowcontrol_bulk": {
"filter_path": "index*/_bulk",
"heap_limit": "50%"
}
}
}
}</pre>
</li></ul>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_table51107567182" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Configuration items for memory flow control</caption><thead align="left"><tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_row1611015564187"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.6.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p10110105617188">Configuration Item</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.6.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p81101456141815">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.6.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p411085651815">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_row1711035641816"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p511095615180">flowcontrol.memory.enabled</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p71102056121819">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p4110125631819">Whether to enable memory flow control. This function is disabled by default. Enabling memory flow control may slightly affect node performance.</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p973514386510">Value: <strong id="EN-US_TOPIC_0000001965416561__b115305220083710">true</strong> or <strong id="EN-US_TOPIC_0000001965416561__b138766670283710">false</strong></p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p815195415510">Default value: <strong id="EN-US_TOPIC_0000001965416561__b151949537383710">false</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_row811035611820"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p111019565188">flowcontrol.memory.allow_path</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p15110205631817">List&lt;String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p1636619409316">Request path whitelist for memory flow control.</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p21101356111815">Whitelisted paths are exempt from memory flow control. Wildcard characters are supported. By default, query APIs controlled by the cluster are exempt from memory flow control. This prevents the failure to query cluster information when the memory usage reaches the threshold.</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p3898131722317">Example:</p>
<ul id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_ul153051554236"><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_li183057546319">"flowcontrol.memory.allow_path": "/index/_search",</li><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_li53055547316">"flowcontrol.memory.allow_path": "/index*/_search",</li><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_li12305195411319">"flowcontrol.memory.allow_path": ["/index/_search", "/index1/_bulk"],</li></ul>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p18641117206">A maximum of 10 paths can be configured. A path can contain up to 32 characters.</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p154576111162">The default value is null.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_row1011035651815"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p171101456171820">flowcontrol.memory.heap_limit</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p611012562183">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p10110156181811">Maximum global heap memory usage of a node before flow control is triggered. The value cannot be less than 10% of the heap memory.</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p149741557373">Value range: 10%–100%</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p59459111814">Default value: <strong id="EN-US_TOPIC_0000001965416561__b121193674283710">90%</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_row12110195651817"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p68159811202">flowcontrol.memory.*.filter_path</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p31106569187">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p1429793752612">Paths under memory flow control.</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p4388542586">The default value is <strong id="EN-US_TOPIC_0000001965416561__b27971542483710">**</strong>, indicating all paths. If <strong id="EN-US_TOPIC_0000001965416561__b207082478183710">flowcontrol.memory.heap_limit</strong> is configured and <strong id="EN-US_TOPIC_0000001965416561__b12837926383710">flowcontrol.memory.*.filter_path</strong> is not, it indicates that all the paths, except those in the whitelist, are under control. The whitelist takes precedence over the single-path rule. If a path is specified in both <strong id="EN-US_TOPIC_0000001965416561__b171026928883710">flowcontrol.memory.allow_path</strong> and <strong id="EN-US_TOPIC_0000001965416561__b72789977083710">flowcontrol.memory.*.filter_path</strong>, the requests from the path will be allowed.</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p1634629165712">For example, if <strong id="EN-US_TOPIC_0000001965416561__b19176976483710">flowcontrol.memory.allow_path</strong> and <strong id="EN-US_TOPIC_0000001965416561__b195106303583710">flowcontrol.memory.*.filter_path</strong> are both set to <strong id="EN-US_TOPIC_0000001965416561__b101152848183710">abc/_search</strong>, then <strong id="EN-US_TOPIC_0000001965416561__b191739159083710">abc/_search</strong> will not be under flow control.</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p185154152198">Maximum length: <strong id="EN-US_TOPIC_0000001965416561__b126691544983710">32</strong> characters</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_row1211085651816"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p14341120122018">flowcontrol.memory.*.heap_limit</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p181101856101819">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p139661844135915">Heap memory usage threshold of request paths. If the heap memory usage exceeds the threshold, flow control will be triggered.</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p16110175615180">Value range: 0–100%</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_p1368317917519">Default value: <strong id="EN-US_TOPIC_0000001965416561__b178652954283710">90%</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="EN-US_TOPIC_0000001965416561__note0263184291711"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_p12929152551117_1">If all parameters are set to <strong id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_b14649174874111_1">null</strong>, they will be restored to their default values.</p>
</div></div>
</li><li id="EN-US_TOPIC_0000001965416561__li39259597131">Run the following command to disable memory flow control:<ul id="EN-US_TOPIC_0000001965416561__ul1713915381678"><li id="EN-US_TOPIC_0000001965416561__li1777020491271">Run the following command to delete memory flow control for a single request path.<p id="EN-US_TOPIC_0000001965416561__p1958016911811"><a name="EN-US_TOPIC_0000001965416561__li1777020491271"></a><a name="li1777020491271"></a>Before disabling memory flow control, you need delete per-request path memory flow control configuration.</p>
<pre class="screen" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_screen128083352312">PUT /_cluster/settings
{
"persistent": {
"flowcontrol.memory.enabled": true,
"flowcontrol.memory": {
"flowcontrol_search": {
"filter_path": null,
"heap_limit": null
}
}
}
}</pre>
</li><li id="EN-US_TOPIC_0000001965416561__li913913389710">Run the following command to disable memory flow control:<pre class="screen" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273212041_screen38095315235">PUT /_cluster/settings
{
"persistent": {
"flowcontrol.memory.enabled": false
}
}</pre>
</li></ul>
</li></ol>
</div>
<div class="section" id="EN-US_TOPIC_0000001965416561__section8250826148"><a name="EN-US_TOPIC_0000001965416561__section8250826148"></a><a name="section8250826148"></a><h4 class="sectiontitle">Adding a Global Path Whitelist for Flow Control</h4><div class="p" id="EN-US_TOPIC_0000001965416561__p4396142751411">Run the following command to add a global path whitelist for flow control:<pre class="screen" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001228972046_screen1922054962716">PUT _cluster/settings
{
"persistent": {
"flowcontrol.path.white_list": "xxxx"
}
}</pre>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001228972046_table693818532617" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Configuration items for a global path whitelist for flow control</caption><thead align="left"><tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001228972046_row19349142520250"><th align="left" class="cellrowborder" valign="top" width="33.08%" id="mcps1.3.7.3.2.4.1.1"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001228972046_p10110105617188">Configuration Item</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.790000000000001%" id="mcps1.3.7.3.2.4.1.2"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001228972046_p81101456141815">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.129999999999995%" id="mcps1.3.7.3.2.4.1.3"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001228972046_p411085651815">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001228972046_row1093815531963"><td class="cellrowborder" valign="top" width="33.08%" headers="mcps1.3.7.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001228972046_p19383534613">flowcontrol.path.white_list</p>
</td>
<td class="cellrowborder" valign="top" width="15.790000000000001%" headers="mcps1.3.7.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001228972046_p1693817534618">List&lt;String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="51.129999999999995%" headers="mcps1.3.7.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001228972046_p197801343183318">Paths that are exempt from flow control. These paths are not affected by memory flow control, CPU flow control, or one-click blocking; but are under IP address-based flow control.</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001228972046_p1993805314614">A maximum of 10 paths can be configured. A path can contain up to 32 characters.</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001228972046_p119388531765">The default value is null.</p>
<div class="note" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001228972046_note118071849142614"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001228972046_p888915417549">You are advised not to configure this parameter, unless required by plug-ins.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="EN-US_TOPIC_0000001965416561__note14574238154215"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_p12929152551117_2">If all parameters are set to <strong id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_b14649174874111_2">null</strong>, they will be restored to their default values.</p>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001965416561__section846243514132"><a name="EN-US_TOPIC_0000001965416561__section846243514132"></a><a name="section846243514132"></a><h4 class="sectiontitle">Enabling Request Sampling</h4><ol id="EN-US_TOPIC_0000001965416561__ol4475813132113"><li id="EN-US_TOPIC_0000001965416561__li547591314210">Run the following command to enable request sampling:<pre class="screen" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001229251898_screen11422663329">PUT /_cluster/settings
{
"persistent": {
"flowcontrol.statics.enabled": true,
"flowcontrol.statics.threshold": 100,
"flowcontrol.statics.sample_frequency": 50
}
}</pre>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001229251898_table119653339296" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Configuration items for request sampling</caption><thead align="left"><tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001229251898_row4965733122914"><th align="left" class="cellrowborder" valign="top" width="33.5033503350335%" id="mcps1.3.8.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001229251898_p2966183317293">Configuration Item</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.58165816581658%" id="mcps1.3.8.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001229251898_p179661933182914">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.91499149914991%" id="mcps1.3.8.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001229251898_p8966123313297">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001229251898_row59660338299"><td class="cellrowborder" valign="top" width="33.5033503350335%" headers="mcps1.3.8.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001229251898_p20966123318294">flowcontrol.statics.enabled</p>
</td>
<td class="cellrowborder" valign="top" width="16.58165816581658%" headers="mcps1.3.8.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001229251898_p1966153362915">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="49.91499149914991%" headers="mcps1.3.8.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001229251898_p13966133316299">Whether to enable request sampling. Request sampling may affect node performance.</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001229251898_p69661833202916">Value: <strong id="EN-US_TOPIC_0000001965416561__b152354792483710">true</strong> or <strong id="EN-US_TOPIC_0000001965416561__b50724758683710">false</strong></p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001229251898_p1296643319296">Default value: <strong id="EN-US_TOPIC_0000001965416561__b37016181883710">false</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001229251898_row7966933172918"><td class="cellrowborder" valign="top" width="33.5033503350335%" headers="mcps1.3.8.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001229251898_p896643332915">flowcontrol.statics.threshold</p>
</td>
<td class="cellrowborder" valign="top" width="16.58165816581658%" headers="mcps1.3.8.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001229251898_p1396603312913">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="49.91499149914991%" headers="mcps1.3.8.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001229251898_p15966733132916">Number of recent access requests whose statistics are collected. The value <strong id="EN-US_TOPIC_0000001965416561__b182266151983710">100</strong> indicates that statistics will be collected on the 100 IP addresses and 100 URLs that are most frequently accessed.</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001229251898_p189661533182911">Minimum value: <strong id="EN-US_TOPIC_0000001965416561__b88368339383710">10</strong></p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001229251898_p189668331295">Maximum value: <strong id="EN-US_TOPIC_0000001965416561__b134557640583710">1000</strong></p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001229251898_p13966163319294">Default value: <strong id="EN-US_TOPIC_0000001965416561__b971833283710">100</strong></p>
<div class="note" id="EN-US_TOPIC_0000001965416561__note731113451181"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="EN-US_TOPIC_0000001965416561__ul1089562111913"><li id="EN-US_TOPIC_0000001965416561__li202471331181919">The IP address statistics and URL sampling statistics are cached based on their access time. If the number of cached records reaches the threshold configured using <strong id="EN-US_TOPIC_0000001965416561__b199541855202319">flowcontrol.statics.threshold</strong>, the earliest records will be deleted.</li><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001229251898_li14181611336">In URL sampling, an access path is uniquely identified by its URL hash.</li></ul>
</div></div>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001229251898_row19966533112920"><td class="cellrowborder" valign="top" width="33.5033503350335%" headers="mcps1.3.8.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001229251898_p14966193332918">flowcontrol.statics.sample_frequency</p>
</td>
<td class="cellrowborder" valign="top" width="16.58165816581658%" headers="mcps1.3.8.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001229251898_p19966163312294">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="49.91499149914991%" headers="mcps1.3.8.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001229251898_p696616337292">Path sampling frequency. If this parameter is set to <strong id="EN-US_TOPIC_0000001965416561__b163769563283710">100</strong>, samples are collected from every 100 requests.</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001229251898_p1696603310292">Minimum value: <strong id="EN-US_TOPIC_0000001965416561__b174149417283710">50</strong></p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001229251898_p796693310294">Default value: <strong id="EN-US_TOPIC_0000001965416561__b104769662883710">100</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="EN-US_TOPIC_0000001965416561__note13343145911257"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_p12929152551117_3">If all parameters are set to <strong id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_b14649174874111_3">null</strong>, they will be restored to their default values.</p>
</div></div>
</li><li id="EN-US_TOPIC_0000001965416561__li547581314213">Run the following command to disable request sampling:<pre class="screen" id="EN-US_TOPIC_0000001965416561__screen347116118229">PUT /_cluster/settings
{
"persistent": {
"flowcontrol.statics.enabled": false
}
}</pre>
</li></ol>
</div>
<div class="section" id="EN-US_TOPIC_0000001965416561__section364216459204"><a name="EN-US_TOPIC_0000001965416561__section364216459204"></a><a name="section364216459204"></a><h4 class="sectiontitle">Enable One-Click Traffic Blocking</h4><ol id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_ol10755164012261"><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_li6755104018263">Run the following command to enable one-click traffic blocking:<pre class="screen" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435336968_screen32595165917">PUT /_cluster/settings
{
"persistent": {
"flowcontrol.break.enabled": true
}
}</pre>
</li><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_li6755040112610">Run the following command to disable one-click traffic blocking:<pre class="screen" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435336968_screen125153596">PUT /_cluster/settings
{
"persistent": {
"flowcontrol.break.enabled": false
}
}</pre>
</li></ol>
</div>
<div class="section" id="EN-US_TOPIC_0000001965416561__section03781045277"><a name="EN-US_TOPIC_0000001965416561__section03781045277"></a><a name="section03781045277"></a><h4 class="sectiontitle">Viewing Flow Control Information</h4><ul id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_ul19124627174116"><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_li1124132724114">Check the flow control status of all nodes.<pre class="screen" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_screen39443424212">GET /_nodes/stats/filter</pre>
</li><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_li6489194354113">View the flow control status of a specific node.<pre class="screen" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_screen137338134019">GET /_nodes/<em id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_i10687102019424">{nodeId}</em>/stats/filter</pre>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p1721846124219"><span class="parmvalue" id="EN-US_TOPIC_0000001965416561__parmvalue157681307248"><b>{nodeId}</b></span> indicates the ID of the node you want to check.</p>
</li></ul>
<div class="p" id="EN-US_TOPIC_0000001965416561__p20433144220284">Example response:<div class="note" id="EN-US_TOPIC_0000001965416561__note313924810249"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p146754115458">In the response, the information of each node is separated. The <strong id="EN-US_TOPIC_0000001965416561__b28515346383710">http</strong> field records the numbers of concurrent connections and new connections. The <strong id="EN-US_TOPIC_0000001965416561__b189979923283710">memory</strong> records memory flow control statistics. The <strong id="EN-US_TOPIC_0000001965416561__b84564777083710">ip_address</strong> field records the recent client IP addresses that are accessed most recently. The <strong id="EN-US_TOPIC_0000001965416561__b143054439983710">url_sample</strong> field records the recent URLs that are requested most frequently. The <strong id="EN-US_TOPIC_0000001965416561__b185799469183710">cpu</strong> field records CPU flow control statistics.</p>
</div></div>
<pre class="screen" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_screen18852015217">{
"_nodes" : {
"total" : 1,
"successful" : 1,
"failed" : 0
},
"cluster_name" : "css-flowcontroller",
"nodes" : {
"ElBRNCMbTj6L1C-Wke-Dnw" : {
"name" : "css-flowcontroller-ess-esn-1-1",
"host" : "10.0.0.133",
"timestamp" : 1613979513747,
"flow_control" : {
"transport" : {
"concurrent_req" : 0,
"rejected_concurrent" : 0,
"rejected_new" : 0,
"rejected_deny" : 0
},
"http" : {
"concurrent_req" : 0,
"rejected_concurrent" : 0,
"rejected_new" : 0,
"rejected_deny" : 0
},
"memory" : {
"memory_allow" : 41,
"memory_rejected" : 0
},
"cpu": {
"rejected_cpu" : 0
}
"ip_address" : [
{
"ip" : "/10.0.0.198",
"count" : 453
},
{
"ip" : "/198.19.49.1",
"count" : 42
}
],
"url_sample" : [
{
"url" : "/*/_search?pretty=true",
"method" : "GET",
"remote_address" : "/10.0.0.198:16763",
"count" : 1
}
]
}
}
}</pre>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_table1065614178495" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_row18656317174912"><th align="left" class="cellrowborder" valign="top" width="28.59%" id="mcps1.3.10.4.2.3.1.1"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p1765671717491">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="71.41%" id="mcps1.3.10.4.2.3.1.2"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p1165610175492">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_row13656217104911"><td class="cellrowborder" valign="top" width="28.59%" headers="mcps1.3.10.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p156562174493">concurrent_req</p>
</td>
<td class="cellrowborder" valign="top" width="71.41%" headers="mcps1.3.10.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p15656131717492">Number of TCP connections of a node, which is recorded no matter whether flow control is enabled. This value is similar to the value of <strong id="EN-US_TOPIC_0000001965416561__b68995939183710">current_open</strong> of the <strong id="EN-US_TOPIC_0000001965416561__b32003665783710">GET /_nodes/stats/http</strong> API but is smaller, because whitelisted IP addresses and internal node IP addresses are not counted.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_row665651784917"><td class="cellrowborder" valign="top" width="28.59%" headers="mcps1.3.10.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p76561617124919">rejected_concurrent</p>
</td>
<td class="cellrowborder" valign="top" width="71.41%" headers="mcps1.3.10.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p1665641719499">Number of concurrent connections rejected during HTTP flow control. Disabling HTTP flow control does not clear this record.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_row10656317204915"><td class="cellrowborder" valign="top" width="28.59%" headers="mcps1.3.10.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p4656121784915">rejected_new</p>
</td>
<td class="cellrowborder" valign="top" width="71.41%" headers="mcps1.3.10.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p18656161713496">Number of new connections rejected during HTTP flow control. Disabling HTTP flow control does not clear this record.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_row1656201714916"><td class="cellrowborder" valign="top" width="28.59%" headers="mcps1.3.10.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p2065618170492">rejected_deny</p>
</td>
<td class="cellrowborder" valign="top" width="71.41%" headers="mcps1.3.10.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p5656151794916">Number of requests rejected based on the blacklist during HTTP flow control. Disabling HTTP flow control does not clear this record.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_row365611178493"><td class="cellrowborder" valign="top" width="28.59%" headers="mcps1.3.10.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p665651718493">memory_allow</p>
</td>
<td class="cellrowborder" valign="top" width="71.41%" headers="mcps1.3.10.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p2656181711491">Number of allowed requests during memory flow control. This parameter takes effect when memory flow control is enabled, and its value is not cleared after memory flow control is disabled. The requests from the paths in the <strong id="EN-US_TOPIC_0000001965416561__b44466736483710">allow_path</strong> whitelist are not recorded. If <strong id="EN-US_TOPIC_0000001965416561__b96390112983710">allow_path</strong> is set to <strong id="EN-US_TOPIC_0000001965416561__b69298864283710">**</strong>, no requests are recorded.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_row865618172497"><td class="cellrowborder" valign="top" width="28.59%" headers="mcps1.3.10.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p76561617174912">memory_rejected</p>
</td>
<td class="cellrowborder" valign="top" width="71.41%" headers="mcps1.3.10.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p7656171774914">Number of rejected requests during memory flow control. This parameter takes effect when memory flow control is enabled, and its value is not cleared after memory flow control is disabled. The requests from the paths in the <strong id="EN-US_TOPIC_0000001965416561__b133749142583710">allow_path</strong> whitelist are not recorded. If <strong id="EN-US_TOPIC_0000001965416561__b4012175683710">allow_path</strong> is set to <strong id="EN-US_TOPIC_0000001965416561__b132689383183710">**</strong>, no requests are recorded.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_row106562179493"><td class="cellrowborder" valign="top" width="28.59%" headers="mcps1.3.10.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p1265661713496">rejected_cpu</p>
</td>
<td class="cellrowborder" valign="top" width="71.41%" headers="mcps1.3.10.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p16560173496">Number of requests rejected when the CPU flow control threshold is exceeded. This parameter takes effect when CPU flow control is enabled, and its value is not cleared after CPU flow control is disabled.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_row11656121713492"><td class="cellrowborder" valign="top" width="28.59%" headers="mcps1.3.10.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p106562179495">ip_address</p>
</td>
<td class="cellrowborder" valign="top" width="71.41%" headers="mcps1.3.10.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p1965671717493">IP addresses and the number of requests. For details, see <a href="#EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_table8881825155010">Table 7</a><a href="#EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_table8881825155010">Table 7</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_row1465671717496"><td class="cellrowborder" valign="top" width="28.59%" headers="mcps1.3.10.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p1365651715493">url_sample</p>
</td>
<td class="cellrowborder" valign="top" width="71.41%" headers="mcps1.3.10.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p1765691712494">Request path sampling. The number of URLs of a request are collected based on the configured time and sampling interval. For details, see <a href="#EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_table72712520501">Table 8</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_table8881825155010"></a><a name="en-us_topic_0000001273451905_table8881825155010"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_table8881825155010" frame="border" border="1" rules="all"><caption><b>Table 7 </b>ip_address</caption><thead align="left"><tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_row388132545014"><th align="left" class="cellrowborder" valign="top" width="28.59%" id="mcps1.3.10.5.2.3.1.1"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p588120256501">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="71.41%" id="mcps1.3.10.5.2.3.1.2"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p12881122555015">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_row38813255503"><td class="cellrowborder" valign="top" width="28.59%" headers="mcps1.3.10.5.2.3.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p88818253500">ip</p>
</td>
<td class="cellrowborder" valign="top" width="71.41%" headers="mcps1.3.10.5.2.3.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p10881102515016">Source IP address for accessing the node.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_row178811252503"><td class="cellrowborder" valign="top" width="28.59%" headers="mcps1.3.10.5.2.3.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p188111259501">method</p>
</td>
<td class="cellrowborder" valign="top" width="71.41%" headers="mcps1.3.10.5.2.3.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p20881112585012">Number of access requests from an IP address.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_table72712520501"></a><a name="en-us_topic_0000001273451905_table72712520501"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_table72712520501" frame="border" border="1" rules="all"><caption><b>Table 8 </b>url_sample</caption><thead align="left"><tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_row13271165211507"><th align="left" class="cellrowborder" valign="top" width="28.59%" id="mcps1.3.10.6.2.3.1.1"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p9271165210508">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="71.41%" id="mcps1.3.10.6.2.3.1.2"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p202711952165011">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_row162717528509"><td class="cellrowborder" valign="top" width="28.59%" headers="mcps1.3.10.6.2.3.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p6271952205011">url</p>
</td>
<td class="cellrowborder" valign="top" width="71.41%" headers="mcps1.3.10.6.2.3.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p52719521507">Request URL</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_row9271175218500"><td class="cellrowborder" valign="top" width="28.59%" headers="mcps1.3.10.6.2.3.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p142711352115013">method</p>
</td>
<td class="cellrowborder" valign="top" width="71.41%" headers="mcps1.3.10.6.2.3.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p22712523504">Method corresponding to the request path</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_row22711252115013"><td class="cellrowborder" valign="top" width="28.59%" headers="mcps1.3.10.6.2.3.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p027111521509">remote_address</p>
</td>
<td class="cellrowborder" valign="top" width="71.41%" headers="mcps1.3.10.6.2.3.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p2027112525508">Source IP address and port number in the request</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_row15271185212507"><td class="cellrowborder" valign="top" width="28.59%" headers="mcps1.3.10.6.2.3.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p227145225016">count</p>
</td>
<td class="cellrowborder" valign="top" width="71.41%" headers="mcps1.3.10.6.2.3.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273451905_p13271205215013">How many times a path is sampled</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001965416561__section1626791610277"><a name="EN-US_TOPIC_0000001965416561__section1626791610277"></a><a name="section1626791610277"></a><h4 class="sectiontitle">Enabling and Viewing Access Logs</h4><ol id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_ol1451314268310"><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_li13513102653113">Run the following command to enable access logging:<ul id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_ul14793171816334"><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_li37931181334">Enable access logging for all nodes in a cluster.<pre class="screen" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_screen17931818123313">PUT /_access_log?duration_limit=30s&amp;capacity_limit=1mb</pre>
</li><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_li0793111893316">Enable access logging for a specified node in a cluster.<pre class="screen" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_screen379391812337">PUT /_access_log/<em id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_i1679351813312">{nodeId}</em>?duration_limit=30s&amp;capacity_limit=1mb</pre>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p8794141853314"><span class="parmvalue" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_parmvalue56872239318"><b>{nodeId}</b></span> indicates the node ID.</p>
</li></ul>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_table14438151713712" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Configuration items for configuring access logging</caption><thead align="left"><tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_row134385172373"><th align="left" class="cellrowborder" valign="top" width="24.39%" id="mcps1.3.11.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p94387177375">Configuration Item</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.379999999999999%" id="mcps1.3.11.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p35341047113710">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.23%" id="mcps1.3.11.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p84381717153717">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_row10438717163713"><td class="cellrowborder" valign="top" width="24.39%" headers="mcps1.3.11.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p17438317183719">duration_limit</p>
</td>
<td class="cellrowborder" valign="top" width="15.379999999999999%" headers="mcps1.3.11.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p145341647133719">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.23%" headers="mcps1.3.11.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p164381817183717">Maximum duration of access log records. When this duration is reached, the recording stops.</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p154384172374">Value range: 10 to 120</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p9438111793716">Unit: s</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p0438417143712">Default value: <strong id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_b128785585543112">30</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_row34381417173716"><td class="cellrowborder" valign="top" width="24.39%" headers="mcps1.3.11.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p18438201753718">capacity_limit</p>
</td>
<td class="cellrowborder" valign="top" width="15.379999999999999%" headers="mcps1.3.11.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p853404783711">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.23%" headers="mcps1.3.11.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p9438111753718">Maximum memory size for recording access logs. When the size of an access log reaches this value, access logging stops.</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p743820171376">Value range: 1 to 5</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p4438161714372">Unit: MB</p>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p1343871763718">Default value: <strong id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_b2781871043112">1</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_note047294821315"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_ul5728121683318"><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_li1728151683310">Access logging stops when either <strong id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_b45930865343112">duration_limit</strong> or <strong id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_b5668892143112">capacity_limit</strong> is reached.</li><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_li117281516143319">If all parameters are set to <strong id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_b1910045114114">null</strong>, they will be restored to their default values.</li></ul>
</div></div>
</li><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_li148131484332">Run the following command to check access logs:<ul id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_ul1492754423311"><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_li139271444163318">API for checking the access logs of all nodes in a cluster<pre class="screen" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_screen9927164493314">GET /_access_log</pre>
</li><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_li13927144403310">API for checking the access logs of a specified node in a cluster<pre class="screen" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_screen1092704483317">GET /_access_log/<em id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_i209271044183311">{nodeId}</em></pre>
<p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p2927164443316"><span class="parmvalue" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_parmvalue0573183063310"><b>{nodeId}</b></span> indicates the node ID.</p>
</li></ul>
<div class="p" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_p5405653133319">Example response:<pre class="screen" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_screen195443596430">{
"_nodes" : {
"total" : 1,
"successful" : 1,
"failed" : 0
},
"cluster_name" : "css-flowcontroller",
"nodes" : {
"8x-ZHu-wTemBQwpcGivFKg" : {
"name" : "css-flowcontroller-ess-esn-1-1",
"host" : "10.0.0.98",
"count" : 2,
"access" : [
{
"time" : "2021-02-23 02:09:50",
"remote_address" : "/10.0.0.98:28191",
"url" : "/_access/security/log?pretty",
"method" : "GET",
"content" : ""
},
{
"time" : "2021-02-23 02:09:52",
"remote_address" : "/10.0.0.98:28193",
"url" : "/_access/security/log?pretty",
"method" : "GET",
"content" : ""
}
]
}
}
}</pre>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_table79421457173012" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_row12943105753011"><th align="left" class="cellrowborder" valign="top" width="28.59%" id="mcps1.3.11.2.2.2.2.2.3.1.1"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p1494335719307">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="71.41%" id="mcps1.3.11.2.2.2.2.2.3.1.2"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p199431457183013">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_row194320579307"><td class="cellrowborder" valign="top" width="28.59%" headers="mcps1.3.11.2.2.2.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p894310579302">name</p>
</td>
<td class="cellrowborder" valign="top" width="71.41%" headers="mcps1.3.11.2.2.2.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p59431557113017">Node name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_row69435575302"><td class="cellrowborder" valign="top" width="28.59%" headers="mcps1.3.11.2.2.2.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p09431057113020">host</p>
</td>
<td class="cellrowborder" valign="top" width="71.41%" headers="mcps1.3.11.2.2.2.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p8943657193020">Node IP address</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_row694345717303"><td class="cellrowborder" valign="top" width="28.59%" headers="mcps1.3.11.2.2.2.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p13943115753016">count</p>
</td>
<td class="cellrowborder" valign="top" width="71.41%" headers="mcps1.3.11.2.2.2.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p494375723012">Number of node access requests in a statistical period</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_row1994312574305"><td class="cellrowborder" valign="top" width="28.59%" headers="mcps1.3.11.2.2.2.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p189431657143012">access</p>
</td>
<td class="cellrowborder" valign="top" width="71.41%" headers="mcps1.3.11.2.2.2.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_p13943125716308">Details about node access requests in a statistical period For details, see <a href="#EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_table72934522332">Table 11</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_table72934522332"></a><a name="en-us_topic_0000001938218516_table72934522332"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_table72934522332" frame="border" border="1" rules="all"><caption><b>Table 11 </b>access</caption><thead align="left"><tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_row162921152173315"><th align="left" class="cellrowborder" valign="top" width="28.59%" id="mcps1.3.11.2.2.2.3.2.3.1.1"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_p829265213333">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="71.41%" id="mcps1.3.11.2.2.2.3.2.3.1.2"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_p22922528332">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_row16292205212331"><td class="cellrowborder" valign="top" width="28.59%" headers="mcps1.3.11.2.2.2.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_p1829215211330">time</p>
</td>
<td class="cellrowborder" valign="top" width="71.41%" headers="mcps1.3.11.2.2.2.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_p92928523335">Request time</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_row10292175210331"><td class="cellrowborder" valign="top" width="28.59%" headers="mcps1.3.11.2.2.2.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_p112921052133317">remote_address</p>
</td>
<td class="cellrowborder" valign="top" width="71.41%" headers="mcps1.3.11.2.2.2.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_p529245220330">Source IP address and port number in the request</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_row132931152103316"><td class="cellrowborder" valign="top" width="28.59%" headers="mcps1.3.11.2.2.2.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_p16293135273312">url</p>
</td>
<td class="cellrowborder" valign="top" width="71.41%" headers="mcps1.3.11.2.2.2.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_p12933522339">Original URL of the request</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_row929375243318"><td class="cellrowborder" valign="top" width="28.59%" headers="mcps1.3.11.2.2.2.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_p4293185203318">method</p>
</td>
<td class="cellrowborder" valign="top" width="71.41%" headers="mcps1.3.11.2.2.2.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_p5293205203311">Method corresponding to the request path</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_row62933528337"><td class="cellrowborder" valign="top" width="28.59%" headers="mcps1.3.11.2.2.2.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_p4293195213310">content</p>
</td>
<td class="cellrowborder" valign="top" width="71.41%" headers="mcps1.3.11.2.2.2.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_p1829355218338">Request content</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</li><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_li11157142918335">Run the following commands to delete access logs.<div class="p" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_p346173410492"><a name="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_li11157142918335"></a><a name="en-us_topic_0000001938218516_en-us_topic_0000001435340292_li11157142918335"></a>API for deleting access logs for all nodes:<pre class="screen" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435340292_screen223415231372">DELETE /_access_log</pre>
</div>
</li></ol>
</div>
<div class="section" id="EN-US_TOPIC_0000001965416561__section072285622916"><a name="EN-US_TOPIC_0000001965416561__section072285622916"></a><a name="section072285622916"></a><h4 class="sectiontitle">Enabling Access Logging in Files</h4><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_p4975653246">Typically you record access logs in files to locate faults. After faults are rectified, you should disable it.</p>
<ol id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_ol871152419322"><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_li5712245322">Run the following command to enable access logging in files:<pre class="screen" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_screen282114492348">PUT /_cluster/settings
{
"persistent": {
"flowcontrol.log.file.enabled": true
}
}</pre>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_table082114917343" frame="border" border="1" rules="all"><caption><b>Table 12 </b>Configuration items for enabling access logging in files</caption><thead align="left"><tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_row83302171662"><th align="left" class="cellrowborder" valign="top" width="33.5033503350335%" id="mcps1.3.12.3.1.2.2.4.1.1"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_p1331141710611">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.58165816581658%" id="mcps1.3.12.3.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_p133310171567">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.91499149914991%" id="mcps1.3.12.3.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_p1533112175616">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435176996_row19966533112920"><td class="cellrowborder" valign="top" width="33.5033503350335%" headers="mcps1.3.12.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435176996_p1553811461715">flowcontrol.log.file.enabled</p>
</td>
<td class="cellrowborder" valign="top" width="16.58165816581658%" headers="mcps1.3.12.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435176996_p55389481717">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="49.91499149914991%" headers="mcps1.3.12.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_p1570615197353">Whether to record the details of each request in the access log file. The log file name is <span class="filepath" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_filepath783733812165"><b>Cluster name_access_log.log</b></span>. You can check this file only through the log backup function.</p>
<div class="p" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435176996_p75381745179">Value:<ul id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435176996_ul1015915575192"><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435176996_li616025719198">true</li><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_en-us_topic_0000001435176996_li91601057111913">false (default value)</li></ul>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_li7679839163220">Run the following command to disable access logging in files:<pre class="screen" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_screen5341356143211">PUT /_cluster/settings
{
"persistent": {
"flowcontrol.log.file.enabled": false
}
}</pre>
</li></ol>
</div>
<div class="section" id="EN-US_TOPIC_0000001965416561__section159551120113420"><a name="EN-US_TOPIC_0000001965416561__section159551120113420"></a><a name="section159551120113420"></a><h4 class="sectiontitle">Enabling CPU Flow Control</h4><ol id="EN-US_TOPIC_0000001965416561__ol462013497342"><li id="EN-US_TOPIC_0000001965416561__li3620184963419">Run the following command to enable CPU flow control:<pre class="screen" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273691633_screen192030125717">PUT /_cluster/settings
{
"persistent": {
"flowcontrol.cpu.enabled": true,
"flowcontrol.cpu.percent_limit": 80,
"flowcontrol.cpu.allow_path": ["index/_search"]
}
}</pre>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001965416561__table17577183233512" frame="border" border="1" rules="all"><caption><b>Table 13 </b>Configuration items for configuring access logging</caption><thead align="left"><tr id="EN-US_TOPIC_0000001965416561__row10577832163520"><th align="left" class="cellrowborder" valign="top" width="24.39%" id="mcps1.3.13.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0000001965416561__p757753211353">Configuration Item</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.379999999999999%" id="mcps1.3.13.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000001965416561__p1957763253511">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.23%" id="mcps1.3.13.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000001965416561__p2577143233512">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001965416561__row0577232173512"><td class="cellrowborder" valign="top" width="24.39%" headers="mcps1.3.13.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__p1277155953513">flowcontrol.cpu.enabled</p>
</td>
<td class="cellrowborder" valign="top" width="15.379999999999999%" headers="mcps1.3.13.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__p1276135919356">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60.23%" headers="mcps1.3.13.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__p18275115943510">Whether to enable CPU flow control.</p>
<div class="p" id="EN-US_TOPIC_0000001965416561__p145465911312">The value can be:<ul id="EN-US_TOPIC_0000001965416561__ul054619103111"><li id="EN-US_TOPIC_0000001965416561__li354614923120">true</li><li id="EN-US_TOPIC_0000001965416561__li185465912312">false (default value)</li></ul>
</div>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__row15578163223517"><td class="cellrowborder" valign="top" width="24.39%" headers="mcps1.3.13.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__p1627275903513">flowcontrol.cpu.percent_limit</p>
</td>
<td class="cellrowborder" valign="top" width="15.379999999999999%" headers="mcps1.3.13.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__p1335933711314">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.23%" headers="mcps1.3.13.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__p123591637183119">Maximum CPU usage (%) of a node before flow control is triggered.</p>
<p id="EN-US_TOPIC_0000001965416561__p123594371316">Default value: <strong id="EN-US_TOPIC_0000001965416561__b76693706883710">90</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001965416561__row187976273619"><td class="cellrowborder" valign="top" width="24.39%" headers="mcps1.3.13.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001965416561__p11797102163619">flowcontrol.cpu.allow_path</p>
</td>
<td class="cellrowborder" valign="top" width="15.379999999999999%" headers="mcps1.3.13.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001965416561__p156922365339">List&lt;String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="60.23%" headers="mcps1.3.13.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001965416561__p269213611337">Path whitelist for CPU flow control.</p>
<p id="EN-US_TOPIC_0000001965416561__p1769211361334">The paths specified using this parameter are exempt from CPU flow control. By default, query APIs controlled by the cluster are exempt from CPU flow control. This prevents the failure to query cluster information when the CPU usage reaches the threshold.</p>
<p id="EN-US_TOPIC_0000001965416561__p1469213613315">Example:</p>
<ul id="EN-US_TOPIC_0000001965416561__ul36921836153314"><li id="EN-US_TOPIC_0000001965416561__li86921036143319">"flowcontrol.memory.allow_path": "/index/_search",</li><li id="EN-US_TOPIC_0000001965416561__li1069263618334">"flowcontrol.memory.allow_path": "/index*/_search",</li><li id="EN-US_TOPIC_0000001965416561__li2692133616332">"flowcontrol.memory.allow_path": ["/index/_search", "/index1/_bulk"],</li></ul>
<p id="EN-US_TOPIC_0000001965416561__p4692163620338">A maximum of 10 paths can be configured. A path can contain up to 32 characters.</p>
<p id="EN-US_TOPIC_0000001965416561__p16692636133315">The default value is null.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="EN-US_TOPIC_0000001965416561__note14792752143512"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_p12929152551117_4">If all parameters are set to <strong id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001938218516_b14649174874111_4">null</strong>, they will be restored to their default values.</p>
</div></div>
</li><li id="EN-US_TOPIC_0000001965416561__li13621174916346">Run the following command to disable CPU flow control:<pre class="screen" id="EN-US_TOPIC_0000001965416561__en-us_topic_0000001273691633_screen20923045713">PUT /_cluster/settings
{
"persistent": {
"flowcontrol.cpu.enabled": false
}
}</pre>
</li></ol>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0111.html">Enhancing Search Capabilities for Elasticsearch Clusters</a></div>
</div>
</div>
View Git Blame Copy Permalink