doc/config: Update flushing description

Update output flushing description to reflect EVE based approach in
documentation and config template.

Issue: 8286
pull/15091/head
Jeff Lucovsky 2 months ago committed by Victor Julien
parent 1923ca1aa0
commit e7dc0d885b

@ -39,9 +39,9 @@ may be held in memory and written a short time later opening the possibility --
loss.
Hence, a heartbeat mechanism is introduced to limit the amount of time buffered data may exist before being
flushed. Control is provided to instruct Suricata's detection threads to flush their EVE output. With default
flushed. A heartbeat thread periodically flushes all active EVE log files directly. With default
values, there is no change in output buffering and flushing behavior. ``output-flush-interval`` controls
how often Suricata's detect threads will flush output in a heartbeat fashion. A value of ``0`` means
how often Suricata will flush EVE output in a heartbeat fashion. A value of ``0`` means
"never"; non-zero values must be in ``[1-60]`` seconds.
Flushing should be considered when ``outputs.buffer-size`` is greater than 0 to limit the amount and

@ -291,12 +291,12 @@ outputs:
# spurious-retransmission: false # log spurious retransmission packets
#
heartbeat:
# The output-flush-interval value governs how often Suricata will instruct the
# detection threads to flush their EVE output. Specify the value in seconds [1-60]
# and Suricata will initiate EVE log output flushes at that interval. A value
# of 0 means no EVE log output flushes are initiated. When the EVE output
# The output-flush-interval value governs how often Suricata will flush
# EVE log file output. Specify the value in seconds [1-60] and Suricata will
# flush all active EVE log files at that interval. A value of 0 means
# no EVE log output flushes are performed. When the EVE output
# buffer-size value is non-zero, some EVE output that was written may remain
# buffered. The output-flush-interval governs how much buffered data exists.
#
# The default value is: 0 (never instruct detection threads to flush output)
# The default value is: 0 (no periodic flushing)
#output-flush-interval: 0

@ -598,14 +598,14 @@ outputs:
# - script1.lua
heartbeat:
# The output-flush-interval value governs how often Suricata will instruct the
# detection threads to flush their EVE output. Specify the value in seconds [1-60]
# and Suricata will initiate EVE log output flushes at that interval. A value
# of 0 means no EVE log output flushes are initiated. When the EVE output
# The output-flush-interval value governs how often Suricata will flush
# EVE log file output. Specify the value in seconds [1-60] and Suricata will
# flush all active EVE log files at that interval. A value of 0 means
# no EVE log output flushes are performed. When the EVE output
# buffer-size value is non-zero, some EVE output that was written may remain
# buffered. The output-flush-interval governs how much buffered data exists.
#
# The default value is: 0 (never instruct detection threads to flush output)
# The default value is: 0 (no periodic flushing)
#output-flush-interval: 0
# Logging configuration. This is not about logging IDS alerts/events, but

Loading…
Cancel
Save