From 26eb1ad72f37a0278399b991ef4868bfbb2bbde1 Mon Sep 17 00:00:00 2001 From: Fae Charlton Date: Fri, 20 Aug 2021 11:25:57 -0400 Subject: [PATCH] [libbeat] Mark disk queue as GA (#27515) (cherry picked from commit 4039baaf05103cb2af41952531a2f740ad16985d) --- CHANGELOG.next.asciidoc | 1 + auditbeat/auditbeat.reference.yml | 4 ++-- filebeat/filebeat.reference.yml | 4 ++-- heartbeat/heartbeat.reference.yml | 4 ++-- journalbeat/journalbeat.reference.yml | 4 ++-- libbeat/_meta/config/general.reference.yml.tmpl | 4 ++-- libbeat/docs/queueconfig.asciidoc | 10 +--------- libbeat/publisher/queue/diskqueue/queue.go | 2 +- metricbeat/metricbeat.reference.yml | 4 ++-- packetbeat/packetbeat.reference.yml | 4 ++-- winlogbeat/winlogbeat.reference.yml | 4 ++-- x-pack/auditbeat/auditbeat.reference.yml | 4 ++-- x-pack/filebeat/filebeat.reference.yml | 4 ++-- x-pack/functionbeat/functionbeat.reference.yml | 4 ++-- x-pack/heartbeat/heartbeat.reference.yml | 4 ++-- x-pack/metricbeat/metricbeat.reference.yml | 4 ++-- x-pack/osquerybeat/osquerybeat.reference.yml | 4 ++-- x-pack/packetbeat/packetbeat.reference.yml | 4 ++-- x-pack/winlogbeat/winlogbeat.reference.yml | 4 ++-- 19 files changed, 35 insertions(+), 42 deletions(-) diff --git a/CHANGELOG.next.asciidoc b/CHANGELOG.next.asciidoc index 092d009bf29..6794df1f8e6 100644 --- a/CHANGELOG.next.asciidoc +++ b/CHANGELOG.next.asciidoc @@ -307,6 +307,7 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...master[Check the HEAD d - Add new 'offline' docker image for Elastic Agent. {pull}27052[27052] - Add cgroups V2 support {pull}27242[27242] - update ECS field definitions to ECS 1.11.0. {pull}27107[27107] +- The disk queue is now GA. {pull}27515[27515] *Auditbeat* diff --git a/auditbeat/auditbeat.reference.yml b/auditbeat/auditbeat.reference.yml index 5a0881d114b..0dd4afc73ea 100644 --- a/auditbeat/auditbeat.reference.yml +++ b/auditbeat/auditbeat.reference.yml @@ -200,8 +200,8 @@ auditbeat.modules: # The spool queue will store events in a local spool file, before # forwarding the events to the outputs. - # - # Beta: spooling to disk is currently a beta feature. Use with care. + # Note: the spool queue is deprecated and will be removed in the future. + # Use the disk queue instead. # # The spool file is a circular buffer, which blocks once the file/buffer is full. # Events are put into a write buffer and flushed once the write buffer diff --git a/filebeat/filebeat.reference.yml b/filebeat/filebeat.reference.yml index 1fb9525e367..b9b08ff9fb4 100644 --- a/filebeat/filebeat.reference.yml +++ b/filebeat/filebeat.reference.yml @@ -1111,8 +1111,8 @@ filebeat.inputs: # The spool queue will store events in a local spool file, before # forwarding the events to the outputs. - # - # Beta: spooling to disk is currently a beta feature. Use with care. + # Note: the spool queue is deprecated and will be removed in the future. + # Use the disk queue instead. # # The spool file is a circular buffer, which blocks once the file/buffer is full. # Events are put into a write buffer and flushed once the write buffer diff --git a/heartbeat/heartbeat.reference.yml b/heartbeat/heartbeat.reference.yml index e30a689e6f3..3b8ee0686c6 100644 --- a/heartbeat/heartbeat.reference.yml +++ b/heartbeat/heartbeat.reference.yml @@ -377,8 +377,8 @@ heartbeat.scheduler: # The spool queue will store events in a local spool file, before # forwarding the events to the outputs. - # - # Beta: spooling to disk is currently a beta feature. Use with care. + # Note: the spool queue is deprecated and will be removed in the future. + # Use the disk queue instead. # # The spool file is a circular buffer, which blocks once the file/buffer is full. # Events are put into a write buffer and flushed once the write buffer diff --git a/journalbeat/journalbeat.reference.yml b/journalbeat/journalbeat.reference.yml index 1091b1bacb2..a4837ac94e1 100644 --- a/journalbeat/journalbeat.reference.yml +++ b/journalbeat/journalbeat.reference.yml @@ -142,8 +142,8 @@ setup.template.settings: # The spool queue will store events in a local spool file, before # forwarding the events to the outputs. - # - # Beta: spooling to disk is currently a beta feature. Use with care. + # Note: the spool queue is deprecated and will be removed in the future. + # Use the disk queue instead. # # The spool file is a circular buffer, which blocks once the file/buffer is full. # Events are put into a write buffer and flushed once the write buffer diff --git a/libbeat/_meta/config/general.reference.yml.tmpl b/libbeat/_meta/config/general.reference.yml.tmpl index cc266128c02..58a39af4b34 100644 --- a/libbeat/_meta/config/general.reference.yml.tmpl +++ b/libbeat/_meta/config/general.reference.yml.tmpl @@ -79,8 +79,8 @@ # The spool queue will store events in a local spool file, before # forwarding the events to the outputs. - # - # Beta: spooling to disk is currently a beta feature. Use with care. + # Note: the spool queue is deprecated and will be removed in the future. + # Use the disk queue instead. # # The spool file is a circular buffer, which blocks once the file/buffer is full. # Events are put into a write buffer and flushed once the write buffer diff --git a/libbeat/docs/queueconfig.asciidoc b/libbeat/docs/queueconfig.asciidoc index 53ba5aa2ebe..054379e1b20 100644 --- a/libbeat/docs/queueconfig.asciidoc +++ b/libbeat/docs/queueconfig.asciidoc @@ -84,8 +84,6 @@ The default value is 1s. [[configuration-internal-queue-disk]] === Configure the disk queue -beta[] - The disk queue stores pending events on the disk rather than main memory. This allows Beats to queue a larger number of events than is possible with the memory queue, and to save events when a Beat or device is restarted. @@ -95,8 +93,6 @@ for setups where the disk is not the main bottleneck, the disk queue gives a simple and relatively low-overhead way to add a layer of robustness to incoming event data. -The disk queue is expected to replace the file spool in a future release. - To enable the disk queue with default settings, specify a maximum size: @@ -208,11 +204,7 @@ The default value is `30s` (thirty seconds). beta[] -NOTE: The disk queue offers similar functionality to the file spool with a -streamlined configuration and lower overhead. It is expected to replace the -file spool in a future release. While the file spool is still included for -backward compatibility, new configurations should use the disk queue -when possible. +NOTE: The file spool queue is a deprecated feature offered as-is for backwards compatibility. The supported way to queue events in persistent storage is the disk queue. The file spool queue stores all events in an on disk ring buffer. The spool has a write buffer, which new events are written to. Events written to the diff --git a/libbeat/publisher/queue/diskqueue/queue.go b/libbeat/publisher/queue/diskqueue/queue.go index bba713d7269..f70fb27acab 100644 --- a/libbeat/publisher/queue/diskqueue/queue.go +++ b/libbeat/publisher/queue/diskqueue/queue.go @@ -93,7 +93,7 @@ func init() { feature.MakeDetails( "Disk queue", "Buffer events on disk before sending to the output.", - feature.Beta)) + feature.Stable)) } // queueFactory matches the queue.Factory interface, and is used to add the diff --git a/metricbeat/metricbeat.reference.yml b/metricbeat/metricbeat.reference.yml index ae0d0dd737e..233cc440ee6 100644 --- a/metricbeat/metricbeat.reference.yml +++ b/metricbeat/metricbeat.reference.yml @@ -1011,8 +1011,8 @@ metricbeat.modules: # The spool queue will store events in a local spool file, before # forwarding the events to the outputs. - # - # Beta: spooling to disk is currently a beta feature. Use with care. + # Note: the spool queue is deprecated and will be removed in the future. + # Use the disk queue instead. # # The spool file is a circular buffer, which blocks once the file/buffer is full. # Events are put into a write buffer and flushed once the write buffer diff --git a/packetbeat/packetbeat.reference.yml b/packetbeat/packetbeat.reference.yml index b6d26d5ab17..4eb81ce4035 100644 --- a/packetbeat/packetbeat.reference.yml +++ b/packetbeat/packetbeat.reference.yml @@ -694,8 +694,8 @@ packetbeat.ignore_outgoing: false # The spool queue will store events in a local spool file, before # forwarding the events to the outputs. - # - # Beta: spooling to disk is currently a beta feature. Use with care. + # Note: the spool queue is deprecated and will be removed in the future. + # Use the disk queue instead. # # The spool file is a circular buffer, which blocks once the file/buffer is full. # Events are put into a write buffer and flushed once the write buffer diff --git a/winlogbeat/winlogbeat.reference.yml b/winlogbeat/winlogbeat.reference.yml index 28816a4112d..6ba1e10566d 100644 --- a/winlogbeat/winlogbeat.reference.yml +++ b/winlogbeat/winlogbeat.reference.yml @@ -122,8 +122,8 @@ winlogbeat.event_logs: # The spool queue will store events in a local spool file, before # forwarding the events to the outputs. - # - # Beta: spooling to disk is currently a beta feature. Use with care. + # Note: the spool queue is deprecated and will be removed in the future. + # Use the disk queue instead. # # The spool file is a circular buffer, which blocks once the file/buffer is full. # Events are put into a write buffer and flushed once the write buffer diff --git a/x-pack/auditbeat/auditbeat.reference.yml b/x-pack/auditbeat/auditbeat.reference.yml index ce1a396ec8c..af7cf60ed38 100644 --- a/x-pack/auditbeat/auditbeat.reference.yml +++ b/x-pack/auditbeat/auditbeat.reference.yml @@ -256,8 +256,8 @@ auditbeat.modules: # The spool queue will store events in a local spool file, before # forwarding the events to the outputs. - # - # Beta: spooling to disk is currently a beta feature. Use with care. + # Note: the spool queue is deprecated and will be removed in the future. + # Use the disk queue instead. # # The spool file is a circular buffer, which blocks once the file/buffer is full. # Events are put into a write buffer and flushed once the write buffer diff --git a/x-pack/filebeat/filebeat.reference.yml b/x-pack/filebeat/filebeat.reference.yml index ae388f679a1..ed072a74396 100644 --- a/x-pack/filebeat/filebeat.reference.yml +++ b/x-pack/filebeat/filebeat.reference.yml @@ -3390,8 +3390,8 @@ filebeat.inputs: # The spool queue will store events in a local spool file, before # forwarding the events to the outputs. - # - # Beta: spooling to disk is currently a beta feature. Use with care. + # Note: the spool queue is deprecated and will be removed in the future. + # Use the disk queue instead. # # The spool file is a circular buffer, which blocks once the file/buffer is full. # Events are put into a write buffer and flushed once the write buffer diff --git a/x-pack/functionbeat/functionbeat.reference.yml b/x-pack/functionbeat/functionbeat.reference.yml index 14e50ec2611..6e926f25723 100644 --- a/x-pack/functionbeat/functionbeat.reference.yml +++ b/x-pack/functionbeat/functionbeat.reference.yml @@ -485,8 +485,8 @@ functionbeat.provider.gcp.functions: # The spool queue will store events in a local spool file, before # forwarding the events to the outputs. - # - # Beta: spooling to disk is currently a beta feature. Use with care. + # Note: the spool queue is deprecated and will be removed in the future. + # Use the disk queue instead. # # The spool file is a circular buffer, which blocks once the file/buffer is full. # Events are put into a write buffer and flushed once the write buffer diff --git a/x-pack/heartbeat/heartbeat.reference.yml b/x-pack/heartbeat/heartbeat.reference.yml index e30a689e6f3..3b8ee0686c6 100644 --- a/x-pack/heartbeat/heartbeat.reference.yml +++ b/x-pack/heartbeat/heartbeat.reference.yml @@ -377,8 +377,8 @@ heartbeat.scheduler: # The spool queue will store events in a local spool file, before # forwarding the events to the outputs. - # - # Beta: spooling to disk is currently a beta feature. Use with care. + # Note: the spool queue is deprecated and will be removed in the future. + # Use the disk queue instead. # # The spool file is a circular buffer, which blocks once the file/buffer is full. # Events are put into a write buffer and flushed once the write buffer diff --git a/x-pack/metricbeat/metricbeat.reference.yml b/x-pack/metricbeat/metricbeat.reference.yml index 2b5919bf6c1..731dfded59a 100644 --- a/x-pack/metricbeat/metricbeat.reference.yml +++ b/x-pack/metricbeat/metricbeat.reference.yml @@ -1533,8 +1533,8 @@ metricbeat.modules: # The spool queue will store events in a local spool file, before # forwarding the events to the outputs. - # - # Beta: spooling to disk is currently a beta feature. Use with care. + # Note: the spool queue is deprecated and will be removed in the future. + # Use the disk queue instead. # # The spool file is a circular buffer, which blocks once the file/buffer is full. # Events are put into a write buffer and flushed once the write buffer diff --git a/x-pack/osquerybeat/osquerybeat.reference.yml b/x-pack/osquerybeat/osquerybeat.reference.yml index 98bfe44c9fd..605d0d52363 100644 --- a/x-pack/osquerybeat/osquerybeat.reference.yml +++ b/x-pack/osquerybeat/osquerybeat.reference.yml @@ -98,8 +98,8 @@ seccomp.enabled: false # The spool queue will store events in a local spool file, before # forwarding the events to the outputs. - # - # Beta: spooling to disk is currently a beta feature. Use with care. + # Note: the spool queue is deprecated and will be removed in the future. + # Use the disk queue instead. # # The spool file is a circular buffer, which blocks once the file/buffer is full. # Events are put into a write buffer and flushed once the write buffer diff --git a/x-pack/packetbeat/packetbeat.reference.yml b/x-pack/packetbeat/packetbeat.reference.yml index b6d26d5ab17..4eb81ce4035 100644 --- a/x-pack/packetbeat/packetbeat.reference.yml +++ b/x-pack/packetbeat/packetbeat.reference.yml @@ -694,8 +694,8 @@ packetbeat.ignore_outgoing: false # The spool queue will store events in a local spool file, before # forwarding the events to the outputs. - # - # Beta: spooling to disk is currently a beta feature. Use with care. + # Note: the spool queue is deprecated and will be removed in the future. + # Use the disk queue instead. # # The spool file is a circular buffer, which blocks once the file/buffer is full. # Events are put into a write buffer and flushed once the write buffer diff --git a/x-pack/winlogbeat/winlogbeat.reference.yml b/x-pack/winlogbeat/winlogbeat.reference.yml index e6f38185bdb..77c977b15ce 100644 --- a/x-pack/winlogbeat/winlogbeat.reference.yml +++ b/x-pack/winlogbeat/winlogbeat.reference.yml @@ -165,8 +165,8 @@ winlogbeat.event_logs: # The spool queue will store events in a local spool file, before # forwarding the events to the outputs. - # - # Beta: spooling to disk is currently a beta feature. Use with care. + # Note: the spool queue is deprecated and will be removed in the future. + # Use the disk queue instead. # # The spool file is a circular buffer, which blocks once the file/buffer is full. # Events are put into a write buffer and flushed once the write buffer