Skip to content

Commit

Permalink
[libbeat] Mark disk queue as GA (#27515)
Browse files Browse the repository at this point in the history
  • Loading branch information
faec authored Aug 20, 2021
1 parent df616d7 commit 4039baa
Show file tree
Hide file tree
Showing 19 changed files with 35 additions and 42 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.next.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -512,6 +512,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*

Expand Down
4 changes: 2 additions & 2 deletions auditbeat/auditbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -199,8 +199,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
Expand Down
4 changes: 2 additions & 2 deletions filebeat/filebeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions heartbeat/heartbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -330,8 +330,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
Expand Down
4 changes: 2 additions & 2 deletions journalbeat/journalbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions libbeat/_meta/config/general.reference.yml.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 1 addition & 9 deletions libbeat/docs/queueconfig.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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:

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion libbeat/publisher/queue/diskqueue/queue.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions metricbeat/metricbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1012,8 +1012,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
Expand Down
4 changes: 2 additions & 2 deletions packetbeat/packetbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions winlogbeat/winlogbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions x-pack/auditbeat/auditbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -255,8 +255,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
Expand Down
4 changes: 2 additions & 2 deletions x-pack/filebeat/filebeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions x-pack/functionbeat/functionbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions x-pack/heartbeat/heartbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -330,8 +330,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
Expand Down
4 changes: 2 additions & 2 deletions x-pack/metricbeat/metricbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions x-pack/osquerybeat/osquerybeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions x-pack/packetbeat/packetbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions x-pack/winlogbeat/winlogbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 4039baa

Please sign in to comment.