Introduce spooling to disk

.travis.yml

@@ -68,7 +68,7 @@ jobs:
  go: $GO_VERSION
  stage: test
  - os: linux
- env: TARGETS="-C libbeat stress-tests"
+ env: STRESS_TEST_OPTIONS="-timeout=20m -race -v -parallel 1" TARGETS="-C libbeat stress-tests"
  go: $GO_VERSION
  stage: test
 

CHANGELOG.asciidoc

@@ -207,6 +207,7 @@ https:/elastic/beats/compare/v6.0.0-beta2...master[Check the HEAD di
 - Add appender support to autodiscover {pull}6469[6469]
 - Add add_host_metadata processor {pull}5968[5968]
 - Retry configuration to load dashboards if Kibana is not reachable when the beat starts. {pull}6560[6560]
+- Add support for spooling to disk to the beats event publishing pipeline. {pull}6581[6581]
 
 *Auditbeat*
 

NOTICE.txt

@@ -372,6 +372,16 @@ License type (autodetected): Apache-2.0
 Apache License 2.0
 
 
+--------------------------------------------------------------------
+Dependency: github.com/elastic/go-txfile
+Version: v0.0.1
+Revision: 7e7e33cc236f30fff545f3ee2c35ada5b70b6b13
+License type (autodetected): Apache-2.0
+./vendor/github.com/elastic/go-txfile/LICENSE:
+--------------------------------------------------------------------
+Apache License 2.0
+
+
 --------------------------------------------------------------------
 Dependency: github.com/elastic/go-ucfg
 Version: v0.5.1
@@ -2052,6 +2062,41 @@ DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
 OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE 
 OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+--------------------------------------------------------------------
+Dependency: github.com/theckman/go-flock
+Version: v0.4.0
+Revision: b139a2487364247d91814e4a7c7b8fdc69e342b2
+License type (autodetected): BSD-3-Clause
+./vendor/github.com/theckman/go-flock/LICENSE:
+--------------------------------------------------------------------
+Copyright (c) 2015, Tim Heckman
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+* Neither the name of linode-netint nor the names of its
+ contributors may be used to endorse or promote products derived from
+ this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
 --------------------------------------------------------------------
 Dependency: github.com/tsg/gopacket
 Revision: f289b3ea3e41a01b2822be9caf5f40c01fdda05c
@@ -2087,6 +2132,24 @@ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
+--------------------------------------------------------------------
+Dependency: github.com/urso/go-bin
+Revision: 781c575c9f0eb3cb9dca94521bd7ad7d5aec7fd4
+License type (autodetected): Apache-2.0
+./vendor/github.com/urso/go-bin/LICENSE:
+--------------------------------------------------------------------
+Apache License 2.0
+
+
+--------------------------------------------------------------------
+Dependency: github.com/urso/qcgen
+Revision: 0b059e7db4f40a062ca3d975b7500c6a0a968d87
+License type (autodetected): Apache-2.0
+./vendor/github.com/urso/qcgen/LICENSE:
+--------------------------------------------------------------------
+Apache License 2.0
+
+
 --------------------------------------------------------------------
 Dependency: github.com/vmware/govmomi
 Revision: 2cad15190b417804d82edb4981e7b3e62907c4ee

auditbeat/auditbeat.reference.yml

@@ -148,6 +148,66 @@ auditbeat.modules:
  # if the number of events stored in the queue is < min_flush_events.
  #flush.timeout: 1s
 
+ # 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.
+ #
+ # 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
+ # is full or the flush_timeout is triggered.
+ # Once ACKed by the output, events are removed immediately from the queue,
+ # making space for new events to be persisted.
+ #spool:
+ # The file namespace configures the file path and the file creation settings.
+ # Once the file exists, the `size`, `page_size` and `prealloc` settings
+ # will have no more effect.
+ #file:
+ # Location of spool file. The default value is ${path.data}/spool.dat.
+ #path: "${path.data}/spool.dat"
+
+ # Configure file permissions if file is created. The default value is 0600.
+ #permissions: 0600
+
+ # File size hint. The spool blocks, once this limit is reached. The default value is 100 MiB.
+ #size: 100MiB
+
+ # The files page size. A file is split into multiple pages of the same size. The default value is 4KiB.
+ #page_size: 4KiB
+
+ # If prealloc is set, the required space for the file is reserved using
+ # truncate. The default value is true.
+ #prealloc: true
+
+ # Spool writer settings
+ # Events are serialized into a write buffer. The write buffer is flushed if:
+ # - The buffer limit has been reached.
+ # - The configured limit of buffered events is reached.
+ # - The flush timeout is triggered.
+ #write:
+ # Sets the write buffer size.
+ #buffer_size: 1MiB
+
+ # Maximum duration after which events are flushed, if the write buffer
+ # is not full yet. The default value is 1s.
+ #flush.timeout: 1s
+
+ # Number of maximum buffered events. The write buffer is flushed once the
+ # limit is reached.
+ #flush.events: 16384
+
+ # Configure the on-disk event encoding. The encoding can be changed
+ # between restarts.
+ # Valid encodings are: json, ubjson, and cbor.
+ #codec: cbor
+ #read:
+ # Reader flush timeout, waiting for more events to become available, so
+ # to fill a complete batch, as required by the outputs.
+ # If flush_timeout is 0, all available events are forwarded to the
+ # outputs immediately.
+ # The default value is 0s.
+ #flush.timeout: 0s
+
 # Sets the maximum number of CPUs that can be executing simultaneously. The
 # default is the number of logical CPUs available in the system.
 #max_procs:

filebeat/filebeat.reference.yml

@@ -629,6 +629,66 @@ filebeat.inputs:
  # if the number of events stored in the queue is < min_flush_events.
  #flush.timeout: 1s
 
+ # 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.
+ #
+ # 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
+ # is full or the flush_timeout is triggered.
+ # Once ACKed by the output, events are removed immediately from the queue,
+ # making space for new events to be persisted.
+ #spool:
+ # The file namespace configures the file path and the file creation settings.
+ # Once the file exists, the `size`, `page_size` and `prealloc` settings
+ # will have no more effect.
+ #file:
+ # Location of spool file. The default value is ${path.data}/spool.dat.
+ #path: "${path.data}/spool.dat"
+
+ # Configure file permissions if file is created. The default value is 0600.
+ #permissions: 0600
+
+ # File size hint. The spool blocks, once this limit is reached. The default value is 100 MiB.
+ #size: 100MiB
+
+ # The files page size. A file is split into multiple pages of the same size. The default value is 4KiB.
+ #page_size: 4KiB
+
+ # If prealloc is set, the required space for the file is reserved using
+ # truncate. The default value is true.
+ #prealloc: true
+
+ # Spool writer settings
+ # Events are serialized into a write buffer. The write buffer is flushed if:
+ # - The buffer limit has been reached.
+ # - The configured limit of buffered events is reached.
+ # - The flush timeout is triggered.
+ #write:
+ # Sets the write buffer size.
+ #buffer_size: 1MiB
+
+ # Maximum duration after which events are flushed, if the write buffer
+ # is not full yet. The default value is 1s.
+ #flush.timeout: 1s
+
+ # Number of maximum buffered events. The write buffer is flushed once the
+ # limit is reached.
+ #flush.events: 16384
+
+ # Configure the on-disk event encoding. The encoding can be changed
+ # between restarts.
+ # Valid encodings are: json, ubjson, and cbor.
+ #codec: cbor
+ #read:
+ # Reader flush timeout, waiting for more events to become available, so
+ # to fill a complete batch, as required by the outputs.
+ # If flush_timeout is 0, all available events are forwarded to the
+ # outputs immediately.
+ # The default value is 0s.
+ #flush.timeout: 0s
+
 # Sets the maximum number of CPUs that can be executing simultaneously. The
 # default is the number of logical CPUs available in the system.
 #max_procs:

heartbeat/heartbeat.reference.yml

@@ -257,6 +257,66 @@ heartbeat.scheduler:
  # if the number of events stored in the queue is < min_flush_events.
  #flush.timeout: 1s
 
+ # 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.
+ #
+ # 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
+ # is full or the flush_timeout is triggered.
+ # Once ACKed by the output, events are removed immediately from the queue,
+ # making space for new events to be persisted.
+ #spool:
+ # The file namespace configures the file path and the file creation settings.
+ # Once the file exists, the `size`, `page_size` and `prealloc` settings
+ # will have no more effect.
+ #file:
+ # Location of spool file. The default value is ${path.data}/spool.dat.
+ #path: "${path.data}/spool.dat"
+
+ # Configure file permissions if file is created. The default value is 0600.
+ #permissions: 0600
+
+ # File size hint. The spool blocks, once this limit is reached. The default value is 100 MiB.
+ #size: 100MiB
+
+ # The files page size. A file is split into multiple pages of the same size. The default value is 4KiB.
+ #page_size: 4KiB
+
+ # If prealloc is set, the required space for the file is reserved using
+ # truncate. The default value is true.
+ #prealloc: true
+
+ # Spool writer settings
+ # Events are serialized into a write buffer. The write buffer is flushed if:
+ # - The buffer limit has been reached.
+ # - The configured limit of buffered events is reached.
+ # - The flush timeout is triggered.
+ #write:
+ # Sets the write buffer size.
+ #buffer_size: 1MiB
+
+ # Maximum duration after which events are flushed, if the write buffer
+ # is not full yet. The default value is 1s.
+ #flush.timeout: 1s
+
+ # Number of maximum buffered events. The write buffer is flushed once the
+ # limit is reached.
+ #flush.events: 16384
+
+ # Configure the on-disk event encoding. The encoding can be changed
+ # between restarts.
+ # Valid encodings are: json, ubjson, and cbor.
+ #codec: cbor
+ #read:
+ # Reader flush timeout, waiting for more events to become available, so
+ # to fill a complete batch, as required by the outputs.
+ # If flush_timeout is 0, all available events are forwarded to the
+ # outputs immediately.
+ # The default value is 0s.
+ #flush.timeout: 0s
+
 # Sets the maximum number of CPUs that can be executing simultaneously. The
 # default is the number of logical CPUs available in the system.
 #max_procs:

libbeat/_meta/config.reference.yml

@@ -43,6 +43,66 @@
  # if the number of events stored in the queue is < min_flush_events.
  #flush.timeout: 1s
 
+ # 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.
+ #
+ # 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
+ # is full or the flush_timeout is triggered.
+ # Once ACKed by the output, events are removed immediately from the queue,
+ # making space for new events to be persisted.
+ #spool:
+ # The file namespace configures the file path and the file creation settings.
+ # Once the file exists, the `size`, `page_size` and `prealloc` settings
+ # will have no more effect.
+ #file:
+ # Location of spool file. The default value is ${path.data}/spool.dat.
+ #path: "${path.data}/spool.dat"
+
+ # Configure file permissions if file is created. The default value is 0600.
+ #permissions: 0600
+
+ # File size hint. The spool blocks, once this limit is reached. The default value is 100 MiB.
+ #size: 100MiB
+
+ # The files page size. A file is split into multiple pages of the same size. The default value is 4KiB.
+ #page_size: 4KiB
+
+ # If prealloc is set, the required space for the file is reserved using
+ # truncate. The default value is true.
+ #prealloc: true
+
+ # Spool writer settings
+ # Events are serialized into a write buffer. The write buffer is flushed if:
+ # - The buffer limit has been reached.
+ # - The configured limit of buffered events is reached.
+ # - The flush timeout is triggered.
+ #write:
+ # Sets the write buffer size.
+ #buffer_size: 1MiB
+
+ # Maximum duration after which events are flushed, if the write buffer
+ # is not full yet. The default value is 1s.
+ #flush.timeout: 1s
+
+ # Number of maximum buffered events. The write buffer is flushed once the
+ # limit is reached.
+ #flush.events: 16384
+
+ # Configure the on-disk event encoding. The encoding can be changed
+ # between restarts.
+ # Valid encodings are: json, ubjson, and cbor.
+ #codec: cbor
+ #read:
+ # Reader flush timeout, waiting for more events to become available, so
+ # to fill a complete batch, as required by the outputs.
+ # If flush_timeout is 0, all available events are forwarded to the
+ # outputs immediately.
+ # The default value is 0s.
+ #flush.timeout: 0s
+
 # Sets the maximum number of CPUs that can be executing simultaneously. The
 # default is the number of logical CPUs available in the system.
 #max_procs:

libbeat/publisher/includes/includes.go

@@ -1,6 +1,10 @@
 package includes
 
 import (
+ // import queue types
+ _ "github.com/elastic/beats/libbeat/publisher/queue/memqueue"
+ _ "github.com/elastic/beats/libbeat/publisher/queue/spool"
+
  // load supported output plugins
  _ "github.com/elastic/beats/libbeat/outputs/console"
  _ "github.com/elastic/beats/libbeat/outputs/elasticsearch"