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

PQ Docs: add note about upgrading #9762

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

PQ Docs: add note about upgrading #9762

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions docs/static/persistent-queues.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,15 @@ messages stored in the persistent queue until delivery succeeds at least once.
NOTE: You must set `queue.checkpoint.writes: 1` explicitly to guarantee
maximum durability for all input events. See <<durability-persistent-queues>>.

+
NOTE: The Persistent Queue is under active development and continues to improve
with each release of Logstash; using the latest available version of Logstash
will ensure you're using the best available version of this and other features.
To enable the smoothest transition when upgrading, especially from versions
prior to 6.3.0, you're encouraged to
Copy link
Contributor

@dedemorton dedemorton Jun 21, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

I think it's going to be very weird to mention 6.3.0 in releases that occurred prior to 6.3.0. I would remove the mention of 6.3.0 from the note all together and make sure the note shows up in all relevant versions (where the queue.drain option exists) up to, but not including, the version where draining the queue is no longer required.

<<upgrading-logstash-pqs#_drain_the_persistent_queue,drain the queue>> prior to
performing an upgrade.

[[persistent-queues-limitations]]
==== Limitations of Persistent Queues

Expand Down