diff --git a/auditbeat/auditbeat.reference.yml b/auditbeat/auditbeat.reference.yml index b396ceb3e08..86cf4fa2a13 100644 --- a/auditbeat/auditbeat.reference.yml +++ b/auditbeat/auditbeat.reference.yml @@ -139,7 +139,8 @@ auditbeat.modules: # Hints the minimum number of events stored in the queue, # before providing a batch of events to the outputs. - # A value of 0 (the default) ensures events are immediately available + # The default value is set to 2048. + # A value of 0 ensures events are immediately available # to be sent to the outputs. #flush.min_events: 2048 diff --git a/filebeat/filebeat.reference.yml b/filebeat/filebeat.reference.yml index 40fa723bf3d..a7d7d5dc6e2 100644 --- a/filebeat/filebeat.reference.yml +++ b/filebeat/filebeat.reference.yml @@ -613,7 +613,8 @@ filebeat.inputs: # Hints the minimum number of events stored in the queue, # before providing a batch of events to the outputs. - # A value of 0 (the default) ensures events are immediately available + # The default value is set to 2048. + # A value of 0 ensures events are immediately available # to be sent to the outputs. #flush.min_events: 2048 diff --git a/heartbeat/heartbeat.reference.yml b/heartbeat/heartbeat.reference.yml index 6480b240b82..d368a604544 100644 --- a/heartbeat/heartbeat.reference.yml +++ b/heartbeat/heartbeat.reference.yml @@ -248,7 +248,8 @@ heartbeat.scheduler: # Hints the minimum number of events stored in the queue, # before providing a batch of events to the outputs. - # A value of 0 (the default) ensures events are immediately available + # The default value is set to 2048. + # A value of 0 ensures events are immediately available # to be sent to the outputs. #flush.min_events: 2048 diff --git a/libbeat/_meta/config.reference.yml b/libbeat/_meta/config.reference.yml index 1d70f8f6413..931a430f180 100644 --- a/libbeat/_meta/config.reference.yml +++ b/libbeat/_meta/config.reference.yml @@ -34,7 +34,8 @@ # Hints the minimum number of events stored in the queue, # before providing a batch of events to the outputs. - # A value of 0 (the default) ensures events are immediately available + # The default value is set to 2048. + # A value of 0 ensures events are immediately available # to be sent to the outputs. #flush.min_events: 2048 diff --git a/libbeat/docs/queueconfig.asciidoc b/libbeat/docs/queueconfig.asciidoc index 3c4f77f4c74..de48a021406 100644 --- a/libbeat/docs/queueconfig.asciidoc +++ b/libbeat/docs/queueconfig.asciidoc @@ -22,16 +22,20 @@ queue.mem: === Configure the memory qeueue The memory queue keeps all events in memory. It is the only queue type -supported right now. By default no flush interval is configured. All events -published to this queue will be directly consumed by the outputs. +supported right now. + +If no flush interval and no number of events to flush is configured, +all events published to this queue will be directly consumed by the outputs. +To enforce spooling in the queue, set the `flush.min_events` and `flush.timeout` options. + +By default `flush.min.events` is set to 2048 and `flush.timeout` is set to 1s. + The output's `bulk_max_size` setting limits the number of events being processed at once. The memory queue waits for the output to acknowledge or drop events. If the queue is full, no new events can be inserted into the memeory queue. Only after the signal from the output will the queue free up space for more events to be accepted. -To enforce spooling in the queue, set the `flush.min_events` and `flush.timeout` options. - This sample configuration forwards events to the output if 512 events are available or the oldest available event is already waiting for 5s in the queue: diff --git a/metricbeat/metricbeat.reference.yml b/metricbeat/metricbeat.reference.yml index 213641e47cd..53a8619eb36 100644 --- a/metricbeat/metricbeat.reference.yml +++ b/metricbeat/metricbeat.reference.yml @@ -527,7 +527,8 @@ metricbeat.modules: # Hints the minimum number of events stored in the queue, # before providing a batch of events to the outputs. - # A value of 0 (the default) ensures events are immediately available + # The default value is set to 2048. + # A value of 0 ensures events are immediately available # to be sent to the outputs. #flush.min_events: 2048 diff --git a/packetbeat/packetbeat.reference.yml b/packetbeat/packetbeat.reference.yml index c0c2a958a39..297941639b4 100644 --- a/packetbeat/packetbeat.reference.yml +++ b/packetbeat/packetbeat.reference.yml @@ -502,7 +502,8 @@ packetbeat.protocols: # Hints the minimum number of events stored in the queue, # before providing a batch of events to the outputs. - # A value of 0 (the default) ensures events are immediately available + # The default value is set to 2048. + # A value of 0 ensures events are immediately available # to be sent to the outputs. #flush.min_events: 2048 diff --git a/winlogbeat/winlogbeat.reference.yml b/winlogbeat/winlogbeat.reference.yml index 11bd380759f..3a8f3baa291 100644 --- a/winlogbeat/winlogbeat.reference.yml +++ b/winlogbeat/winlogbeat.reference.yml @@ -63,7 +63,8 @@ winlogbeat.event_logs: # Hints the minimum number of events stored in the queue, # before providing a batch of events to the outputs. - # A value of 0 (the default) ensures events are immediately available + # The default value is set to 2048. + # A value of 0 ensures events are immediately available # to be sent to the outputs. #flush.min_events: 2048