This is an automated email from the ASF dual-hosted git repository.

szaszm pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/nifi-minifi-cpp.git

commit 56c8bffb9ce0f08ed95aedb10a7434d0ed66f02b
Author: Ferenc Gerlits <[email protected]>
AuthorDate: Wed Dec 10 13:35:51 2025 +0100

    MINIFICPP-2694 Clarify the documentation of drain.timeout and 
graceful.shutdown.period
    
    documentation update only
    
    Closes #2079
    
    Signed-off-by: Marton Szasz <[email protected]>
---
 CONFIGURE.md | 18 ++++++++++++------
 1 file changed, 12 insertions(+), 6 deletions(-)

diff --git a/CONFIGURE.md b/CONFIGURE.md
index a1bab7754..62e8a8768 100644
--- a/CONFIGURE.md
+++ b/CONFIGURE.md
@@ -454,19 +454,25 @@ If a processor is triggered but has no work available, it 
will yield for the con
     # in minifi.properties
     nifi.bored.yield.duration=100 millis
 
-### Graceful shutdown period
+### FlowController drain timeout and graceful shutdown period
 
-It is possible to configure a graceful shutdown period, the period the flow 
controller will wait to unload the flow configuration and stop running 
processors.
+When the flow is stopped, either because of a flow update from C2, a stop or 
restart command from C2, or because MiNiFi is stopped by the operating system,
+MiNiFi stops all source processors (processors without incoming connections) 
first. Next, it waits for all connection queues to become empty, but
+at most the amount of time set in the
 
     # in minifi.properties
-    nifi.flowcontroller.graceful.shutdown.period=30 sec
+    nifi.flowcontroller.drain.timeout=5 sec
 
-### FlowController drain timeout
+property. The default value is zero, i.e., no wait. Finally, it shuts down the 
remaining processors. If there are flow files left in some connection
+queues after the drain timeout, they will remain saved to disk (when using 
persistent repositories, which is the default) or be discarded (when using 
volatile repositories).
 
-Timeout period for finishing processing of flow files in progress when 
shutting down flow controller. When not set we do not wait for flow files to 
finish processing.
+By default, the wait time will be limited to 30 seconds during any kind of 
restart or shutdown (but not during flow updates). You can increase or decrease
+this 30 second limit by setting the
 
     # in minifi.properties
-    nifi.flowcontroller.drain.timeout=500 millis
+    nifi.flowcontroller.graceful.shutdown.period=2 sec
+
+property. The effective wait time during a restart or shutdown will be the 
minimum of these two property values.
 
 ### SiteToSite Security Configuration
 

Reply via email to