From 1420c83a87e19c84c95fdf67475a35b30f0fae8a Mon Sep 17 00:00:00 2001 From: Juliana Fajardini Date: Tue, 17 Sep 2024 15:50:37 -0300 Subject: [PATCH] doc/configuration: remove mention to prune-flows Although the `prune-flows` option was removed with a5587fec2eb, when documentation for the suricata.yaml config file was added with b252b0d, this option was also included - as has remained until now. --- doc/userguide/configuration/suricata-yaml.rst | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/doc/userguide/configuration/suricata-yaml.rst b/doc/userguide/configuration/suricata-yaml.rst index 6908c804ed..b348a49fc2 100644 --- a/doc/userguide/configuration/suricata-yaml.rst +++ b/doc/userguide/configuration/suricata-yaml.rst @@ -1065,21 +1065,20 @@ flow-engine goes into the emergency-mode. In this mode, the engine will make use of shorter time-outs. It lets flows expire in a more aggressive manner so there will be more space for new Flows. -There are two options: emergency_recovery and prune_flows. The -emergency recovery is set on 30. This is the percentage of prealloc'd -flows after which the flow-engine will be back to normal (when 30 -percent of the 10000 flows is completed). +Emergency_recovery defines the percentage of flows that the engine needs to +prune before clearing the **emergency mode**. The default ``emergency-recovery`` +value is 30. This is the percentage of prealloc'd flows after which the flow +-engine will be back to normal (when 30 percent of the 10000 flows are +completed). - If during the emergency-mode, the aggressive time-outs do not + If during the **emergency-mode** the aggressive time-outs do not have the desired result, this option is the final resort. It ends some flows even if they have not reached their time-outs - yet. The prune-flows option shows how many flows there will be - terminated at each time a new flow is set up. + yet. :: - emergency_recovery: 30 #Percentage of 1000 prealloc'd flows. - prune_flows: 5 #Amount of flows being terminated during the emergency mode. + emergency_recovery: 30 #Percentage of 10000 prealloc'd flows. Flow Time-Outs ~~~~~~~~~~~~~~