github-mirrors/logstash
1
0
Fork 0
mirror of https://github.com/elastic/logstash.git synced 2025-04-24 22:57:16 -04:00
Code Issues Projects Releases Packages Wiki Activity

Add queue.drain option to the docs

Browse source 
Fixes #7583
This commit is contained in:
DeDe Morton 2017-06-30 15:54:23 -07:00 • committed by Suyog Rao
parent 9ee3a305b1
commit 3cc0a7e34d
2 changed files with 5 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/static/persistent-queues.asciidoc vendored
View file

@ -84,6 +84,7 @@ Logstash <<logstash-settings-file,settings file>>:
* `queue.type`: Specify `persisted` to enable persistent queues. By default, persistent queues are disabled (default: `queue.type: memory`).
* `path.queue`: The directory path where the data files will be stored. By default, the files are stored in `path.data/queue`.
* `queue.page_capacity`: The maximum size of a queue page in bytes. The queue data consists of append-only files called "pages". The default size is 250mb. Changing this value is unlikely to have performance benefits.
* `queue.drain`: Specify `true` if you want Logstash to wait until the persistent queue is drained before shutting down. The amount of time it takes to drain the queue depends on the number of events that have accumulated in the queue. Therefore, you should avoid using this setting unless the queue, even when full, is relatively small and can be drained quickly.
// Technically, I know, this isn't "maximum number of events" it's really maximum number of events not yet read by the pipeline worker. We only use this for testing and users generally shouldn't be setting this.
* `queue.max_events`: The maximum number of events that are allowed in the queue. The default is 0 (unlimited). This value is used internally for the Logstash test suite.
* `queue.max_bytes`: The total capacity of the queue in number of bytes. The

4
docs/static/settings-file.asciidoc vendored
View file

@ -178,6 +178,10 @@ The `logstash.yml` file includes the following settings:
| The interval in milliseconds when a checkpoint is forced on the head page when persistent queues are enabled (`queue.type: persisted`). Specify `queue.checkpoint.interval: 0` for no periodic checkpoint.
| 1000
| `queue.drain`
| When enabled, Logstash waits until the persistent queue is drained before shutting down.
| false
| `dead_letter_queue.enable`
| Flag to instruct Logstash to enable the DLQ feature supported by plugins.
| `false`