Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add queue settings to docs #4884

Merged
merged 6 commits into from
Oct 9, 2017
Merged

Add queue settings to docs #4884

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
677a952
Add queue settings to docs
Aug 11, 2017
387376a
Move queue setting to TOC + address some review
Aug 13, 2017
92c457f
Remove flush_interval and spooler from outputconfig
Aug 15, 2017
756ca3f
remove 'slot'
Aug 15, 2017
6128f32
more review changes
Aug 16, 2017
9662217
Update queueconfig.asciidoc
ruflin Oct 4, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions libbeat/docs/queueconfig.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ queue.mem:

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. An output
will consume up to the outputs `bulk_max_size` events at once.
published to this queue will be directly consumed by the outputs.
The output's `bulk_max_size` setting limits the number of events being processed at once.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this works!


Only after an event is dropped or acknowledged by the output, a new slot will
be available in the queue.
The memory queue is waiting for the output to acknowledge or drop an events. If
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence has a typo "an events". The verb tense also seems a little off. Should probably say:

The memory queue waits for the output to acknowledge or drop events.

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.
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:
Expand Down