Skip to content

Commit a975e4c

Browse files
leogrpoiana
authored andcommitted
docs(falco.yaml): correct buffered_outputs description
Signed-off-by: Leonardo Grasso <[email protected]>
1 parent fa862b5 commit a975e4c

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

falco.yaml

+8-3
Original file line numberDiff line numberDiff line change
@@ -549,9 +549,14 @@ json_include_tags_property: true
549549

550550
# [Stable] `buffered_outputs`
551551
#
552-
# Enabling buffering for the output queue can offer performance optimization,
553-
# efficient resource usage, and smoother data flow, resulting in a more reliable
554-
# output mechanism. By default, buffering is disabled (false).
552+
# Global buffering option for output channels. When disabled, the output channel
553+
# that supports buffering flushes the output buffer on every alert. This can lead to
554+
# increased CPU usage but is useful when piping outputs to another process or script.
555+
# Buffering is currently supported by `file_output`, `program_output`, and `std_output`.
556+
# Some output channels may implement buffering strategies you cannot control.
557+
# Additionally, this setting is separate from the `output_queue` option. The output queue
558+
# sits between the rule engine and the output channels, while output buffering occurs
559+
# afterward once the specific channel implementation outputs the formatted message.
555560
buffered_outputs: false
556561

557562
# [Incubating] `rule_matching`

0 commit comments

Comments
 (0)