Skip to content

Commit 31c69d6

Browse files
yaauierobbavey
andauthored
Apply suggestions from code review
Co-authored-by: Rob Bavey <[email protected]>
1 parent e90a425 commit 31c69d6

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

docs/reference/logstash-settings-file.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The `logstash.yml` file includes these settings.
6868
| `queue.checkpoint.acks` | The maximum number of ACKed events before forcing a checkpoint when persistent queues are enabled (`queue.type: persisted`). Specify `queue.checkpoint.acks: 0` to set this value to unlimited. | 1024 |
6969
| `queue.checkpoint.writes` | The maximum number of written events before forcing a checkpoint when persistent queues are enabled (`queue.type: persisted`). Specify `queue.checkpoint.writes: 0` to set this value to unlimited. | 1024 |
7070
| `queue.checkpoint.retry` | When enabled, Logstash will retry four times per attempted checkpoint write for any checkpoint writes that fail. Any subsequent errors are not retried. This is a workaround for failed checkpoint writes that have been seen only on Windows platform, filesystems with non-standard behavior such as SANs and is not recommended except in those specific circumstances. (`queue.type: persisted`) | `true` |
71-
| `queue.compression` | Set a persisted queue compression level, which allows the pipeline to reduce the event size on disk at the cost of CPU usage. Possible values are `speed`, `balanced`, and `size`. | `none` |
71+
| `queue.compression` {applies_to}`stack: ga 9.2` | Set a persisted queue compression level, which allows the pipeline to reduce the event size on disk at the cost of CPU usage. Possible values are `speed`, `balanced`, and `size`. | `none` |
7272
| `queue.drain` | When enabled, Logstash waits until the persistent queue (`queue.type: persisted`) is drained before shutting down. | `false` |
7373
| `dead_letter_queue.enable` | Flag to instruct Logstash to enable the DLQ feature supported by plugins. | `false` |
7474
| `dead_letter_queue.max_bytes` | The maximum size of each dead letter queue. Entries will be dropped if they would increase the size of the dead letter queue beyond this setting. | `1024mb` |

docs/reference/persistent-queues.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,11 +86,13 @@ If you want to define values for a specific pipeline, use [`pipelines.yml`](/ref
8686

8787
`queue.compression` {applies_to}`stack: ga 9.2`
8888
: Sets the event compression level for use with the Persisted Queue. Default is `none`. Possible values are:
89+
* `none`: does not perform compression, but reads compressed events
8990
* `speed`: optimize for fastest compression operation
9091
* `size`: optimize for smallest possible size on disk, spending more CPU
9192
* `balanced`: a balance between the `speed` and `size` settings
9293
:::{important}
93-
Enabling compression will make the PQ incompatible with previous Logstash releases that did not support compression.
94+
Compression can be enabled for an existing PQ, but once compressed elements have been added to a PQ, that PQ cannot be read by previous Logstash releases that did not support compression.
95+
If you need to downgrade Logstash after enabling the PQ, you will need to either delete the PQ or run the pipeline with `queue.drain: true` first to ensure that no compressed elements remain.
9496
:::
9597

9698
## Configuration notes [pq-config-notes]

0 commit comments

Comments
 (0)